'. check_plain($title) ."

'. t('The blog module allows registered users to maintain an online journal, or blog. Blogs are made up of individual blog entries, and the blog entries are most often displayed in descending order by creation time.') .'

'. t('There is an (optional) Blogs menu item added to the Navigation menu, which displays all blogs available on your site, and a My blog item displaying the current user\'s blog entries. The Blog entry menu item under Create content allows new blog entries to be created.') .'

'. t('Each blog entry is displayed with an automatic link to other blogs created by the same user. By default, blog entries have comments enabled and are automatically promoted to the site front page. The blog module also creates a Recent blog posts block that may be enabled at the blocks administration page.', array('@blocks' => url('admin/build/block'))) .'

'. t('When using the aggregator module an automatic blog it icon is displayed next to the items in a feed\'s latest items block. Clicking this icon populates a blog entry with a title (the title of the feed item) and body (a link to the source item on its original site and illustrative content suitable for use in a block quote). Blog authors can use this feature to easily comment on items of interest that appear in aggregator feeds from other sites. To use this feature, be sure to enable the aggregator module, add and configure a feed from another site, and position the feed\'s latest items block.', array('@modules' => url('admin/build/modules'), '@feeds' => url('admin/content/aggregator'), '@blocks' => url('admin/build/block'))) .'

'. t('For more information, see the online handbook entry for Blog module.', array('@blog' => 'http://drupal.org/handbook/modules/blog/')) .'

'. t('Ecto, a blogging client available for both Mac OS X and Microsoft Windows, can be used with Blog API. Blog API also supports Blogger API, MetaWeblog API, and most of the Movable Type API. Blogging clients and other services (e.g. Flickr\'s "post to blog") that support these APIs may also be compatible.', array('@ecto-link' => url('http://infinite-sushi.com/software/ecto/'), '@blogger-api' => url('http://www.blogger.com/developers/api/1_docs/'), '@metaweblog-api' => url('http://www.xmlrpc.com/metaWeblogApi'), '@movabletype-api' => url('http://www.movabletype.org/docs/mtmanual_programmatic.html'), '@flickr' => url('http://www.flickr.com'))) .'

'. t('Select the content types available to external clients on the Blog API settings page. If supported and available, each content type will be displayed as a separate "blog" by the external client.', array('@blogapi-settings' => url('admin/settings/blogapi'))) .'

'. t('For more information, see the online handbook entry for Blog API module.', array('@blogapi' => url('http://drupal.org/handbook/modules/blogapi/'))) .'

+ '; ?> + + + + + + + diff -r 5a113a1c4740 -r c1f4ac30525a modules/book/book-navigation.tpl.php --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/book/book-navigation.tpl.php Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,52 @@ + + + + diff -r 5a113a1c4740 -r c1f4ac30525a modules/book/book-node-export-html.tpl.php --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/book/book-node-export-html.tpl.php Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,25 @@ + +

+ + +

diff -r 5a113a1c4740 -r c1f4ac30525a modules/book/book-rtl.css --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/book/book-rtl.css Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,8 @@ +/* $Id: book-rtl.css,v 1.1 2007/05/27 17:57:48 goba Exp $ */ + +.book-navigation .page-previous { + float: right; +} +.book-navigation .page-up { + float: right; +} diff -r 5a113a1c4740 -r c1f4ac30525a modules/book/book.admin.inc --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/book/book.admin.inc Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,250 @@ + 'checkboxes', + '#title' => t('Allowed book outline types'), + '#default_value' => variable_get('book_allowed_types', array('book')), + '#options' => $types, + '#description' => t('Select content types which users with the %add-perm permission will be allowed to add to the book hierarchy. Users with the %outline-perm permission can add all content types.', array('%add-perm' => t('add content to books'), '%outline-perm' => t('administer book outlines'))), + '#required' => TRUE, + ); + $form['book_child_type'] = array( + '#type' => 'radios', + '#title' => t('Default child page type'), + '#default_value' => variable_get('book_child_type', 'book'), + '#options' => $types, + '#description' => t('The content type for the %add-child link must be one of those selected as an allowed book outline type.', array('%add-child' => t('Add child page'))), + '#required' => TRUE, + ); + $form['array_filter'] = array('#type' => 'value', '#value' => TRUE); + $form['#validate'][] = 'book_admin_settings_validate'; + return system_settings_form($form); +} + +/** + * Validate the book settings form. + * + * @see book_admin_settings() + */ +function book_admin_settings_validate($form, &$form_state) { + $child_type = $form_state['values']['book_child_type']; + if (empty($form_state['values']['book_allowed_types'][$child_type])) { + form_set_error('book_child_type', t('The content type for the %add-child link must be one of those selected as an allowed book outline type.', array('%add-child' => t('Add child page')))); + } +} + +/** + * Build the form to administrate the hierarchy of a single book. + * + * @see book_admin_edit_submit() + * + * @ingroup forms. + */ +function book_admin_edit($form_state, $node) { + drupal_set_title(check_plain($node->title)); + $form = array(); + $form['#node'] = $node; + $form['table'] = _book_admin_table($node); + $form['save'] = array( + '#type' => 'submit', + '#value' => t('Save book pages'), + ); + return $form; +} + +/** + * Handle submission of the book administrative page form. + * + * This function takes care to save parent menu items before their children. + * Saving menu items in the incorrect order can break the menu tree. + * + * @see book_admin_edit() + * @see menu_overview_form_submit() + */ +function book_admin_edit_submit($form, &$form_state) { + // Save elements in the same order as defined in post rather than the form. + // This ensures parents are updated before their children, preventing orphans. + $order = array_flip(array_keys($form['#post']['table'])); + $form['table'] = array_merge($order, $form['table']); + + foreach (element_children($form['table']) as $key) { + if ($form['table'][$key]['#item']) { + $row = $form['table'][$key]; + $values = $form_state['values']['table'][$key]; + + // Update menu item if moved. + if ($row['plid']['#default_value'] != $values['plid'] || $row['weight']['#default_value'] != $values['weight']) { + $row['#item']['plid'] = $values['plid']; + $row['#item']['weight'] = $values['weight']; + menu_link_save($row['#item']); + } + + // Update the title if changed. + if ($row['title']['#default_value'] != $values['title']) { + $node = node_load($values['nid'], FALSE); + $node->title = $values['title']; + $node->book['link_title'] = $values['title']; + $node->revision = 1; + $node->log = t('Title changed from %original to %current.', array('%original' => $node->title, '%current' => $values['title'])); + node_save($node); + watchdog('content', 'book: updated %title.', array('%title' => $node->title), WATCHDOG_NOTICE, l(t('view'), 'node/'. $node->nid)); + } + } + } + + drupal_set_message(t('Updated book %title.', array('%title' => $form['#node']->title))); +} + +/** + * Build the table portion of the form for the book administration page. + * + * @see book_admin_edit() + */ +function _book_admin_table($node) { + $form = array( + '#theme' => 'book_admin_table', + '#tree' => TRUE, + ); + + $tree = book_menu_subtree_data($node->book); + $tree = array_shift($tree); // Do not include the book item itself. + if ($tree['below']) { + _book_admin_table_tree($tree['below'], $form); + } + return $form; +} + +/** + * Recursive helper to build the main table in the book administration page form. + * + * @see book_admin_edit() + */ +function _book_admin_table_tree($tree, &$form) { + foreach ($tree as $key => $data) { + $form[$key] = array( + '#item' => $data['link'], + 'nid' => array('#type' => 'value', '#value' => $data['link']['nid']), + 'depth' => array('#type' => 'value', '#value' => $data['link']['depth']), + 'href' => array('#type' => 'value', '#value' => $data['link']['href']), + 'title' => array( + '#type' => 'textfield', + '#default_value' => $data['link']['link_title'], + '#maxlength' => 255, + '#size' => 40, + ), + 'weight' => array( + '#type' => 'weight', + '#default_value' => $data['link']['weight'], + '#delta' => 15, + ), + 'plid' => array( + '#type' => 'textfield', + '#default_value' => $data['link']['plid'], + '#size' => 6, + ), + 'mlid' => array( + '#type' => 'hidden', + '#default_value' => $data['link']['mlid'], + ), + ); + if ($data['below']) { + _book_admin_table_tree($data['below'], $form); + } + } + + return $form; +} + +/** + * Theme function for the book administration page form. + * + * @ingroup themeable + * @see book_admin_table() + */ +function theme_book_admin_table($form) { + drupal_add_tabledrag('book-outline', 'match', 'parent', 'book-plid', 'book-plid', 'book-mlid', TRUE, MENU_MAX_DEPTH - 2); + drupal_add_tabledrag('book-outline', 'order', 'sibling', 'book-weight'); + + $header = array(t('Title'), t('Weight'), t('Parent'), array('data' => t('Operations'), 'colspan' => '3')); + + $rows = array(); + $destination = drupal_get_destination(); + $access = user_access('administer nodes'); + foreach (element_children($form) as $key) { + $nid = $form[$key]['nid']['#value']; + $href = $form[$key]['href']['#value']; + + // Add special classes to be used with tabledrag.js. + $form[$key]['plid']['#attributes']['class'] = 'book-plid'; + $form[$key]['mlid']['#attributes']['class'] = 'book-mlid'; + $form[$key]['weight']['#attributes']['class'] = 'book-weight'; + + $data = array( + theme('indentation', $form[$key]['depth']['#value'] - 2) . drupal_render($form[$key]['title']), + drupal_render($form[$key]['weight']), + drupal_render($form[$key]['plid']) . drupal_render($form[$key]['mlid']), + l(t('view'), $href), + $access ? l(t('edit'), 'node/'. $nid .'/edit', array('query' => $destination)) : ' ', + $access ? l(t('delete'), 'node/'. $nid .'/delete', array('query' => $destination) ) : ' ', + ); + $row = array('data' => $data); + if (isset($form[$key]['#attributes'])) { + $row = array_merge($row, $form[$key]['#attributes']); + } + $row['class'] = empty($row['class']) ? 'draggable' : $row['class'] .' draggable'; + $rows[] = $row; + } + + return theme('table', $header, $rows, array('id' => 'book-outline')); +} + +/** + * Recursive helper to sort each layer of a book tree by weight. + */ +function _book_admin_sort_tree(&$tree) { + uasort($tree, '_book_admin_compare'); + foreach ($tree as $key => $subtree) { + if (!empty($tree[$key]['below'])) { + _book_admin_sort_tree($tree[$key]['below']); + } + } +} + +/** + * Used by uasort() in _book_admin_sort_tree() to compare items in a book tree. + */ +function _book_admin_compare($a, $b) { + $weight = $a['link']['weight'] - $b['link']['weight']; + if ($weight) { + return $weight; + } + return strncmp($a['link']['title'], $b['link']['title']); +} diff -r 5a113a1c4740 -r c1f4ac30525a modules/book/book.css --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/book/book.css Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,52 @@ +/* $Id: book.css,v 1.6 2007/11/26 16:19:37 dries Exp $ */ + +.book-navigation .menu { + border-top: 1px solid #888; + padding: 1em 0 0 3em; +} +.book-navigation .page-links { + border-top: 1px solid #888; + border-bottom: 1px solid #888; + text-align: center; + padding: 0.5em; +} +.book-navigation .page-previous { + text-align: left; + width: 42%; + display: block; + float: left; /* LTR */ +} +.book-navigation .page-up { + margin: 0 5%; + width: 4%; + display: block; + float: left; /* LTR */ +} +.book-navigation .page-next { + text-align: right; + width: 42%; + display: block; + float: right; +} +#book-outline { + min-width: 56em; +} +.book-outline-form .form-item { + margin-top: 0; + margin-bottom: 0; +} +#edit-book-bid-wrapper .description { + clear: both; +} +#book-admin-edit select { + margin-right: 24px; +} +#book-admin-edit select.progress-disabled { + margin-right: 0; +} +#book-admin-edit tr.ahah-new-content { + background-color: #ffd; +} +#book-admin-edit .form-item { + float: left; +} \ No newline at end of file diff -r 5a113a1c4740 -r c1f4ac30525a modules/book/book.info --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/book/book.info Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,6 @@ +; $Id: book.info,v 1.5 2007/07/30 18:20:21 dries Exp $ +name = Book +description = Allows users to structure site pages in a hierarchy or outline. +package = Core - optional +version = VERSION +core = 6.x diff -r 5a113a1c4740 -r c1f4ac30525a modules/book/book.install --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/book/book.install Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,290 @@ + 'book', + 'name' => t('Book page'), + 'module' => 'node', + 'description' => t('A book page is a page of content, organized into a collection of related entries collectively known as a book. A book page automatically displays links to adjacent pages, providing a simple navigation system for organizing and reviewing structured content.'), + 'custom' => TRUE, + 'modified' => TRUE, + 'locked' => FALSE, + ); + + $book_node_type = (object)_node_type_set_defaults($book_node_type); + node_type_save($book_node_type); + // Default to not promoted. + variable_set('node_options_book', array('status')); + // Use this default type for adding content to books. + variable_set('book_allowed_types', array('book')); + variable_set('book_child_type', 'book'); +} + +/** + * Drupal 5.x to 6.x update. + * + * This function moves any existing book hierarchy into the new structure used + * in the 6.x module. Rather than storing the hierarchy in the {book} table, + * the menu API is used to store the hierarchy in the {menu_links} table and the + * {book} table serves to uniquely connect a node to a menu link. + * + * In order to accomplish this, the current hierarchy is processed using a stack. + * The stack insures that each parent is processed before any of its children + * in the book hierarchy, and is compatible with batched update processing. + * + */ +function book_update_6000() { + $ret = array(); + + // Set up for a multi-part update. + if (!isset($_SESSION['book_update_6000'])) { + + $schema['book'] = array( + 'fields' => array( + 'mlid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0), + 'nid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0), + 'bid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0), + ), + 'primary key' => array('mlid'), + 'unique keys' => array( + 'nid' => array('nid'), + ), + 'indexes' => array( + 'bid' => array('bid'), + ), + ); + // Add the node type. + _book_install_type_create(); + + // Fix role permissions to account for the changed names + // Setup the array holding strings to match and the corresponding + // strings to replace them with. + $replace = array( + 'outline posts in books' => 'administer book outlines', + 'create book pages' => 'create book content', + 'edit book pages' => 'edit any book content', + 'edit own book pages' => 'edit own book content', + 'see printer-friendly version' => 'access printer-friendly version', + ); + + // Loop over all the roles, and do the necessary transformations. + $query = db_query("SELECT rid, perm FROM {permission} ORDER BY rid"); + while ($role = db_fetch_object($query)) { + // Replace all the old permissions with the corresponding new permissions. + $fixed_perm = strtr($role->perm, $replace); + // If the user could previously create book pages, they should get the new + // 'add content to books' permission. + if (strpos($role->perm, 'create book pages') !== FALSE) { + $fixed_perm .= ', add content to books'; + } + // Only save if the permissions have changed. + if ($fixed_perm != $role->perm) { + $ret[] = update_sql("UPDATE {permission} SET perm = '$fixed_perm' WHERE rid = $role->rid"); + } + } + + // Determine whether there are any existing nodes in the book hierarchy. + if (db_result(db_query("SELECT COUNT(*) FROM {book}"))) { + // Temporary table for the old book hierarchy; we'll discard revision info. + $schema['book_temp'] = array( + 'fields' => array( + 'nid' => array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0), + 'parent' => array('type' => 'int', 'not null' => TRUE, 'default' => 0), + 'weight' => array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'size' => 'tiny') + ), + 'indexes' => array( + 'parent' => array('parent') + ), + 'primary key' => array('nid'), + ); + + db_create_table($ret, 'book_temp', $schema['book_temp']); + + // Insert each node in the old table into the temporary table. + $ret[] = update_sql("INSERT INTO {book_temp} (nid, parent, weight) SELECT b.nid, b.parent, b.weight FROM {book} b INNER JOIN {node} n on b.vid = n.vid"); + $ret[] = update_sql("DROP TABLE {book}"); + + db_create_table($ret, 'book', $schema['book']); + + $_SESSION['book_update_6000_orphans']['from'] = 0; + $_SESSION['book_update_6000'] = array(); + $result = db_query("SELECT * from {book_temp} WHERE parent = 0"); + + // Collect all books - top-level nodes. + while ($a = db_fetch_array($result)) { + $_SESSION['book_update_6000'][] = $a; + } + $ret['#finished'] = FALSE; + return $ret; + } + else { + // No exising nodes in the hierarchy, so drop the table and re-create it. + $ret[] = update_sql("DROP TABLE {book}"); + db_create_table($ret, 'book', $schema['book']); + return $ret; + } + } + elseif ($_SESSION['book_update_6000_orphans']) { + // Do the first batched part of the update - collect orphans. + $update_count = 400; // Update this many at a time + + $result = db_query_range("SELECT * FROM {book_temp}", $_SESSION['book_update_6000_orphans']['from'], $update_count); + $has_rows = FALSE; + // Go through the next $update_count book pages and locate the orphans. + while ($book = db_fetch_array($result)) { + $has_rows = TRUE; + // Orphans are defined as nodes whose parent does not exist in the table. + if ($book['parent'] && !db_result(db_query("SELECT COUNT(*) FROM {book_temp} WHERE nid = %d", $book['parent']))) { + if (empty($_SESSION['book_update_6000_orphans']['book'])) { + // The first orphan becomes the parent for all other orphans. + $book['parent'] = 0; + $_SESSION['book_update_6000_orphans']['book'] = $book; + $ret[] = array('success' => TRUE, 'query' => 'Relocated orphan book pages.'); + } + else { + // Re-assign the parent value of the book, and add it to the stack. + $book['parent'] = $_SESSION['book_update_6000_orphans']['book']['nid']; + $_SESSION['book_update_6000'][] = $book; + } + } + } + if ($has_rows) { + $_SESSION['book_update_6000_orphans']['from'] += $update_count; + } + else { + // Done with this part + if (!empty($_SESSION['book_update_6000_orphans']['book'])) { + // The orphans' parent is added last, so it will be processed first. + $_SESSION['book_update_6000'][] = $_SESSION['book_update_6000_orphans']['book']; + } + $_SESSION['book_update_6000_orphans'] = FALSE; + } + $ret['#finished'] = FALSE; + return $ret; + } + else { + // Do the next batched part of the update + $update_count = 100; // Update this many at a time + + while ($update_count && $_SESSION['book_update_6000']) { + // Get the last node off the stack. + $book = array_pop($_SESSION['book_update_6000']); + + // Add all of this node's children to the stack + $result = db_query("SELECT * FROM {book_temp} WHERE parent = %d", $book['nid']); + while ($a = db_fetch_array($result)) { + $_SESSION['book_update_6000'][] = $a; + } + + if ($book['parent']) { + // If its not a top level page, get its parent's mlid. + $parent = db_fetch_array(db_query("SELECT b.mlid AS plid, b.bid FROM {book} b WHERE b.nid = %d", $book['parent'])); + $book = array_merge($book, $parent); + } + else { + // There is not a parent - this is a new book. + $book['plid'] = 0; + $book['bid'] = $book['nid']; + } + + $book += array( + 'module' => 'book', + 'link_path' => 'node/'. $book['nid'], + 'router_path' => 'node/%', + 'menu_name' => 'book-toc-'. $book['bid'], + ); + $book = array_merge($book, db_fetch_array(db_query("SELECT title AS link_title FROM {node} WHERE nid = %d", $book['nid']))); + + // Items with depth > MENU_MAX_DEPTH cannot be saved. + if (menu_link_save($book)) { + db_query("INSERT INTO {book} (mlid, nid, bid) VALUES (%d, %d, %d)", $book['mlid'], $book['nid'], $book['bid']); + } + else { + // The depth was greater then MENU_MAX_DEPTH, so attach it to the + // closest valid parent. + $book['plid'] = db_result(db_query("SELECT plid FROM {menu_links} WHERE mlid = %d", $book['plid'])); + if (menu_link_save($book)) { + db_query("INSERT INTO {book} (mlid, nid, bid) VALUES (%d, %d, %d)", $book['mlid'], $book['nid'], $book['bid']); + } + } + $update_count--; + } + $ret['#finished'] = FALSE; + } + + if (empty($_SESSION['book_update_6000'])) { + $ret['#finished'] = TRUE; + $ret[] = array('success' => TRUE, 'query' => 'Relocated existing book pages.'); + $ret[] = update_sql("DROP TABLE {book_temp}"); + unset($_SESSION['book_update_6000']); + unset($_SESSION['book_update_6000_orphans']); + } + + return $ret; +} + +/** + * Implementation of hook_schema(). + */ +function book_schema() { + $schema['book'] = array( + 'description' => t('Stores book outline information. Uniquely connects each node in the outline to a link in {menu_links}'), + 'fields' => array( + 'mlid' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + 'description' => t("The book page's {menu_links}.mlid."), + ), + 'nid' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + 'description' => t("The book page's {node}.nid."), + ), + 'bid' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + 'description' => t("The book ID is the {book}.nid of the top-level page."), + ), + ), + 'primary key' => array('mlid'), + 'unique keys' => array( + 'nid' => array('nid'), + ), + 'indexes' => array( + 'bid' => array('bid'), + ), + ); + + return $schema; +} + + diff -r 5a113a1c4740 -r c1f4ac30525a modules/book/book.module --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/book/book.module Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,1083 @@ + array( + 'arguments' => array('book_link' => NULL), + 'template' => 'book-navigation', + ), + 'book_export_html' => array( + 'arguments' => array('title' => NULL, 'contents' => NULL, 'depth' => NULL), + 'template' => 'book-export-html', + ), + 'book_admin_table' => array( + 'arguments' => array('form' => NULL), + ), + 'book_title_link' => array( + 'arguments' => array('link' => NULL), + ), + 'book_all_books_block' => array( + 'arguments' => array('book_menus' => array()), + 'template' => 'book-all-books-block', + ), + 'book_node_export_html' => array( + 'arguments' => array('node' => NULL, 'children' => NULL), + 'template' => 'book-node-export-html', + ), + ); +} + +/** + * Implementation of hook_perm(). + */ +function book_perm() { + return array('add content to books', 'administer book outlines', 'create new books', 'access printer-friendly version'); +} + +/** + * Implementation of hook_link(). + */ +function book_link($type, $node = NULL, $teaser = FALSE) { + $links = array(); + + if ($type == 'node' && isset($node->book)) { + if (!$teaser) { + $child_type = variable_get('book_child_type', 'book'); + if ((user_access('add content to books') || user_access('administer book outlines')) && node_access('create', $child_type) && $node->status == 1 && $node->book['depth'] < MENU_MAX_DEPTH) { + $links['book_add_child'] = array( + 'title' => t('Add child page'), + 'href' => "node/add/". str_replace('_', '-', $child_type), + 'query' => "parent=". $node->book['mlid'], + ); + } + if (user_access('access printer-friendly version')) { + $links['book_printer'] = array( + 'title' => t('Printer-friendly version'), + 'href' => 'book/export/html/'. $node->nid, + 'attributes' => array('title' => t('Show a printer-friendly version of this book page and its sub-pages.')) + ); + } + } + } + return $links; +} + +/** + * Implementation of hook_menu(). + */ +function book_menu() { + $items['admin/content/book'] = array( + 'title' => 'Books', + 'description' => "Manage your site's book outlines.", + 'page callback' => 'book_admin_overview', + 'access arguments' => array('administer book outlines'), + 'file' => 'book.admin.inc', + ); + $items['admin/content/book/list'] = array( + 'title' => 'List', + 'type' => MENU_DEFAULT_LOCAL_TASK, + ); + $items['admin/content/book/settings'] = array( + 'title' => 'Settings', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('book_admin_settings'), + 'access arguments' => array('administer site configuration'), + 'type' => MENU_LOCAL_TASK, + 'weight' => 8, + 'file' => 'book.admin.inc', + ); + $items['admin/content/book/%node'] = array( + 'title' => 'Re-order book pages and change titles', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('book_admin_edit', 3), + 'access callback' => '_book_outline_access', + 'access arguments' => array(3), + 'type' => MENU_CALLBACK, + 'file' => 'book.admin.inc', + ); + $items['book'] = array( + 'title' => 'Books', + 'page callback' => 'book_render', + 'access arguments' => array('access content'), + 'type' => MENU_SUGGESTED_ITEM, + 'file' => 'book.pages.inc', + ); + $items['book/export/%/%'] = array( + 'page callback' => 'book_export', + 'page arguments' => array(2, 3), + 'access arguments' => array('access printer-friendly version'), + 'type' => MENU_CALLBACK, + 'file' => 'book.pages.inc', + ); + $items['node/%node/outline'] = array( + 'title' => 'Outline', + 'page callback' => 'book_outline', + 'page arguments' => array(1), + 'access callback' => '_book_outline_access', + 'access arguments' => array(1), + 'type' => MENU_LOCAL_TASK, + 'weight' => 2, + 'file' => 'book.pages.inc', + ); + $items['node/%node/outline/remove'] = array( + 'title' => 'Remove from outline', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('book_remove_form', 1), + 'access callback' => '_book_outline_remove_access', + 'access arguments' => array(1), + 'type' => MENU_CALLBACK, + 'file' => 'book.pages.inc', + ); + $items['book/js/form'] = array( + 'page callback' => 'book_form_update', + 'access arguments' => array('access content'), + 'type' => MENU_CALLBACK, + 'file' => 'book.pages.inc', + ); + return $items; +} + +/** + * Menu item access callback - determine if the outline tab is accessible. + */ +function _book_outline_access($node) { + return user_access('administer book outlines') && node_access('view', $node); +} + +/** + * Menu item access callback - determine if the user can remove nodes from the outline. + */ +function _book_outline_remove_access($node) { + return isset($node->book) && ($node->book['bid'] != $node->nid) && _book_outline_access($node); +} + +/** + * Implementation of hook_init(). Add's the book module's CSS. + */ +function book_init() { + drupal_add_css(drupal_get_path('module', 'book') .'/book.css'); +} + +/** + * Implementation of hook_block(). + * + * Displays the book table of contents in a block when the current page is a + * single-node view of a book node. + */ +function book_block($op = 'list', $delta = 0, $edit = array()) { + $block = array(); + switch ($op) { + case 'list': + $block[0]['info'] = t('Book navigation'); + $block[0]['cache'] = BLOCK_CACHE_PER_PAGE | BLOCK_CACHE_PER_ROLE; + return $block; + case 'view': + $current_bid = 0; + if ($node = menu_get_object()) { + $current_bid = empty($node->book['bid']) ? 0 : $node->book['bid']; + } + if (variable_get('book_block_mode', 'all pages') == 'all pages') { + $block['subject'] = t('Book navigation'); + $book_menus = array(); + $pseudo_tree = array(0 => array('below' => FALSE)); + foreach (book_get_books() as $book_id => $book) { + if ($book['bid'] == $current_bid) { + // If the current page is a node associated with a book, the menu + // needs to be retrieved. + $book_menus[$book_id] = menu_tree_output(menu_tree_all_data($node->book['menu_name'], $node->book)); + } + else { + // Since we know we will only display a link to the top node, there + // is no reason to run an additional menu tree query for each book. + $book['in_active_trail'] = FALSE; + $pseudo_tree[0]['link'] = $book; + $book_menus[$book_id] = menu_tree_output($pseudo_tree); + } + } + $block['content'] = theme('book_all_books_block', $book_menus); + } + elseif ($current_bid) { + // Only display this block when the user is browsing a book. + $title = db_result(db_query(db_rewrite_sql('SELECT n.title FROM {node} n WHERE n.nid = %d'), $node->book['bid'])); + // Only show the block if the user has view access for the top-level node. + if ($title) { + $tree = menu_tree_all_data($node->book['menu_name'], $node->book); + // There should only be one element at the top level. + $data = array_shift($tree); + $block['subject'] = theme('book_title_link', $data['link']); + $block['content'] = ($data['below']) ? menu_tree_output($data['below']) : ''; + } + } + return $block; + case 'configure': + $options = array( + 'all pages' => t('Show block on all pages'), + 'book pages' => t('Show block only on book pages'), + ); + $form['book_block_mode'] = array( + '#type' => 'radios', + '#title' => t('Book navigation block display'), + '#options' => $options, + '#default_value' => variable_get('book_block_mode', 'all pages'), + '#description' => t("If Show block on all pages is selected, the block will contain the automatically generated menus for all of the site's books. If Show block only on book pages is selected, the block will contain only the one menu corresponding to the current page's book. In this case, if the current page is not in a book, no block will be displayed. The Page specific visibility settings or other visibility settings can be used in addition to selectively display this block."), + ); + return $form; + case 'save': + variable_set('book_block_mode', $edit['book_block_mode']); + break; + } +} + +/** + * Generate the HTML output for a link to a book title when used as a block title. + * + * @ingroup themeable + */ +function theme_book_title_link($link) { + $link['options']['attributes']['class'] = 'book-title'; + return l($link['title'], $link['href'], $link['options']); +} + +/** + * Returns an array of all books. + * + * This list may be used for generating a list of all the books, or for building + * the options for a form select. + */ +function book_get_books() { + static $all_books; + + if (!isset($all_books)) { + $all_books = array(); + $result = db_query("SELECT DISTINCT(bid) FROM {book}"); + $nids = array(); + while ($book = db_fetch_array($result)) { + $nids[] = $book['bid']; + } + if ($nids) { + $result2 = db_query(db_rewrite_sql("SELECT n.type, n.title, b.*, ml.* FROM {book} b INNER JOIN {node} n on b.nid = n.nid INNER JOIN {menu_links} ml ON b.mlid = ml.mlid WHERE n.nid IN (". implode(',', $nids) .") AND n.status = 1 ORDER BY ml.weight, ml.link_title")); + while ($link = db_fetch_array($result2)) { + $link['href'] = $link['link_path']; + $link['options'] = unserialize($link['options']); + $all_books[$link['bid']] = $link; + } + } + } + return $all_books; +} + +/** + * Implementation of hook_form_alter(). Adds the book fieldset to the node form. + * + * @see book_pick_book_submit() + * @see book_submit() + */ +function book_form_alter(&$form, $form_state, $form_id) { + + if (isset($form['type']) && isset($form['#node']) && $form['type']['#value'] .'_node_form' == $form_id) { + // Add elements to the node form + $node = $form['#node']; + + $access = user_access('administer book outlines'); + if (!$access) { + if (user_access('add content to books') && ((!empty($node->book['mlid']) && !empty($node->nid)) || book_type_is_allowed($node->type))) { + // Already in the book hierarchy or this node type is allowed + $access = TRUE; + } + } + + if ($access) { + _book_add_form_elements($form, $node); + $form['book']['pick-book'] = array( + '#type' => 'submit', + '#value' => t('Change book (update list of parents)'), + // Submit the node form so the parent select options get updated. + // This is typically only used when JS is disabled. Since the parent options + // won't be changed via AJAX, a button is provided in the node form to submit + // the form and generate options in the parent select corresponding to the + // selected book. This is similar to what happens during a node preview. + '#submit' => array('node_form_submit_build_node'), + '#weight' => 20, + ); + } + } +} + +/** + * Build the parent selection form element for the node form or outline tab + * + * This function is also called when generating a new set of options during the + * AJAX callback, so an array is returned that can be used to replace an existing + * form element. + */ +function _book_parent_select($book_link) { + if (variable_get('menu_override_parent_selector', FALSE)) { + return array(); + } + // Offer a message or a drop-down to choose a different parent page. + $form = array( + '#type' => 'hidden', + '#value' => -1, + '#prefix' => '

', + '#suffix' => '

', + ); + + if ($book_link['nid'] === $book_link['bid']) { + // This is a book - at the top level. + if ($book_link['original_bid'] === $book_link['bid']) { + $form['#prefix'] .= ''. t('This is the top-level page in this book.') .''; + } + else { + $form['#prefix'] .= ''. t('This will be the top-level page in this book.') .''; + } + } + elseif (!$book_link['bid']) { + $form['#prefix'] .= ''. t('No book selected.') .''; + } + else { + $form = array( + '#type' => 'select', + '#title' => t('Parent item'), + '#default_value' => $book_link['plid'], + '#description' => t('The parent page in the book. The maximum depth for a book and all child pages is !maxdepth. Some pages in the selected book may not be available as parents if selecting them would exceed this limit.', array('!maxdepth' => MENU_MAX_DEPTH)), + '#options' => book_toc($book_link['bid'], array($book_link['mlid']), $book_link['parent_depth_limit']), + '#attributes' => array('class' => 'book-title-select'), + ); + } + return $form; +} + +/** + * Build the common elements of the book form for the node and outline forms. + */ +function _book_add_form_elements(&$form, $node) { + // Need this for AJAX. + $form['#cache'] = TRUE; + drupal_add_js("if (Drupal.jsEnabled) { $(document).ready(function() { $('#edit-book-pick-book').css('display', 'none'); }); }", 'inline'); + + $form['book'] = array( + '#type' => 'fieldset', + '#title' => t('Book outline'), + '#weight' => 10, + '#collapsible' => TRUE, + '#collapsed' => TRUE, + '#tree' => TRUE, + '#attributes' => array('class' => 'book-outline-form'), + ); + foreach (array('menu_name', 'mlid', 'nid', 'router_path', 'has_children', 'options', 'module', 'original_bid', 'parent_depth_limit') as $key) { + $form['book'][$key] = array( + '#type' => 'value', + '#value' => $node->book[$key], + ); + } + + $form['book']['plid'] = _book_parent_select($node->book); + + $form['book']['weight'] = array( + '#type' => 'weight', + '#title' => t('Weight'), + '#default_value' => $node->book['weight'], + '#delta' => 15, + '#weight' => 5, + '#description' => t('Pages at a given level are ordered first by weight and then by title.'), + ); + $options = array(); + $nid = isset($node->nid) ? $node->nid : 'new'; + + if (isset($node->nid) && ($nid == $node->book['original_bid']) && ($node->book['parent_depth_limit'] == 0)) { + // This is the top level node in a maximum depth book and thus cannot be moved. + $options[$node->nid] = $node->title; + } + else { + foreach (book_get_books() as $book) { + $options[$book['nid']] = $book['title']; + } + } + + if (user_access('create new books') && ($nid == 'new' || ($nid != $node->book['original_bid']))) { + // The node can become a new book, if it is not one already. + $options = array($nid => '<'. t('create a new book') .'>') + $options; + } + if (!$node->book['mlid']) { + // The node is not currently in a the hierarchy. + $options = array(0 => '<'. t('none') .'>') + $options; + } + + // Add a drop-down to select the destination book. + $form['book']['bid'] = array( + '#type' => 'select', + '#title' => t('Book'), + '#default_value' => $node->book['bid'], + '#options' => $options, + '#access' => (bool)$options, + '#description' => t('Your page will be a part of the selected book.'), + '#weight' => -5, + '#attributes' => array('class' => 'book-title-select'), + '#ahah' => array( + 'path' => 'book/js/form', + 'wrapper' => 'edit-book-plid-wrapper', + 'effect' => 'slide', + ), + ); +} + +/** + * Common helper function to handles additions and updates to the book outline. + * + * Performs all additions and updates to the book outline through node addition, + * node editing, node deletion, or the outline tab. + */ +function _book_update_outline(&$node) { + if (empty($node->book['bid'])) { + return FALSE; + } + $new = empty($node->book['mlid']); + + $node->book['link_path'] = 'node/'. $node->nid; + $node->book['link_title'] = $node->title; + $node->book['parent_mismatch'] = FALSE; // The normal case. + + if ($node->book['bid'] == $node->nid) { + $node->book['plid'] = 0; + $node->book['menu_name'] = book_menu_name($node->nid); + } + else { + // Check in case the parent is not is this book; the book takes precedence. + if (!empty($node->book['plid'])) { + $parent = db_fetch_array(db_query("SELECT * FROM {book} WHERE mlid = %d", $node->book['plid'])); + } + if (empty($node->book['plid']) || !$parent || $parent['bid'] != $node->book['bid']) { + $node->book['plid'] = db_result(db_query("SELECT mlid FROM {book} WHERE nid = %d", $node->book['bid'])); + $node->book['parent_mismatch'] = TRUE; // Likely when JS is disabled. + } + } + if (menu_link_save($node->book)) { + if ($new) { + // Insert new. + db_query("INSERT INTO {book} (nid, mlid, bid) VALUES (%d, %d, %d)", $node->nid, $node->book['mlid'], $node->book['bid']); + } + else { + if ($node->book['bid'] != db_result(db_query("SELECT bid FROM {book} WHERE nid = %d", $node->nid))) { + // Update the bid for this page and all children. + book_update_bid($node->book); + } + } + return TRUE; + } + // Failed to save the menu link + return FALSE; +} + +/** + * Update the bid for a page and its children when it is moved to a new book. + * + * @param $book_link + * A fully loaded menu link that is part of the book hierarchy. + */ +function book_update_bid($book_link) { + + for ($i = 1; $i <= MENU_MAX_DEPTH && $book_link["p$i"]; $i++) { + $match[] = "p$i = %d"; + $args[] = $book_link["p$i"]; + } + $result = db_query("SELECT mlid FROM {menu_links} WHERE ". implode(' AND ', $match), $args); + + $mlids = array(); + while ($a = db_fetch_array($result)) { + $mlids[] = $a['mlid']; + } + if ($mlids) { + db_query("UPDATE {book} SET bid = %d WHERE mlid IN (". implode(',', $mlids) .")", $book_link['bid']); + } +} + +/** + * Get the book menu tree for a page, and return it as a linear array. + * + * @param $book_link + * A fully loaded menu link that is part of the book hierarchy. + * @return + * A linear array of menu links in the order that the links are shown in the + * menu, so the previous and next pages are the elements before and after the + * element corresponding to $node. The children of $node (if any) will come + * immediately after it in the array. + */ +function book_get_flat_menu($book_link) { + static $flat = array(); + + if (!isset($flat[$book_link['mlid']])) { + // Call menu_tree_full_data() to take advantage of the menu system's caching. + $tree = menu_tree_all_data($book_link['menu_name'], $book_link); + $flat[$book_link['mlid']] = array(); + _book_flatten_menu($tree, $flat[$book_link['mlid']]); + } + return $flat[$book_link['mlid']]; +} + +/** + * Recursive helper function for book_get_flat_menu(). + */ +function _book_flatten_menu($tree, &$flat) { + foreach ($tree as $data) { + if (!$data['link']['hidden']) { + $flat[$data['link']['mlid']] = $data['link']; + if ($data['below']) { + _book_flatten_menu($data['below'], $flat); + } + } + } +} + +/** + * Fetches the menu link for the previous page of the book. + */ +function book_prev($book_link) { + // If the parent is zero, we are at the start of a book. + if ($book_link['plid'] == 0) { + return NULL; + } + $flat = book_get_flat_menu($book_link); + // Assigning the array to $flat resets the array pointer for use with each(). + $curr = NULL; + do { + $prev = $curr; + list($key, $curr) = each($flat); + } while ($key && $key != $book_link['mlid']); + + if ($key == $book_link['mlid']) { + // The previous page in the book may be a child of the previous visible link. + if ($prev['depth'] == $book_link['depth'] && $prev['has_children']) { + // The subtree will have only one link at the top level - get its data. + $data = array_shift(book_menu_subtree_data($prev)); + // The link of interest is the last child - iterate to find the deepest one. + while ($data['below']) { + $data = end($data['below']); + } + return $data['link']; + } + else { + return $prev; + } + } +} + +/** + * Fetches the menu link for the next page of the book. + */ +function book_next($book_link) { + $flat = book_get_flat_menu($book_link); + // Assigning the array to $flat resets the array pointer for use with each(). + do { + list($key, $curr) = each($flat); + } while ($key && $key != $book_link['mlid']); + if ($key == $book_link['mlid']) { + return current($flat); + } +} + +/** + * Format the menu links for the child pages of the current page. + */ +function book_children($book_link) { + $flat = book_get_flat_menu($book_link); + + $children = array(); + + if ($book_link['has_children']) { + // Walk through the array until we find the current page. + do { + $link = array_shift($flat); + } while ($link && ($link['mlid'] != $book_link['mlid'])); + // Continue though the array and collect the links whose parent is this page. + while (($link = array_shift($flat)) && $link['plid'] == $book_link['mlid']) { + $data['link'] = $link; + $data['below'] = ''; + $children[] = $data; + } + } + return $children ? menu_tree_output($children) : ''; +} + +/** + * Generate the corresponding menu name from a book ID. + */ +function book_menu_name($bid) { + return 'book-toc-'. $bid; +} + +/** + * Build an active trail to show in the breadcrumb. + */ +function book_build_active_trail($book_link) { + static $trail; + + if (!isset($trail)) { + $trail = array(); + $trail[] = array('title' => t('Home'), 'href' => '', 'localized_options' => array()); + + $tree = menu_tree_all_data($book_link['menu_name'], $book_link); + $curr = array_shift($tree); + + while ($curr) { + if ($curr['link']['href'] == $book_link['href']) { + $trail[] = $curr['link']; + $curr = FALSE; + } + else { + if ($curr['below'] && $curr['link']['in_active_trail']) { + $trail[] = $curr['link']; + $tree = $curr['below']; + } + $curr = array_shift($tree); + } + } + } + return $trail; +} + +/** + * Implementation of hook_nodeapi(). + * + * Appends book navigation to all nodes in the book, and handles book outline + * insertions and updates via the node form. + */ +function book_nodeapi(&$node, $op, $teaser, $page) { + switch ($op) { + case 'load': + // Note - we cannot use book_link_load() because it will call node_load() + $info['book'] = db_fetch_array(db_query('SELECT * FROM {book} b INNER JOIN {menu_links} ml ON b.mlid = ml.mlid WHERE b.nid = %d', $node->nid)); + if ($info['book']) { + $info['book']['href'] = $info['book']['link_path']; + $info['book']['title'] = $info['book']['link_title']; + $info['book']['options'] = unserialize($info['book']['options']); + return $info; + } + break; + case 'view': + if (!$teaser) { + if (!empty($node->book['bid']) && $node->build_mode == NODE_BUILD_NORMAL) { + + $node->content['book_navigation'] = array( + '#value' => theme('book_navigation', $node->book), + '#weight' => 100, + ); + + if ($page) { + menu_set_active_trail(book_build_active_trail($node->book)); + menu_set_active_menu_name($node->book['menu_name']); + } + } + } + break; + case 'presave': + // Always save a revision for non-administrators. + if (!empty($node->book['bid']) && !user_access('administer nodes')) { + $node->revision = 1; + } + // Make sure a new node gets a new menu link. + if (empty($node->nid)) { + $node->book['mlid'] = NULL; + } + break; + case 'insert': + case 'update': + if (!empty($node->book['bid'])) { + if ($node->book['bid'] == 'new') { + // New nodes that are their own book. + $node->book['bid'] = $node->nid; + } + $node->book['nid'] = $node->nid; + $node->book['menu_name'] = book_menu_name($node->book['bid']); + _book_update_outline($node); + } + break; + case 'delete': + if (!empty($node->book['bid'])) { + if ($node->nid == $node->book['bid']) { + // Handle deletion of a top-level post. + $result = db_query("SELECT b.nid FROM {menu_links} ml INNER JOIN {book} b on b.mlid = ml.mlid WHERE ml.plid = %d", $node->book['mlid']); + while ($child = db_fetch_array($result)) { + $child_node = node_load($child['nid']); + $child_node->book['bid'] = $child_node->nid; + _book_update_outline($child_node); + } + } + menu_link_delete($node->book['mlid']); + db_query('DELETE FROM {book} WHERE mlid = %d', $node->book['mlid']); + } + break; + case 'prepare': + // Prepare defaults for the add/edit form. + if (empty($node->book) && (user_access('add content to books') || user_access('administer book outlines'))) { + $node->book = array(); + if (empty($node->nid) && isset($_GET['parent']) && is_numeric($_GET['parent'])) { + // Handle "Add child page" links: + $parent = book_link_load($_GET['parent']); + if ($parent && $parent['access']) { + $node->book['bid'] = $parent['bid']; + $node->book['plid'] = $parent['mlid']; + $node->book['menu_name'] = $parent['menu_name']; + } + } + // Set defaults. + $node->book += _book_link_defaults(!empty($node->nid) ? $node->nid : 'new'); + } + else { + if (isset($node->book['bid']) && !isset($node->book['original_bid'])) { + $node->book['original_bid'] = $node->book['bid']; + } + } + // Find the depth limit for the parent select. + if (isset($node->book['bid']) && !isset($node->book['parent_depth_limit'])) { + $node->book['parent_depth_limit'] = _book_parent_depth_limit($node->book); + } + break; + } +} + +/** + * Find the depth limit for items in the parent select. + */ +function _book_parent_depth_limit($book_link) { + return MENU_MAX_DEPTH - 1 - (($book_link['mlid'] && $book_link['has_children']) ? menu_link_children_relative_depth($book_link) : 0); +} + +/** + * Form altering function for the confirm form for a single node deletion. + */ +function book_form_node_delete_confirm_alter(&$form, $form_state) { + + $node = node_load($form['nid']['#value']); + + if (isset($node->book) && $node->book['has_children']) { + $form['book_warning'] = array( + '#value' => '

'. t('%title is part of a book outline, and has associated child pages. If you proceed with deletion, the child pages will be relocated automatically.', array('%title' => $node->title)) .'

', + '#weight' => -10, + ); + } +} + +/** + * Return an array with default values for a book link. + */ +function _book_link_defaults($nid) { + return array('original_bid' => 0, 'menu_name' => '', 'nid' => $nid, 'bid' => 0, 'router_path' => 'node/%', 'plid' => 0, 'mlid' => 0, 'has_children' => 0, 'weight' => 0, 'module' => 'book', 'options' => array()); +} + +/** + * Process variables for book-navigation.tpl.php. + * + * The $variables array contains the following arguments: + * - $book_link + * + * @see book-navigation.tpl.php + */ +function template_preprocess_book_navigation(&$variables) { + $book_link = $variables['book_link']; + + // Provide extra variables for themers. Not needed by default. + $variables['book_id'] = $book_link['bid']; + $variables['book_title'] = check_plain($book_link['link_title']); + $variables['book_url'] = 'node/'. $book_link['bid']; + $variables['current_depth'] = $book_link['depth']; + + $variables['tree'] = ''; + if ($book_link['mlid']) { + $variables['tree'] = book_children($book_link); + + if ($prev = book_prev($book_link)) { + $prev_href = url($prev['href']); + drupal_add_link(array('rel' => 'prev', 'href' => $prev_href)); + $variables['prev_url'] = $prev_href; + $variables['prev_title'] = check_plain($prev['title']); + } + if ($book_link['plid'] && $parent = book_link_load($book_link['plid'])) { + $parent_href = url($parent['href']); + drupal_add_link(array('rel' => 'up', 'href' => $parent_href)); + $variables['parent_url'] = $parent_href; + $variables['parent_title'] = check_plain($parent['title']); + } + if ($next = book_next($book_link)) { + $next_href = url($next['href']); + drupal_add_link(array('rel' => 'next', 'href' => $next_href)); + $variables['next_url'] = $next_href; + $variables['next_title'] = check_plain($next['title']); + } + } + + $variables['has_links'] = FALSE; + // Link variables to filter for values and set state of the flag variable. + $links = array('prev_url', 'prev_title', 'parent_url', 'parent_title', 'next_url', 'next_title'); + foreach ($links as $link) { + if (isset($variables[$link])) { + // Flag when there is a value. + $variables['has_links'] = TRUE; + } + else { + // Set empty to prevent notices. + $variables[$link] = ''; + } + } +} + +/** + * A recursive helper function for book_toc(). + */ +function _book_toc_recurse($tree, $indent, &$toc, $exclude, $depth_limit) { + foreach ($tree as $data) { + if ($data['link']['depth'] > $depth_limit) { + // Don't iterate through any links on this level. + break; + } + if (!in_array($data['link']['mlid'], $exclude)) { + $toc[$data['link']['mlid']] = $indent .' '. truncate_utf8($data['link']['title'], 30, TRUE, TRUE); + if ($data['below']) { + _book_toc_recurse($data['below'], $indent .'--', $toc, $exclude, $depth_limit); + } + } + } +} + +/** + * Returns an array of book pages in table of contents order. + * + * @param $bid + * The ID of the book whose pages are to be listed. + * @param $exclude + * Optional array of mlid values. Any link whose mlid is in this array + * will be excluded (along with its children). + * @param $depth_limit + * Any link deeper than this value will be excluded (along with its children). + * @return + * An array of mlid, title pairs for use as options for selecting a book page. + */ +function book_toc($bid, $exclude = array(), $depth_limit) { + + $tree = menu_tree_all_data(book_menu_name($bid)); + $toc = array(); + _book_toc_recurse($tree, '', $toc, $exclude, $depth_limit); + + return $toc; +} + +/** + * Process variables for book-export-html.tpl.php. + * + * The $variables array contains the following arguments: + * - $title + * - $contents + * - $depth + * + * @see book-export-html.tpl.php + */ +function template_preprocess_book_export_html(&$variables) { + global $base_url, $language; + + $variables['title'] = check_plain($variables['title']); + $variables['base_url'] = $base_url; + $variables['language'] = $language; + $variables['language_rtl'] = (defined('LANGUAGE_RTL') && $language->direction == LANGUAGE_RTL) ? TRUE : FALSE; + $variables['head'] = drupal_get_html_head(); +} + +/** + * Traverse the book tree to build printable or exportable output. + * + * During the traversal, the $visit_func() callback is applied to each + * node, and is called recursively for each child of the node (in weight, + * title order). + * + * @param $tree + * A subtree of the book menu hierarchy, rooted at the current page. + * @param $visit_func + * A function callback to be called upon visiting a node in the tree. + * @return + * The output generated in visiting each node. + */ +function book_export_traverse($tree, $visit_func) { + $output = ''; + + foreach ($tree as $data) { + // Note- access checking is already performed when building the tree. + if ($node = node_load($data['link']['nid'], FALSE)) { + $children = ''; + if ($data['below']) { + $children = book_export_traverse($data['below'], $visit_func); + } + + if (function_exists($visit_func)) { + $output .= call_user_func($visit_func, $node, $children); + } + else { + // Use the default function. + $output .= book_node_export($node, $children); + } + } + } + return $output; +} + +/** + * Generates printer-friendly HTML for a node. + * + * @see book_export_traverse() + * + * @param $node + * The node to generate output for. + * @param $children + * All the rendered child nodes within the current node. + * @return + * The HTML generated for the given node. + */ +function book_node_export($node, $children = '') { + + $node->build_mode = NODE_BUILD_PRINT; + $node = node_build_content($node, FALSE, FALSE); + $node->body = drupal_render($node->content); + + return theme('book_node_export_html', $node, $children); +} + +/** + * Process variables for book-node-export-html.tpl.php. + * + * The $variables array contains the following arguments: + * - $node + * - $children + * + * @see book-node-export-html.tpl.php + */ +function template_preprocess_book_node_export_html(&$variables) { + $variables['depth'] = $variables['node']->book['depth']; + $variables['title'] = check_plain($variables['node']->title); + $variables['content'] = $variables['node']->body; +} + +/** + * Determine if a given node type is in the list of types allowed for books. + */ +function book_type_is_allowed($type) { + return in_array($type, variable_get('book_allowed_types', array('book'))); +} + +/** + * Implementation of hook_node_type(). + * + * Update book module's persistent variables if the machine-readable name of a + * node type is changed. + */ +function book_node_type($op, $type) { + + switch ($op) { + case 'update': + if (!empty($type->old_type) && $type->old_type != $type->type) { + // Update the list of node types that are allowed to be added to books. + $allowed_types = variable_get('book_allowed_types', array('book')); + $key = array_search($type->old_type, $allowed_types); + if ($key !== FALSE) { + $allowed_types[$type->type] = $allowed_types[$key] ? $type->type : 0; + unset($allowed_types[$key]); + variable_set('book_allowed_types', $allowed_types); + } + // Update the setting for the "Add child page" link. + if (variable_get('book_child_type', 'book') == $type->old_type) { + variable_set('book_child_type', $type->type); + } + } + break; + } +} + +/** + * Implementation of hook_help(). + */ +function book_help($path, $arg) { + switch ($path) { + case 'admin/help#book': + $output = '

'. t('The book module is suited for creating structured, multi-page hypertexts such as site resource guides, manuals, and Frequently Asked Questions (FAQs). It permits a document to have chapters, sections, subsections, etc. Authors with suitable permissions can add pages to a collaborative book, placing them into the existing document by adding them to a table of contents menu.') .'

'; + $output .= '

'. t('Pages in the book hierarchy have navigation elements at the bottom of the page for moving through the text. These links lead to the previous and next pages in the book, and to the level above the current page in the book\'s structure. More comprehensive navigation may be provided by enabling the book navigation block on the blocks administration page.', array('@admin-block' => url('admin/build/block'))) .'

'; + $output .= '

'. t('Users can select the printer-friendly version link visible at the bottom of a book page to generate a printer-friendly display of the page and all of its subsections. ') .'

'; + $output .= '

'. t("Users with the administer book outlines permission can add a post of any content type to a book, by selecting the appropriate book while editing the post or by using the interface available on the post's outline tab.") .'

'; + $output .= '

'. t('Administrators can view a list of all books on the book administration page. The Outline page for each book allows section titles to be edited or rearranged.', array('@admin-node-book' => url('admin/content/book'))) .'

'; + $output .= '

'. t('For more information, see the online handbook entry for Book module.', array('@book' => 'http://drupal.org/handbook/modules/book/')) .'

'; + return $output; + case 'admin/content/book': + return '

'. t('The book module offers a means to organize a collection of related posts, collectively known as a book. When viewed, these posts automatically display links to adjacent book pages, providing a simple navigation system for creating and reviewing structured content.') .'

'; + case 'node/%/outline': + return '

'. t('The outline feature allows you to include posts in the book hierarchy, as well as move them within the hierarchy or to reorder an entire book.', array('@book' => url('book'), '@book-admin' => url('admin/content/book'))) .'

'; + } +} + +/** + * Like menu_link_load(), but adds additional data from the {book} table. + * + * Do not call when loading a node, since this function may call node_load(). + */ +function book_link_load($mlid) { + if ($item = db_fetch_array(db_query("SELECT * FROM {menu_links} ml INNER JOIN {book} b ON b.mlid = ml.mlid LEFT JOIN {menu_router} m ON m.path = ml.router_path WHERE ml.mlid = %d", $mlid))) { + _menu_link_translate($item); + return $item; + } + return FALSE; +} + +/** + * Get the data representing a subtree of the book hierarchy. + * + * The root of the subtree will be the link passed as a parameter, so the + * returned tree will contain this item and all its descendents in the menu tree. + * + * @param $item + * A fully loaded menu link. + * @return + * An subtree of menu links in an array, in the order they should be rendered. + */ +function book_menu_subtree_data($item) { + static $tree = array(); + + $cid = 'links:'. $item['menu_name'] .':subtree:'. $item['mlid']; + + if (!isset($tree[$cid])) { + $cache = cache_get($cid, 'cache_menu'); + if ($cache && isset($cache->data)) { + $data = $cache->data; + } + else { + $match = array("menu_name = '%s'"); + $args = array($item['menu_name']); + $i = 1; + while ($i <= MENU_MAX_DEPTH && $item["p$i"]) { + $match[] = "p$i = %d"; + $args[] = $item["p$i"]; + $i++; + } + $sql = " + SELECT b.*, m.load_functions, m.to_arg_functions, m.access_callback, m.access_arguments, m.page_callback, m.page_arguments, m.title, m.title_callback, m.title_arguments, m.type, ml.* + FROM {menu_links} ml INNER JOIN {menu_router} m ON m.path = ml.router_path + INNER JOIN {book} b ON ml.mlid = b.mlid + WHERE ". implode(' AND ', $match) ." + ORDER BY p1 ASC, p2 ASC, p3 ASC, p4 ASC, p5 ASC, p6 ASC, p7 ASC, p8 ASC, p9 ASC"; + + $data['tree'] = menu_tree_data(db_query($sql, $args), array(), $item['depth']); + $data['node_links'] = array(); + menu_tree_collect_node_links($data['tree'], $data['node_links']); + // Cache the data. + cache_set($cid, $data, 'cache_menu'); + } + // Check access for the current user to each item in the tree. + menu_tree_check_access($data['tree'], $data['node_links']); + $tree[$cid] = $data['tree']; + } + + return $tree[$cid]; +} + diff -r 5a113a1c4740 -r c1f4ac30525a modules/book/book.pages.inc --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/book/book.pages.inc Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,263 @@ +book)) { + $tree = book_menu_subtree_data($node->book); + $contents = book_export_traverse($tree, 'book_node_export'); + } + return theme('book_export_html', $node->title, $contents, $node->book['depth']); + } + else { + drupal_access_denied(); + } +} + +/** + * Menu callback; show the outline form for a single node. + */ +function book_outline($node) { + drupal_set_title(check_plain($node->title)); + return drupal_get_form('book_outline_form', $node); +} + +/** + * Build the form to handle all book outline operations via the outline tab. + * + * @see book_outline_form_submit() + * @see book_remove_button_submit() + * + * @ingroup forms + */ +function book_outline_form(&$form_state, $node) { + + if (!isset($node->book)) { + // The node is not part of any book yet - set default options. + $node->book = _book_link_defaults($node->nid); + } + else { + $node->book['original_bid'] = $node->book['bid']; + } + // Find the depth limit for the parent select. + if (!isset($node->book['parent_depth_limit'])) { + $node->book['parent_depth_limit'] = _book_parent_depth_limit($node->book); + } + $form['#node'] = $node; + $form['#id'] = 'book-outline'; + _book_add_form_elements($form, $node); + + $form['book']['#collapsible'] = FALSE; + + $form['update'] = array( + '#type' => 'submit', + '#value' => $node->book['original_bid'] ? t('Update book outline') : t('Add to book outline'), + '#weight' => 15, + ); + + $form['remove'] = array( + '#type' => 'submit', + '#value' => t('Remove from book outline'), + '#access' => $node->nid != $node->book['bid'] && $node->book['bid'], + '#weight' => 20, + '#submit' => array('book_remove_button_submit'), + ); + + return $form; +} + +/** + * Button submit function to redirect to removal confirm form. + * + * @see book_outline_form() + */ +function book_remove_button_submit($form, &$form_state) { + $form_state['redirect'] = 'node/'. $form['#node']->nid .'/outline/remove'; +} + +/** + * Handles book outline form submissions from the outline tab. + * + * @see book_outline_form() + */ +function book_outline_form_submit($form, &$form_state) { + $node = $form['#node']; + $form_state['redirect'] = "node/". $node->nid; + $book_link = $form_state['values']['book']; + if (!$book_link['bid']) { + drupal_set_message(t('No changes were made')); + return; + } + + $book_link['menu_name'] = book_menu_name($book_link['bid']); + $node->book = $book_link; + if (_book_update_outline($node)) { + if ($node->book['parent_mismatch']) { + // This will usually only happen when JS is disabled. + drupal_set_message(t('The post has been added to the selected book. You may now position it relative to other pages.')); + $form_state['redirect'] = "node/". $node->nid ."/outline"; + } + else { + drupal_set_message(t('The book outline has been updated.')); + } + } + else { + drupal_set_message(t('There was an error adding the post to the book.'), 'error'); + } +} + +/** + * Menu callback; builds a form to confirm removal of a node from the book. + * + * @see book_remove_form_submit() + * + * @ingroup forms + */ +function book_remove_form(&$form_state, $node) { + $form['#node'] = $node; + $title = array('%title' => $node->title); + + if ($node->book['has_children']) { + $description = t('%title has associated child pages, which will be relocated automatically to maintain their connection to the book. To recreate the hierarchy (as it was before removing this page), %title may be added again using the Outline tab, and each of its former child pages will need to be relocated manually.', $title); + } + else { + $description = t('%title may be added to hierarchy again using the Outline tab.', $title); + } + + return confirm_form($form, t('Are you sure you want to remove %title from the book hierarchy?', $title), 'node/'. $node->nid, $description, t('Remove')); +} + +/** + * Confirm form submit function to remove a node from the book. + * + * @see book_remove_form() + */ +function book_remove_form_submit($form, &$form_state) { + $node = $form['#node']; + if ($node->nid != $node->book['bid']) { + // Only allowed when this is not a book (top-level page). + menu_link_delete($node->book['mlid']); + db_query('DELETE FROM {book} WHERE nid = %d', $node->nid); + drupal_set_message(t('The post has been removed from the book.')); + } + $form_state['redirect'] = 'node/'. $node->nid; +} + +/** + * AJAX callback to replace the book parent select options. + * + * This function is called when the selected book is changed. It updates the + * cached form (either the node form or the book outline form) and returns + * rendered output to be used to replace the select containing the possible + * parent pages in the newly selected book. + * + * @param $build_id + * The form's build_id. + * @param $bid + * A bid from from among those in the form's book select. + * @return + * Prints the replacement HTML in JSON format. + */ +function book_form_update() { + $cid = 'form_'. $_POST['form_build_id']; + $bid = $_POST['book']['bid']; + $cache = cache_get($cid, 'cache_form'); + if ($cache) { + $form = $cache->data; + + // Validate the bid. + if (isset($form['book']['bid']['#options'][$bid])) { + $book_link = $form['#node']->book; + $book_link['bid'] = $bid; + // Get the new options and update the cache. + $form['book']['plid'] = _book_parent_select($book_link); + cache_set($cid, $form, 'cache_form', $cache->expire); + + // Build and render the new select element, then return it in JSON format. + $form_state = array(); + $form['#post'] = array(); + $form = form_builder($form['form_id']['#value'] , $form, $form_state); + $output = drupal_render($form['book']['plid']); + drupal_json(array('status' => TRUE, 'data' => $output)); + } + else { + drupal_json(array('status' => FALSE, 'data' => '')); + } + } + else { + drupal_json(array('status' => FALSE, 'data' => '')); + } + exit(); +} diff -r 5a113a1c4740 -r c1f4ac30525a modules/color/color-rtl.css --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/color/color-rtl.css Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,44 @@ +/* $Id: color-rtl.css,v 1.2 2007/11/27 12:09:25 goba Exp $ */ + +#placeholder { + left: 0; + right: auto; +} + +/* Palette */ +.color-form .form-item { + padding-left: 0; + padding-right: 1em; +} +.color-form label { + float: right; + clear: right; +} +.color-form .form-text, .color-form .form-select { + float: right; +} +.color-form .form-text { + margin-right: 0; + margin-left: 5px; +} + +#palette .hook { + float: right; +} +#palette .down, #palette .up, #palette .both { + background: url(images/hook-rtl.png) no-repeat 0 0; +} +#palette .up { + background-position: 0 -27px; +} +#palette .both { + background-position: 0 -54px; +} + +#palette .lock { + float: right; + right: -10px; +} +html.js #preview { + float: right; +} diff -r 5a113a1c4740 -r c1f4ac30525a modules/color/color.css --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/color/color.css Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,79 @@ +/* $Id: color.css,v 1.4 2007/05/27 17:57:48 goba Exp $ */ + +/* Farbtastic placement */ +.color-form { + max-width: 50em; + position: relative; +} +#placeholder { + position: absolute; + top: 0; + right: 0; /* LTR */ +} + +/* Palette */ +.color-form .form-item { + height: 2em; + line-height: 2em; + padding-left: 1em; /* LTR */ + margin: 0.5em 0; +} +.color-form label { + float: left; /* LTR */ + clear: left; /* LTR */ + width: 10em; +} +.color-form .form-text, .color-form .form-select { + float: left; /* LTR */ +} +.color-form .form-text { + text-align: center; + margin-right: 5px; /* LTR */ + cursor: pointer; +} + +#palette .hook { + float: left; /* LTR */ + margin-top: 3px; + width: 16px; + height: 16px; +} +#palette .down, #palette .up, #palette .both { + background: url(images/hook.png) no-repeat 100% 0; /* LTR */ +} +#palette .up { + background-position: 100% -27px; /* LTR */ +} +#palette .both { + background-position: 100% -54px; /* LTR */ +} + +#palette .lock { + float: left; /* LTR */ + position: relative; + top: -1.4em; + left: -10px; /* LTR */ + width: 20px; + height: 25px; + background: url(images/lock.png) no-repeat 50% 2px; + cursor: pointer; +} +#palette .unlocked { + background-position: 50% -22px; +} +#palette .form-item { + width: 20em; +} +#palette .item-selected { + background: #eee; +} + +/* Preview */ +#preview { + display: none; +} +html.js #preview { + display: block; + position: relative; + float: left; /* LTR */ +} diff -r 5a113a1c4740 -r c1f4ac30525a modules/color/color.info --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/color/color.info Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,6 @@ +; $Id: color.info,v 1.3 2007/06/08 05:50:54 dries Exp $ +name = Color +description = Allows the user to change the color scheme of certain themes. +package = Core - optional +version = VERSION +core = 6.x diff -r 5a113a1c4740 -r c1f4ac30525a modules/color/color.install --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/color/color.install Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,35 @@ + $info['GD Version'], + ); + + // Check PNG support + if (function_exists('imagecreatefrompng')) { + $requirements['gd']['severity'] = REQUIREMENT_OK; + } + else { + $requirements['gd']['severity'] = REQUIREMENT_ERROR; + $requirements['gd']['description'] = t('The GD library for PHP is enabled, but was compiled without PNG support. Please check the PHP image documentation for information on how to correct this.', array('@url' => 'http://www.php.net/manual/en/ref.image.php')); + } + } + else { + $requirements['gd'] = array( + 'value' => t('Not installed'), + 'severity' => REQUIREMENT_ERROR, + 'description' => t('The GD library for PHP is missing or outdated. Please check the PHP image documentation for information on how to correct this.', array('@url' => 'http://www.php.net/manual/en/ref.image.php')), + ); + } + $requirements['gd']['title'] = t('GD library'); + } + + return $requirements; +} diff -r 5a113a1c4740 -r c1f4ac30525a modules/color/color.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/color/color.js Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,251 @@ +// $Id: color.js,v 1.6 2007/09/12 18:29:32 goba Exp $ + +Drupal.behaviors.color = function (context) { + // This behavior attaches by ID, so is only valid once on a page. + if ($('#color_scheme_form .color-form.color-processed').size()) { + return; + } + var form = $('#color_scheme_form .color-form', context); + var inputs = []; + var hooks = []; + var locks = []; + var focused = null; + + // Add Farbtastic + $(form).prepend('

').addClass('color-processed'); + var farb = $.farbtastic('#placeholder'); + + // Decode reference colors to HSL + var reference = Drupal.settings.color.reference; + for (i in reference) { + reference[i] = farb.RGBToHSL(farb.unpack(reference[i])); + } + + // Build preview + $('#preview:not(.color-processed)') + .append('

') + .addClass('color-processed'); + var gradient = $('#preview #gradient'); + var h = parseInt(gradient.css('height')) / 10; + for (i = 0; i < h; ++i) { + gradient.append('

'); + } + + // Fix preview background in IE6 + if (navigator.appVersion.match(/MSIE [0-6]\./)) { + var e = $('#preview #img')[0]; + var image = e.currentStyle.backgroundImage; + e.style.backgroundImage = 'none'; + e.style.filter = "progid:DXImageTransform.Microsoft.AlphaImageLoader(enabled=true, sizingMethod=crop, src='" + image.substring(5, image.length - 2) + "')"; + } + + // Set up colorscheme selector + $('#edit-scheme', form).change(function () { + var colors = this.options[this.selectedIndex].value; + if (colors != '') { + colors = colors.split(','); + for (i in colors) { + callback(inputs[i], colors[i], false, true); + } + preview(); + } + }); + + /** + * Render the preview. + */ + function preview() { + // Solid background + $('#preview', form).css('backgroundColor', inputs[0].value); + + // Text preview + $('#text', form).css('color', inputs[4].value); + $('#text a, #text h2', form).css('color', inputs[1].value); + + // Set up gradient + var top = farb.unpack(inputs[2].value); + var bottom = farb.unpack(inputs[3].value); + if (top && bottom) { + var delta = []; + for (i in top) { + delta[i] = (bottom[i] - top[i]) / h; + } + var accum = top; + + // Render gradient lines + $('#gradient > div', form).each(function () { + for (i in accum) { + accum[i] += delta[i]; + } + this.style.backgroundColor = farb.pack(accum); + }); + } + } + + /** + * Shift a given color, using a reference pair (ref in HSL). + * + * This algorithm ensures relative ordering on the saturation and luminance + * axes is preserved, and performs a simple hue shift. + * + * It is also symmetrical. If: shift_color(c, a, b) == d, + * then shift_color(d, b, a) == c. + */ + function shift_color(given, ref1, ref2) { + // Convert to HSL + given = farb.RGBToHSL(farb.unpack(given)); + + // Hue: apply delta + given[0] += ref2[0] - ref1[0]; + + // Saturation: interpolate + if (ref1[1] == 0 || ref2[1] == 0) { + given[1] = ref2[1]; + } + else { + var d = ref1[1] / ref2[1]; + if (d > 1) { + given[1] /= d; + } + else { + given[1] = 1 - (1 - given[1]) * d; + } + } + + // Luminance: interpolate + if (ref1[2] == 0 || ref2[2] == 0) { + given[2] = ref2[2]; + } + else { + var d = ref1[2] / ref2[2]; + if (d > 1) { + given[2] /= d; + } + else { + given[2] = 1 - (1 - given[2]) * d; + } + } + + return farb.pack(farb.HSLToRGB(given)); + } + + /** + * Callback for Farbtastic when a new color is chosen. + */ + function callback(input, color, propagate, colorscheme) { + // Set background/foreground color + $(input).css({ + backgroundColor: color, + 'color': farb.RGBToHSL(farb.unpack(color))[2] > 0.5 ? '#000' : '#fff' + }); + + // Change input value + if (input.value && input.value != color) { + input.value = color; + + // Update locked values + if (propagate) { + var i = input.i; + for (j = i + 1; ; ++j) { + if (!locks[j - 1] || $(locks[j - 1]).is('.unlocked')) break; + var matched = shift_color(color, reference[input.key], reference[inputs[j].key]); + callback(inputs[j], matched, false); + } + for (j = i - 1; ; --j) { + if (!locks[j] || $(locks[j]).is('.unlocked')) break; + var matched = shift_color(color, reference[input.key], reference[inputs[j].key]); + callback(inputs[j], matched, false); + } + + // Update preview + preview(); + } + + // Reset colorscheme selector + if (!colorscheme) { + resetScheme(); + } + } + + } + + /** + * Reset the color scheme selector. + */ + function resetScheme() { + $('#edit-scheme', form).each(function () { + this.selectedIndex = this.options.length - 1; + }); + } + + // Focus the Farbtastic on a particular field. + function focus() { + var input = this; + // Remove old bindings + focused && $(focused).unbind('keyup', farb.updateValue) + .unbind('keyup', preview).unbind('keyup', resetScheme) + .parent().removeClass('item-selected'); + + // Add new bindings + focused = this; + farb.linkTo(function (color) { callback(input, color, true, false); }); + farb.setColor(this.value); + $(focused).keyup(farb.updateValue).keyup(preview).keyup(resetScheme) + .parent().addClass('item-selected'); + } + + // Initialize color fields + $('#palette input.form-text', form) + .each(function () { + // Extract palette field name + this.key = this.id.substring(13); + + // Link to color picker temporarily to initialize. + farb.linkTo(function () {}).setColor('#000').linkTo(this); + + // Add lock + var i = inputs.length; + if (inputs.length) { + var lock = $('

').toggle( + function () { + $(this).addClass('unlocked'); + $(hooks[i - 1]).attr('class', + locks[i - 2] && $(locks[i - 2]).is(':not(.unlocked)') ? 'hook up' : 'hook' + ); + $(hooks[i]).attr('class', + locks[i] && $(locks[i]).is(':not(.unlocked)') ? 'hook down' : 'hook' + ); + }, + function () { + $(this).removeClass('unlocked'); + $(hooks[i - 1]).attr('class', + locks[i - 2] && $(locks[i - 2]).is(':not(.unlocked)') ? 'hook both' : 'hook down' + ); + $(hooks[i]).attr('class', + locks[i] && $(locks[i]).is(':not(.unlocked)') ? 'hook both' : 'hook up' + ); + } + ); + $(this).after(lock); + locks.push(lock); + }; + + // Add hook + var hook = $('

'); + $(this).after(hook); + hooks.push(hook); + + $(this).parent().find('.lock').click(); + this.i = i; + inputs.push(this); + }) + .focus(focus); + + $('#palette label', form); + + // Focus first color + focus.call(inputs[0]); + + // Render preview + preview(); +}; diff -r 5a113a1c4740 -r c1f4ac30525a modules/color/color.module --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/color/color.module Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,673 @@ +'. t('The color module allows a site administrator to quickly and easily change the color scheme of certain themes. Although not all themes support color module, both Garland (the default theme) and Minnelli were designed to take advantage of its features. By using color module with a compatible theme, you can easily change the color of links, backgrounds, text, and other theme elements. Color module requires that your file download method be set to public.', array('@url' => url('admin/settings/file-system'))) .'

'; + $output .= '

'. t("It is important to remember that color module saves a modified copy of the theme's specified stylesheets in the files directory. This means that if you make any manual changes to your theme's stylesheet, you must save your color settings again, even if they haven't changed. This causes the color module generated version of the stylesheets in the files directory to be recreated using the new version of the original file.") .'

'; + $output .= '

'. t('To change the color settings for a compatible theme, select the "configure" link for the theme on the themes administration page.', array('@themes' => url('admin/build/themes'))) .'

'; + $output .= '

'. t('For more information, see the online handbook entry for Color module.', array('@color' => 'http://drupal.org/handbook/modules/color/')) .'

'; + return $output; + } +} + +/** + * Implementation of hook_theme(). + */ +function color_theme() { + return array( + 'color_scheme_form' => array( + 'arguments' => array('form' => NULL), + ), + ); +} + +/** + * Implementation of hook_form_alter(). + */ +function color_form_alter(&$form, $form_state, $form_id) { + // Insert the color changer into the theme settings page. + if ($form_id == 'system_theme_settings' && color_get_info(arg(4)) && function_exists('gd_info')) { + if (variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC) != FILE_DOWNLOADS_PUBLIC) { + // Disables the color changer when the private download method is used. + // TODO: This should be solved in a different way. See issue #181003. + drupal_set_message(t('The color picker only works if the download method is set to public.', array('@url' => url('admin/settings/file-system'))), 'warning'); + } + else { + $form['color'] = array( + '#type' => 'fieldset', + '#title' => t('Color scheme'), + '#weight' => -1, + '#attributes' => array('id' => 'color_scheme_form'), + '#theme' => 'color_scheme_form', + ); + $form['color'] += color_scheme_form($form_state, arg(4)); + $form['#submit'][] = 'color_scheme_form_submit'; + } + } + + // Use the generated screenshot in the theme list. + if ($form_id == 'system_theme_select_form' || $form_id == 'system_themes') { + $themes = list_themes(); + foreach (element_children($form) as $theme) { + if ($screenshot = variable_get('color_'. $theme .'_screenshot', NULL)) { + if (isset($form[$theme]['screenshot'])) { + $form[$theme]['screenshot']['#value'] = theme('image', $screenshot, '', '', array('class' => 'screenshot'), FALSE); + } + } + } + } +} + +/** + * Callback for the theme to alter the resources used. + */ +function _color_page_alter(&$vars) { + global $language, $theme_key; + + // Override stylesheets. + $color_paths = variable_get('color_'. $theme_key .'_stylesheets', array()); + if (!empty($color_paths)) { + // Loop over theme CSS files and try to rebuild CSS array with rewritten + // stylesheets. Keep the orginal order intact for CSS cascading. + $new_theme_css = array(); + + foreach ($vars['css']['all']['theme'] as $old_path => $old_preprocess) { + // Add the non-colored stylesheet first as we might not find a + // re-colored stylesheet for replacement later. + $new_theme_css[$old_path] = $old_preprocess; + + // Loop over the path array with recolored CSS files to find matching + // paths which could replace the non-recolored paths. + foreach ($color_paths as $color_path) { + // Color module currently requires unique file names to be used, + // which allows us to compare different file paths. + if (basename($old_path) == basename($color_path)) { + // Pull out the non-colored and add rewritten stylesheet. + unset($new_theme_css[$old_path]); + $new_theme_css[$color_path] = $old_preprocess; + + // If the current language is RTL and the CSS file had an RTL variant, + // pull out the non-colored and add rewritten RTL stylesheet. + if (defined('LANGUAGE_RTL') && $language->direction == LANGUAGE_RTL) { + $rtl_old_path = str_replace('.css', '-rtl.css', $old_path); + $rtl_color_path = str_replace('.css', '-rtl.css', $color_path); + if (file_exists($rtl_color_path)) { + unset($new_theme_css[$rtl_old_path]); + $new_theme_css[$rtl_color_path] = $old_preprocess; + } + } + break; + } + } + } + $vars['css']['all']['theme'] = $new_theme_css; + $vars['styles'] = drupal_get_css($vars['css']); + } + + // Override logo. + $logo = variable_get('color_'. $theme_key .'_logo', NULL); + if ($logo && $vars['logo'] && preg_match('!'. $theme_key .'/logo.png$!', $vars['logo'])) { + $vars['logo'] = base_path() . $logo; + } +} + +/** + * Retrieve the color.module info for a particular theme. + */ +function color_get_info($theme) { + $path = drupal_get_path('theme', $theme); + $file = $path .'/color/color.inc'; + if ($path && file_exists($file)) { + include $file; + return $info; + } +} + +/** + * Helper function to retrieve the color palette for a particular theme. + */ +function color_get_palette($theme, $default = false) { + // Fetch and expand default palette + $fields = array('base', 'link', 'top', 'bottom', 'text'); + $info = color_get_info($theme); + $keys = array_keys($info['schemes']); + foreach (explode(',', array_shift($keys)) as $k => $scheme) { + $palette[$fields[$k]] = $scheme; + } + + // Load variable + return $default ? $palette : variable_get('color_'. $theme .'_palette', $palette); +} + +/** + * Form callback. Returns the configuration form. + */ +function color_scheme_form(&$form_state, $theme) { + $base = drupal_get_path('module', 'color'); + $info = color_get_info($theme); + + // Add Farbtastic color picker + drupal_add_css('misc/farbtastic/farbtastic.css', 'module', 'all', FALSE); + drupal_add_js('misc/farbtastic/farbtastic.js'); + + // Add custom CSS/JS + drupal_add_css($base .'/color.css', 'module', 'all', FALSE); + drupal_add_js($base .'/color.js'); + drupal_add_js(array('color' => array( + 'reference' => color_get_palette($theme, true) + )), 'setting'); + + // See if we're using a predefined scheme + $current = implode(',', variable_get('color_'. $theme .'_palette', array())); + // Note: we use the original theme when the default scheme is chosen. + $current = isset($info['schemes'][$current]) ? $current : ($current == '' ? reset($info['schemes']) : ''); + + // Add scheme selector + $info['schemes'][''] = t('Custom'); + $form['scheme'] = array( + '#type' => 'select', + '#title' => t('Color set'), + '#options' => $info['schemes'], + '#default_value' => $current, + ); + + // Add palette fields + $palette = color_get_palette($theme); + $names = array( + 'base' => t('Base color'), + 'link' => t('Link color'), + 'top' => t('Header top'), + 'bottom' => t('Header bottom'), + 'text' => t('Text color') + ); + $form['palette']['#tree'] = true; + foreach ($palette as $name => $value) { + $form['palette'][$name] = array( + '#type' => 'textfield', + '#title' => $names[$name], + '#default_value' => $value, + '#size' => 8, + ); + } + $form['theme'] = array('#type' => 'value', '#value' => arg(4)); + $form['info'] = array('#type' => 'value', '#value' => $info); + + return $form; +} + +/** + * Theme color form. + * + * @ingroup @themeable + */ +function theme_color_scheme_form($form) { + // Include stylesheet + $theme = $form['theme']['#value']; + $info = $form['info']['#value']; + $path = drupal_get_path('theme', $theme) .'/'; + drupal_add_css($path . $info['preview_css']); + $output = ''; + // Wrapper + $output .= '

'; + + // Color schemes + $output .= drupal_render($form['scheme']); + + // Palette + $output .= '

'; + foreach (element_children($form['palette']) as $name) { + $output .= drupal_render($form['palette'][$name]); + } + $output .= '

'; + + // Preview + $output .= drupal_render($form); + $output .= '

'. t('Preview') .'

'; + $output .= '

Lorem ipsum dolor

Sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

'; + + // Close wrapper + $output .= '

'; + + return $output; +} + +/** + * Submit handler for color change form. + */ +function color_scheme_form_submit($form, &$form_state) { + // Get theme coloring info + if (!isset($form_state['values']['info'])) { + return; + } + $theme = $form_state['values']['theme']; + $info = $form_state['values']['info']; + + // Resolve palette + $palette = $form_state['values']['palette']; + if ($form_state['values']['scheme'] != '') { + $scheme = explode(',', $form_state['values']['scheme']); + foreach ($palette as $k => $color) { + $palette[$k] = array_shift($scheme); + } + } + + // Make sure enough memory is available, if PHP's memory limit is compiled in. + if (function_exists('memory_get_usage')) { + // Fetch source image dimensions. + $source = drupal_get_path('theme', $theme) .'/'. $info['base_image']; + list($width, $height) = getimagesize($source); + + // We need at least a copy of the source and a target buffer of the same + // size (both at 32bpp). + $required = $width * $height * 8; + $usage = memory_get_usage(); + $limit = parse_size(ini_get('memory_limit')); + if ($usage + $required > $limit) { + drupal_set_message(t('There is not enough memory available to PHP to change this theme\'s color scheme. You need at least %size more. Check the PHP documentation for more information.', array('%size' => format_size($usage + $required - $limit), '@url' => 'http://www.php.net/manual/en/ini.core.php#ini.sect.resource-limits')), 'error'); + return; + } + } + + // Delete old files + foreach (variable_get('color_'. $theme .'_files', array()) as $file) { + @unlink($file); + } + if (isset($file) && $file = dirname($file)) { + @rmdir($file); + } + + // Don't render the default colorscheme, use the standard theme instead. + if (implode(',', color_get_palette($theme, true)) == implode(',', $palette) + || $form_state['values']['op'] == t('Reset to defaults')) { + variable_del('color_'. $theme .'_palette'); + variable_del('color_'. $theme .'_stylesheets'); + variable_del('color_'. $theme .'_logo'); + variable_del('color_'. $theme .'_files'); + variable_del('color_'. $theme .'_screenshot'); + return; + } + + // Prepare target locations for generated files. + $id = $theme .'-'. substr(md5(serialize($palette) . microtime()), 0, 8); + $paths['color'] = file_directory_path() .'/color'; + $paths['target'] = $paths['color'] .'/'. $id; + foreach ($paths as $path) { + file_check_directory($path, FILE_CREATE_DIRECTORY); + } + $paths['target'] = $paths['target'] .'/'; + $paths['id'] = $id; + $paths['source'] = drupal_get_path('theme', $theme) .'/'; + $paths['files'] = $paths['map'] = array(); + + // Save palette and logo location. + variable_set('color_'. $theme .'_palette', $palette); + variable_set('color_'. $theme .'_logo', $paths['target'] .'logo.png'); + + // Copy over neutral images. + foreach ($info['copy'] as $file) { + $base = basename($file); + $source = $paths['source'] . $file; + file_copy($source, $paths['target'] . $base); + $paths['map'][$file] = $base; + $paths['files'][] = $paths['target'] . $base; + } + + // Render new images, if image provided. + if ($info['base_image']) { + _color_render_images($theme, $info, $paths, $palette); + } + + // Rewrite theme stylesheets. + $css = array(); + foreach ($info['css'] as $stylesheet) { + // Build a temporary array with LTR and RTL files. + $files = array(); + if (file_exists($paths['source'] . $stylesheet)) { + $files[] = $stylesheet; + + $rtl_file = str_replace('.css', '-rtl.css', $stylesheet); + if (file_exists($paths['source'] . $rtl_file)) { + $files[] = $rtl_file; + } + } + + foreach ($files as $file) { + // Aggregate @imports recursively for each configured top level CSS file + // without optimization. Aggregation and optimization will be + // handled by drupal_build_css_cache() only. + $style = drupal_load_stylesheet($paths['source'] . $file, FALSE); + + // Return the path to where this CSS file originated from, stripping + // off the name of the file at the end of the path. + $base = base_path() . dirname($paths['source'] . $file) .'/'; + _drupal_build_css_path(NULL, $base); + + // Prefix all paths within this CSS file, ignoring absolute paths. + $style = preg_replace_callback('/url$[\'"]?(?![a-z]+:|\/+)([^\'")]+)[\'"]?$/i', '_drupal_build_css_path', $style); + + // Rewrite stylesheet with new colors. + $style = _color_rewrite_stylesheet($theme, $info, $paths, $palette, $style); + $base_file = basename($file); + $css[] = $paths['target'] . $base_file; + _color_save_stylesheet($paths['target'] . $base_file, $style, $paths); + } + } + + // Maintain list of files. + variable_set('color_'. $theme .'_stylesheets', $css); + variable_set('color_'. $theme .'_files', $paths['files']); +} + +/** + * Rewrite the stylesheet to match the colors in the palette. + */ +function _color_rewrite_stylesheet($theme, &$info, &$paths, $palette, $style) { + $themes = list_themes(); + + // Prepare color conversion table + $conversion = $palette; + unset($conversion['base']); + foreach ($conversion as $k => $v) { + $conversion[$k] = drupal_strtolower($v); + } + $default = color_get_palette($theme, true); + + // Split off the "Don't touch" section of the stylesheet. + $split = "Color Module: Don't touch"; + if (strpos($style, $split) !== FALSE) { + list($style, $fixed) = explode($split, $style); + } + + // Find all colors in the stylesheet and the chunks in between. + $style = preg_split('/(#[0-9a-f]{6}|#[0-9a-f]{3})/i', $style, -1, PREG_SPLIT_DELIM_CAPTURE); + $is_color = false; + $output = ''; + $base = 'base'; + + // Iterate over all parts. + foreach ($style as $chunk) { + if ($is_color) { + $chunk = drupal_strtolower($chunk); + // Check if this is one of the colors in the default palette. + if ($key = array_search($chunk, $default)) { + $chunk = $conversion[$key]; + } + // Not a pre-set color. Extrapolate from the base. + else { + $chunk = _color_shift($palette[$base], $default[$base], $chunk, $info['blend_target']); + } + } + else { + // Determine the most suitable base color for the next color. + + // 'a' declarations. Use link. + if (preg_match('@[^a-z0-9_-](a)[^a-z0-9_-][^/{]*{[^{]+$@i', $chunk)) { + $base = 'link'; + } + // 'color:' styles. Use text. + else if (preg_match('/(? $after) { + $before = base_path() . $paths['source'] . $before; + $before = preg_replace('`(^|/)(?!../)([^/]+)/../`', '$1', $before); + $output = str_replace($before, $after, $output); + } + + return $output; +} + +/** + * Save the rewritten stylesheet to disk. + */ +function _color_save_stylesheet($file, $style, &$paths) { + + // Write new stylesheet. + file_save_data($style, $file, FILE_EXISTS_REPLACE); + $paths['files'][] = $file; + + // Set standard file permissions for webserver-generated files. + @chmod($file, 0664); +} + +/** + * Render images that match a given palette. + */ +function _color_render_images($theme, &$info, &$paths, $palette) { + + // Prepare template image. + $source = $paths['source'] .'/'. $info['base_image']; + $source = imagecreatefrompng($source); + $width = imagesx($source); + $height = imagesy($source); + + // Prepare target buffer. + $target = imagecreatetruecolor($width, $height); + imagealphablending($target, true); + + // Fill regions of solid color. + foreach ($info['fill'] as $color => $fill) { + imagefilledrectangle($target, $fill[0], $fill[1], $fill[0] + $fill[2], $fill[1] + $fill[3], _color_gd($target, $palette[$color])); + } + + // Render gradient. + for ($y = 0; $y < $info['gradient'][3]; ++$y) { + $color = _color_blend($target, $palette['top'], $palette['bottom'], $y / ($info['gradient'][3] - 1)); + imagefilledrectangle($target, $info['gradient'][0], $info['gradient'][1] + $y, $info['gradient'][0] + $info['gradient'][2], $info['gradient'][1] + $y + 1, $color); + } + + // Blend over template. + imagecopy($target, $source, 0, 0, 0, 0, $width, $height); + + // Clean up template image. + imagedestroy($source); + + // Cut out slices. + foreach ($info['slices'] as $file => $coord) { + list($x, $y, $width, $height) = $coord; + $base = basename($file); + $image = $paths['target'] . $base; + + // Cut out slice. + if ($file == 'screenshot.png') { + $slice = imagecreatetruecolor(150, 90); + imagecopyresampled($slice, $target, 0, 0, $x, $y, 150, 90, $width, $height); + variable_set('color_'. $theme .'_screenshot', $image); + } + else { + $slice = imagecreatetruecolor($width, $height); + imagecopy($slice, $target, 0, 0, $x, $y, $width, $height); + } + + // Save image. + imagepng($slice, $image); + imagedestroy($slice); + $paths['files'][] = $image; + + // Set standard file permissions for webserver-generated files + @chmod(realpath($image), 0664); + + // Build before/after map of image paths. + $paths['map'][$file] = $base; + } + + // Clean up target buffer. + imagedestroy($target); +} + +/** + * Shift a given color, using a reference pair and a target blend color. + * + * Note: this function is significantly different from the JS version, as it + * is written to match the blended images perfectly. + * + * Constraint: if (ref2 == target + (ref1 - target) * delta) for some fraction delta + * then (return == target + (given - target) * delta) + * + * Loose constraint: Preserve relative positions in saturation and luminance + * space. + */ +function _color_shift($given, $ref1, $ref2, $target) { + + // We assume that ref2 is a blend of ref1 and target and find + // delta based on the length of the difference vectors: + + // delta = 1 - |ref2 - ref1| / |white - ref1| + $target = _color_unpack($target, true); + $ref1 = _color_unpack($ref1, true); + $ref2 = _color_unpack($ref2, true); + $numerator = 0; + $denominator = 0; + for ($i = 0; $i < 3; ++$i) { + $numerator += ($ref2[$i] - $ref1[$i]) * ($ref2[$i] - $ref1[$i]); + $denominator += ($target[$i] - $ref1[$i]) * ($target[$i] - $ref1[$i]); + } + $delta = ($denominator > 0) ? (1 - sqrt($numerator / $denominator)) : 0; + + // Calculate the color that ref2 would be if the assumption was true. + for ($i = 0; $i < 3; ++$i) { + $ref3[$i] = $target[$i] + ($ref1[$i] - $target[$i]) * $delta; + } + + // If the assumption is not true, there is a difference between ref2 and ref3. + // We measure this in HSL space. Notation: x' = hsl(x). + $ref2 = _color_rgb2hsl($ref2); + $ref3 = _color_rgb2hsl($ref3); + for ($i = 0; $i < 3; ++$i) { + $shift[$i] = $ref2[$i] - $ref3[$i]; + } + + // Take the given color, and blend it towards the target. + $given = _color_unpack($given, true); + for ($i = 0; $i < 3; ++$i) { + $result[$i] = $target[$i] + ($given[$i] - $target[$i]) * $delta; + } + + // Finally, we apply the extra shift in HSL space. + // Note: if ref2 is a pure blend of ref1 and target, then |shift| = 0. + $result = _color_rgb2hsl($result); + for ($i = 0; $i < 3; ++$i) { + $result[$i] = min(1, max(0, $result[$i] + $shift[$i])); + } + $result = _color_hsl2rgb($result); + + // Return hex color. + return _color_pack($result, true); +} + +/** + * Convert a hex triplet into a GD color. + */ +function _color_gd($img, $hex) { + $c = array_merge(array($img), _color_unpack($hex)); + return call_user_func_array('imagecolorallocate', $c); +} + +/** + * Blend two hex colors and return the GD color. + */ +function _color_blend($img, $hex1, $hex2, $alpha) { + $in1 = _color_unpack($hex1); + $in2 = _color_unpack($hex2); + $out = array($img); + for ($i = 0; $i < 3; ++$i) { + $out[] = $in1[$i] + ($in2[$i] - $in1[$i]) * $alpha; + } + return call_user_func_array('imagecolorallocate', $out); +} + +/** + * Convert a hex color into an RGB triplet. + */ +function _color_unpack($hex, $normalize = false) { + if (strlen($hex) == 4) { + $hex = $hex[1] . $hex[1] . $hex[2] . $hex[2] . $hex[3] . $hex[3]; + } + $c = hexdec($hex); + for ($i = 16; $i >= 0; $i -= 8) { + $out[] = (($c >> $i) & 0xFF) / ($normalize ? 255 : 1); + } + return $out; +} + +/** + * Convert an RGB triplet to a hex color. + */ +function _color_pack($rgb, $normalize = false) { + $out = 0; + foreach ($rgb as $k => $v) { + $out |= (($v * ($normalize ? 255 : 1)) << (16 - $k * 8)); + } + return '#'. str_pad(dechex($out), 6, 0, STR_PAD_LEFT); +} + +/** + * Convert a HSL triplet into RGB + */ +function _color_hsl2rgb($hsl) { + $h = $hsl[0]; + $s = $hsl[1]; + $l = $hsl[2]; + $m2 = ($l <= 0.5) ? $l * ($s + 1) : $l + $s - $l*$s; + $m1 = $l * 2 - $m2; + return array( + _color_hue2rgb($m1, $m2, $h + 0.33333), + _color_hue2rgb($m1, $m2, $h), + _color_hue2rgb($m1, $m2, $h - 0.33333), + ); +} + +/** + * Helper function for _color_hsl2rgb(). + */ +function _color_hue2rgb($m1, $m2, $h) { + $h = ($h < 0) ? $h + 1 : (($h > 1) ? $h - 1 : $h); + if ($h * 6 < 1) return $m1 + ($m2 - $m1) * $h * 6; + if ($h * 2 < 1) return $m2; + if ($h * 3 < 2) return $m1 + ($m2 - $m1) * (0.66666 - $h) * 6; + return $m1; +} + +/** + * Convert an RGB triplet to HSL. + */ +function _color_rgb2hsl($rgb) { + $r = $rgb[0]; + $g = $rgb[1]; + $b = $rgb[2]; + $min = min($r, min($g, $b)); + $max = max($r, max($g, $b)); + $delta = $max - $min; + $l = ($min + $max) / 2; + $s = 0; + if ($l > 0 && $l < 1) { + $s = $delta / ($l < 0.5 ? (2 * $l) : (2 - 2 * $l)); + } + $h = 0; + if ($delta > 0) { + if ($max == $r && $max != $g) $h += ($g - $b) / $delta; + if ($max == $g && $max != $b) $h += (2 + ($b - $r) / $delta); + if ($max == $b && $max != $r) $h += (4 + ($r - $g) / $delta); + $h /= 6; + } + return array($h, $s, $l); +} diff -r 5a113a1c4740 -r c1f4ac30525a modules/color/images/hook-rtl.png Binary file modules/color/images/hook-rtl.png has changed diff -r 5a113a1c4740 -r c1f4ac30525a modules/color/images/hook.png Binary file modules/color/images/hook.png has changed diff -r 5a113a1c4740 -r c1f4ac30525a modules/color/images/lock.png Binary file modules/color/images/lock.png has changed diff -r 5a113a1c4740 -r c1f4ac30525a modules/comment/comment-folded.tpl.php --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/comment/comment-folded.tpl.php Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,21 @@ + +

+ +

diff -r 5a113a1c4740 -r c1f4ac30525a modules/comment/comment-rtl.css --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/comment/comment-rtl.css Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,6 @@ +/* $Id: comment-rtl.css,v 1.2 2007/11/27 12:09:25 goba Exp $ */ + +.indented { + margin-left: 0; + margin-right: 25px; +} diff -r 5a113a1c4740 -r c1f4ac30525a modules/comment/comment-wrapper.tpl.php --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/comment/comment-wrapper.tpl.php Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,36 @@ + +

+ +

diff -r 5a113a1c4740 -r c1f4ac30525a modules/comment/comment.admin.inc --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/comment/comment.admin.inc Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,296 @@ + 'fieldset', '#title' => t('Update options'), + '#prefix' => '

', '#suffix' => '

' + ); + $options = array(); + foreach (comment_operations($arg == 'approval' ? 'publish' : 'unpublish') as $key => $value) { + $options[$key] = $value[0]; + } + $form['options']['operation'] = array('#type' => 'select', '#options' => $options, '#default_value' => 'publish'); + $form['options']['submit'] = array('#type' => 'submit', '#value' => t('Update')); + + // load the comments that we want to display + $status = ($arg == 'approval') ? COMMENT_NOT_PUBLISHED : COMMENT_PUBLISHED; + $form['header'] = array('#type' => 'value', '#value' => array( + theme('table_select_header_cell'), + array('data' => t('Subject'), 'field' => 'subject'), + array('data' => t('Author'), 'field' => 'name'), + array('data' => t('Posted in'), 'field' => 'node_title'), + array('data' => t('Time'), 'field' => 'timestamp', 'sort' => 'desc'), + array('data' => t('Operations')) + )); + $result = pager_query('SELECT c.subject, c.nid, c.cid, c.comment, c.timestamp, c.status, c.name, c.homepage, u.name AS registered_name, u.uid, n.title as node_title FROM {comments} c INNER JOIN {users} u ON u.uid = c.uid INNER JOIN {node} n ON n.nid = c.nid WHERE c.status = %d'. tablesort_sql($form['header']['#value']), 50, 0, NULL, $status); + + // build a table listing the appropriate comments + $destination = drupal_get_destination(); + while ($comment = db_fetch_object($result)) { + $comments[$comment->cid] = ''; + $comment->name = $comment->uid ? $comment->registered_name : $comment->name; + $form['subject'][$comment->cid] = array('#value' => l($comment->subject, 'node/'. $comment->nid, array('title' => truncate_utf8($comment->comment, 128), 'fragment' => 'comment-'. $comment->cid))); + $form['username'][$comment->cid] = array('#value' => theme('username', $comment)); + $form['node_title'][$comment->cid] = array('#value' => l($comment->node_title, 'node/'. $comment->nid)); + $form['timestamp'][$comment->cid] = array('#value' => format_date($comment->timestamp, 'small')); + $form['operations'][$comment->cid] = array('#value' => l(t('edit'), 'comment/edit/'. $comment->cid, array('query' => $destination))); + } + $form['comments'] = array('#type' => 'checkboxes', '#options' => isset($comments) ? $comments: array()); + $form['pager'] = array('#value' => theme('pager', NULL, 50, 0)); + return $form; +} + +/** + * Validate comment_admin_overview form submissions. + * + * We can't execute any 'Update options' if no comments were selected. + */ +function comment_admin_overview_validate($form, &$form_state) { + $form_state['values']['comments'] = array_diff($form_state['values']['comments'], array(0)); + if (count($form_state['values']['comments']) == 0) { + form_set_error('', t('Please select one or more comments to perform the update on.')); + drupal_goto('admin/content/comment'); + } +} + +/** + * Process comment_admin_overview form submissions. + * + * Execute the chosen 'Update option' on the selected comments, such as + * publishing, unpublishing or deleting. + */ +function comment_admin_overview_submit($form, &$form_state) { + $operations = comment_operations(); + if ($operations[$form_state['values']['operation']][1]) { + // extract the appropriate database query operation + $query = $operations[$form_state['values']['operation']][1]; + foreach ($form_state['values']['comments'] as $cid => $value) { + if ($value) { + // perform the update action, then refresh node statistics + db_query($query, $cid); + $comment = _comment_load($cid); + _comment_update_node_statistics($comment->nid); + // Allow modules to respond to the updating of a comment. + comment_invoke_comment($comment, $form_state['values']['operation']); + // Add an entry to the watchdog log. + watchdog('content', 'Comment: updated %subject.', array('%subject' => $comment->subject), WATCHDOG_NOTICE, l(t('view'), 'node/'. $comment->nid, array('fragment' => 'comment-'. $comment->cid))); + } + } + cache_clear_all(); + drupal_set_message(t('The update has been performed.')); + $form_state['redirect'] = 'admin/content/comment'; + } +} + +/** + * Theme the comment admin form. + * + * @param $form + * An associative array containing the structure of the form. + * @ingroup themeable + */ +function theme_comment_admin_overview($form) { + $output = drupal_render($form['options']); + if (isset($form['subject']) && is_array($form['subject'])) { + foreach (element_children($form['subject']) as $key) { + $row = array(); + $row[] = drupal_render($form['comments'][$key]); + $row[] = drupal_render($form['subject'][$key]); + $row[] = drupal_render($form['username'][$key]); + $row[] = drupal_render($form['node_title'][$key]); + $row[] = drupal_render($form['timestamp'][$key]); + $row[] = drupal_render($form['operations'][$key]); + $rows[] = $row; + } + } + else { + $rows[] = array(array('data' => t('No comments available.'), 'colspan' => '6')); + } + + $output .= theme('table', $form['header']['#value'], $rows); + if ($form['pager']['#value']) { + $output .= drupal_render($form['pager']); + } + + $output .= drupal_render($form); + + return $output; +} + +/** + * List the selected comments and verify that the admin really wants to delete + * them. + * + * @param $form_state + * An associative array containing the current state of the form. + * @return + * TRUE if the comments should be deleted, FALSE otherwise. + * @ingroup forms + * @see comment_multiple_delete_confirm_submit() + */ +function comment_multiple_delete_confirm(&$form_state) { + $edit = $form_state['post']; + + $form['comments'] = array('#prefix' => '

', '#suffix' => '', '#tree' => TRUE); + // array_filter() returns only elements with actual values + $comment_counter = 0; + foreach (array_filter($edit['comments']) as $cid => $value) { + $comment = _comment_load($cid); + if (is_object($comment) && is_numeric($comment->cid)) { + $subject = db_result(db_query('SELECT subject FROM {comments} WHERE cid = %d', $cid)); + $form['comments'][$cid] = array('#type' => 'hidden', '#value' => $cid, '#prefix' => '

', '#suffix' => check_plain($subject) .'

'); + $comment_counter++; + } + } + $form['operation'] = array('#type' => 'hidden', '#value' => 'delete'); + + if (!$comment_counter) { + drupal_set_message(t('There do not appear to be any comments to delete or your selected comment was deleted by another administrator.')); + drupal_goto('admin/content/comment'); + } + else { + return confirm_form($form, + t('Are you sure you want to delete these comments and all their children?'), + 'admin/content/comment', t('This action cannot be undone.'), + t('Delete comments'), t('Cancel')); + } +} + +/** + * Process comment_multiple_delete_confirm form submissions. + * + * Perform the actual comment deletion. + */ +function comment_multiple_delete_confirm_submit($form, &$form_state) { + if ($form_state['values']['confirm']) { + foreach ($form_state['values']['comments'] as $cid => $value) { + $comment = _comment_load($cid); + _comment_delete_thread($comment); + _comment_update_node_statistics($comment->nid); + } + cache_clear_all(); + drupal_set_message(t('The comments have been deleted.')); + } + $form_state['redirect'] = 'admin/content/comment'; +} + +/** + * Menu callback; delete a comment. + * + * @param $cid + * The comment do be deleted. + */ +function comment_delete($cid = NULL) { + $comment = db_fetch_object(db_query('SELECT c.*, u.name AS registered_name, u.uid FROM {comments} c INNER JOIN {users} u ON u.uid = c.uid WHERE c.cid = %d', $cid)); + $comment->name = $comment->uid ? $comment->registered_name : $comment->name; + + $output = ''; + + if (is_object($comment) && is_numeric($comment->cid)) { + $output = drupal_get_form('comment_confirm_delete', $comment); + } + else { + drupal_set_message(t('The comment no longer exists.')); + } + + return $output; +} + +/** + * Form builder; Builds the confirmation form for deleting a single comment. + * + * @ingroup forms + * @see comment_confirm_delete_submit() + */ +function comment_confirm_delete(&$form_state, $comment) { + $form = array(); + $form['#comment'] = $comment; + return confirm_form( + $form, + t('Are you sure you want to delete the comment %title?', array('%title' => $comment->subject)), + 'node/'. $comment->nid, + t('Any replies to this comment will be lost. This action cannot be undone.'), + t('Delete'), + t('Cancel'), + 'comment_confirm_delete'); +} + +/** + * Process comment_confirm_delete form submissions. + */ +function comment_confirm_delete_submit($form, &$form_state) { + drupal_set_message(t('The comment and all its replies have been deleted.')); + + $comment = $form['#comment']; + + // Delete comment and its replies. + _comment_delete_thread($comment); + + _comment_update_node_statistics($comment->nid); + + // Clear the cache so an anonymous user sees that his comment was deleted. + cache_clear_all(); + + $form_state['redirect'] = "node/$comment->nid"; +} + +/** + * Perform the actual deletion of a comment and all its replies. + * + * @param $comment + * An associative array describing the comment to be deleted. + */ +function _comment_delete_thread($comment) { + if (!is_object($comment) || !is_numeric($comment->cid)) { + watchdog('content', 'Cannot delete non-existent comment.', WATCHDOG_WARNING); + return; + } + + // Delete the comment: + db_query('DELETE FROM {comments} WHERE cid = %d', $comment->cid); + watchdog('content', 'Comment: deleted %subject.', array('%subject' => $comment->subject)); + + comment_invoke_comment($comment, 'delete'); + + // Delete the comment's replies + $result = db_query('SELECT c.*, u.name AS registered_name, u.uid FROM {comments} c INNER JOIN {users} u ON u.uid = c.uid WHERE pid = %d', $comment->cid); + while ($comment = db_fetch_object($result)) { + $comment->name = $comment->uid ? $comment->registered_name : $comment->name; + _comment_delete_thread($comment); + } +} diff -r 5a113a1c4740 -r c1f4ac30525a modules/comment/comment.css --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/comment/comment.css Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,11 @@ +/* $Id: comment.css,v 1.4 2007/07/24 21:33:53 goba Exp $ */ + +.indented { + margin-left: 25px; /* LTR */ +} +.comment-unpublished { + background-color: #fff4f4; +} +.preview .comment { + background-color: #ffffea; +} diff -r 5a113a1c4740 -r c1f4ac30525a modules/comment/comment.info --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/comment/comment.info Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,6 @@ +; $Id: comment.info,v 1.4 2007/06/08 05:50:54 dries Exp $ +name = Comment +description = Allows users to comment on and discuss published content. +package = Core - optional +version = VERSION +core = 6.x diff -r 5a113a1c4740 -r c1f4ac30525a modules/comment/comment.install --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/comment/comment.install Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,219 @@ +changed to avoid future timestamps. + */ +function comment_update_1() { + // Change any future last comment timestamps to now. + db_query('UPDATE {node_comment_statistics} SET last_comment_timestamp = %d WHERE last_comment_timestamp > %d', time(), time()); + + // Unstuck node indexing timestamp if needed. + if (($last = variable_get('node_cron_last', FALSE)) !== FALSE) { + variable_set('node_cron_last', min(time(), $last)); + } + return array(); +} + +function comment_update_6001() { + $ret[] = update_sql("ALTER TABLE {comments} DROP score"); + $ret[] = update_sql("ALTER TABLE {comments} DROP users"); + return $ret; +} + +/** + * Changed comment settings from global to per-node -- copy global + * settings to all node types. + */ +function comment_update_6002() { + // Comment module might not be enabled when this is run, but we need the + // constants defined by the module for this update. + drupal_load('module', 'comment'); + $settings = array( + 'comment_default_mode' => COMMENT_MODE_THREADED_EXPANDED, + 'comment_default_order' => COMMENT_ORDER_NEWEST_FIRST, + 'comment_default_per_page' => 50, + 'comment_controls' => COMMENT_CONTROLS_HIDDEN, + 'comment_anonymous' => COMMENT_ANONYMOUS_MAYNOT_CONTACT, + 'comment_subject_field' => 1, + 'comment_preview' => COMMENT_PREVIEW_REQUIRED, + 'comment_form_location' => COMMENT_FORM_SEPARATE_PAGE, + ); + $types = node_get_types(); + foreach ($settings as $setting => $default) { + $value = variable_get($setting, $default); + foreach ($types as $type => $object) { + variable_set($setting .'_'. $type, $value); + } + variable_del($setting); + } + return array(array('success' => TRUE, 'query' => 'Global comment settings copied to all node types.')); +} + +/** + * Add index to parent ID field. + */ +function comment_update_6003() { + $ret = array(); + db_add_index($ret, 'comments', 'pid', array('pid')); + return $ret; +} + + +/** + * Implementation of hook_schema(). + */ +function comment_schema() { + $schema['comments'] = array( + 'description' => t('Stores comments and associated data.'), + 'fields' => array( + 'cid' => array( + 'type' => 'serial', + 'not null' => TRUE, + 'description' => t('Primary Key: Unique comment ID.'), + ), + 'pid' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The {comments}.cid to which this comment is a reply. If set to 0, this comment is not a reply to an existing comment.'), + ), + 'nid' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The {node}.nid to which this comment is a reply.'), + ), + 'uid' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The {users}.uid who authored the comment. If set to 0, this comment was created by an anonymous user.'), + ), + 'subject' => array( + 'type' => 'varchar', + 'length' => 64, + 'not null' => TRUE, + 'default' => '', + 'description' => t('The comment title.'), + ), + 'comment' => array( + 'type' => 'text', + 'not null' => TRUE, + 'size' => 'big', + 'description' => t('The comment body.'), + ), + 'hostname' => array( + 'type' => 'varchar', + 'length' => 128, + 'not null' => TRUE, + 'default' => '', + 'description' => t("The author's host name."), + ), + 'timestamp' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The time that the comment was created, or last edited by its author, as a Unix timestamp.'), + ), + 'status' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + 'size' => 'tiny', + 'description' => t('The published status of a comment. (0 = Published, 1 = Not Published)'), + ), + 'format' => array( + 'type' => 'int', + 'size' => 'small', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The {filter_formats}.format of the comment body.'), + ), + 'thread' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => TRUE, + 'description' => t("The vancode representation of the comment's place in a thread."), + ), + 'name' => array( + 'type' => 'varchar', + 'length' => 60, + 'not null' => FALSE, + 'description' => t("The comment author's name. Uses {users}.name if the user is logged in, otherwise uses the value typed into the comment form."), + ), + 'mail' => array( + 'type' => 'varchar', + 'length' => 64, + 'not null' => FALSE, + 'description' => t("The comment author's e-mail address from the comment form, if user is anonymous, and the 'Anonymous users may/must leave their contact information' setting is turned on."), + ), + 'homepage' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => FALSE, + 'description' => t("The comment author's home page address from the comment form, if user is anonymous, and the 'Anonymous users may/must leave their contact information' setting is turned on."), + ) + ), + 'indexes' => array( + 'pid' => array('pid'), + 'nid' => array('nid'), + 'status' => array('status'), // This index is probably unused + ), + 'primary key' => array('cid'), + ); + + $schema['node_comment_statistics'] = array( + 'description' => t('Maintains statistics of node and comments posts to show "new" and "updated" flags.'), + 'fields' => array( + 'nid' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The {node}.nid for which the statistics are compiled.'), + ), + 'last_comment_timestamp' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The Unix timestamp of the last comment that was posted within this node, from {comments}.timestamp.'), + ), + 'last_comment_name' => array( + 'type' => 'varchar', + 'length' => 60, + 'not null' => FALSE, + 'description' => t('The name of the latest author to post a comment on this node, from {comments}.name.'), + ), + 'last_comment_uid' => array( + 'type' => 'int', + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The user ID of the latest author to post a comment on this node, from {comments}.uid.'), + ), + 'comment_count' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + 'description' => t('The total number of comments on this node.'), + ), + ), + 'primary key' => array('nid'), + 'indexes' => array( + 'node_comment_timestamp' => array('last_comment_timestamp') + ), + ); + + return $schema; +} + diff -r 5a113a1c4740 -r c1f4ac30525a modules/comment/comment.js --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/comment/comment.js Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,35 @@ +// $Id: comment.js,v 1.5 2007/09/12 18:29:32 goba Exp $ + +Drupal.behaviors.comment = function (context) { + var parts = new Array("name", "homepage", "mail"); + var cookie = ''; + for (i=0;i<3;i++) { + cookie = Drupal.comment.getCookie('comment_info_' + parts[i]); + if (cookie != '') { + $("#comment-form input[name=" + parts[i] + "]:not(.comment-processed)", context) + .val(cookie) + .addClass('comment-processed'); + } + } +}; + +Drupal.comment = {}; + +Drupal.comment.getCookie = function(name) { + var search = name + '='; + var returnValue = ''; + + if (document.cookie.length > 0) { + offset = document.cookie.indexOf(search); + if (offset != -1) { + offset += search.length; + var end = document.cookie.indexOf(';', offset); + if (end == -1) { + end = document.cookie.length; + } + returnValue = decodeURIComponent(document.cookie.substring(offset, end).replace(/\+/g, '%20')); + } + } + + return returnValue; +}; diff -r 5a113a1c4740 -r c1f4ac30525a modules/comment/comment.module --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/modules/comment/comment.module Tue Dec 23 14:28:28 2008 +0100 @@ -0,0 +1,2102 @@ +'. t('The comment module allows visitors to comment on your posts, creating ad hoc discussion boards. Any content type may have its Default comment setting set to Read/Write to allow comments, or Disabled, to prevent comments. Comment display settings and other controls may also be customized for each content type (some display settings are customizable by individual users).', array('@content-type' => url('admin/content/types'))) .'

'; + $output .= '

'. t('Comment permissions are assigned to user roles, and are used to determine whether anonymous users (or other roles) are allowed to comment on posts. If anonymous users are allowed to comment, their individual contact information may be retained in cookies stored on their local computer for use in later comment submissions. When a comment has no replies, it may be (optionally) edited by its author. The comment module uses the same input formats and HTML tags available when creating other forms of content.') .'

'; + $output .= '

'. t('For more information, see the online handbook entry for Comment module.', array('@comment' => 'http://drupal.org/handbook/modules/comment/')) .'

'; + return $output; + case 'admin/content/comment': + return '

'. t("Below is a list of the latest comments posted to your site. Click on a subject to see the comment, the author's name to edit the author's user information, 'edit' to modify the text, and 'delete' to remove their submission.") .'

'; + case 'admin/content/comment/approval': + return '

'. t("Below is a list of the comments posted to your site that need approval. To approve a comment, click on 'edit' and then change its 'moderation status' to Approved. Click on a subject to see the comment, the author's name to edit the author's user information, 'edit' to modify the text, and 'delete' to remove their submission.") .'

'; + } +} + +/** + * Implementation of hook_theme(). + */ +function comment_theme() { + return array( + 'comment_block' => array( + 'arguments' => array(), + ), + 'comment_admin_overview' => array( + 'arguments' => array('form' => NULL), + ), + 'comment_preview' => array( + 'arguments' => array('comment' => NULL, 'node' => NULL, 'links' => array(), 'visible' => 1), + ), + 'comment_view' => array( + 'arguments' => array('comment' => NULL, 'node' => NULL, 'links' => array(), 'visible' => 1), + ), + 'comment_controls' => array( + 'arguments' => array('form' => NULL), + ), + 'comment' => array( + 'template' => 'comment', + 'arguments' => array('comment' => NULL, 'node' => NULL, 'links' => array()), + ), + 'comment_folded' => array( + 'template' => 'comment-folded', + 'arguments' => array('comment' => NULL), + ), + 'comment_flat_collapsed' => array( + 'arguments' => array('comment' => NULL, 'node' => NULL), + ), + 'comment_flat_expanded' => array( + 'arguments' => array('comment' => NULL, 'node' => NULL), + ), + 'comment_thread_collapsed' => array( + 'arguments' => array('comment' => NULL, 'node' => NULL), + ), + 'comment_thread_expanded' => array( + 'arguments' => array('comment' => NULL, 'node' => NULL), + ), + 'comment_post_forbidden' => array( + 'arguments' => array('nid' => NULL), + ), + 'comment_wrapper' => array( + 'template' => 'comment-wrapper', + 'arguments' => array('content' => NULL, 'node' => NULL), + ), + 'comment_submitted' => array( + 'arguments' => array('comment' => NULL), + ), + ); +} + +/** + * Implementation of hook_menu(). + */ +function comment_menu() { + $items['admin/content/comment'] = array( + 'title' => 'Comments', + 'description' => 'List and edit site comments and the comment moderation queue.', + 'page callback' => 'comment_admin', + 'access arguments' => array('administer comments'), + 'file' => 'comment.admin.inc', + ); + + // Tabs: + $items['admin/content/comment/new'] = array( + 'title' => 'Published comments', + 'type' => MENU_DEFAULT_LOCAL_TASK, + 'weight' => -10, + ); + $items['admin/content/comment/approval'] = array( + 'title' => 'Approval queue', + 'page arguments' => array('approval'), + 'type' => MENU_LOCAL_TASK, + 'file' => 'comment.admin.inc', + ); + + $items['comment/delete'] = array( + 'title' => 'Delete comment', + 'page callback' => 'comment_delete', + 'access arguments' => array('administer comments'), + 'type' => MENU_CALLBACK, + 'file' => 'comment.admin.inc', + ); + + $items['comment/edit'] = array( + 'title' => 'Edit comment', + 'page callback' => 'comment_edit', + 'access arguments' => array('post comments'), + 'type' => MENU_CALLBACK, + 'file' => 'comment.pages.inc', + ); + $items['comment/reply/%node'] = array( + 'title' => 'Reply to comment', + 'page callback' => 'comment_reply', + 'page arguments' => array(2), + 'access callback' => 'node_access', + 'access arguments' => array('view', 2), + 'type' => MENU_CALLBACK, + 'file' => 'comment.pages.inc', + ); + + return $items; +} + +/** + * Implementation of hook_node_type(). + */ +function comment_node_type($op, $info) { + $settings = array( + 'comment', + 'comment_default_mode', + 'comment_default_order', + 'comment_default_per_page', + 'comment_controls', + 'comment_anonymous', + 'comment_subject_field', + 'comment_preview', + 'comment_form_location', + ); + switch ($op) { + case 'delete': + foreach ($settings as $setting) { + variable_del($setting .'_'. $info->type); + } + break; + } +} + +/** + * Implementation of hook_perm(). + */ +function comment_perm() { + return array('access comments', 'post comments', 'administer comments', 'post comments without approval'); +} + +/** + * Implementation of hook_block(). + * + * Generates a block with the most recent comments. + */ +function comment_block($op = 'list', $delta = 0) { + if ($op == 'list') { + $blocks[0]['info'] = t('Recent comments'); + return $blocks; + } + else if ($op == 'view' && user_access('access comments')) { + $block['subject'] = t('Recent comments'); + $block['content'] = theme('comment_block'); + return $block; + } +} + +/** + * Find a number of recent comments. This is done in two steps. + * 1. Find the n (specified by $number) nodes that have the most recent + * comments. This is done by querying node_comment_statistics which has + * an index on last_comment_timestamp, and is thus a fast query. + * 2. Loading the information from the comments table based on the nids found + * in step 1. + * + * @param $number + * (optional) The maximum number of comments to find. + * @return + * An array of comment objects each containing a nid, + * subject, cid, and timestamp, or an empty array if there are no recent + * comments visible to the current user. + */ +function comment_get_recent($number = 10) { + // Select the $number nodes (visible to the current user) with the most + // recent comments. This is efficient due to the index on + // last_comment_timestamp. + $result = db_query_range(db_rewrite_sql("SELECT nc.nid FROM {node_comment_statistics} nc WHERE nc.comment_count > 0 ORDER BY nc.last_comment_timestamp DESC", 'nc'), 0, $number); + + $nids = array(); + while ($row = db_fetch_object($result)) { + $nids[] = $row->nid; + } + + $comments = array(); + if (!empty($nids)) { + // From among the comments on the nodes selected in the first query, + // find the $number most recent comments. + $result = db_query_range('SELECT c.nid, c.subject, c.cid, c.timestamp FROM {comments} c INNER JOIN {node} n ON n.nid = c.nid WHERE c.nid IN ('. implode(',', $nids) .') AND n.status = 1 AND c.status = %d ORDER BY c.cid DESC', COMMENT_PUBLISHED, 0, $number); + while ($comment = db_fetch_object($result)) { + $comments[] = $comment; + } + } + + return $comments; +} + +/** + * Calculate page number for first new comment. + * + * @param $num_comments + * Number of comments. + * @param $new_replies + * Number of new replies. + * @param $node + * The first new comment node. + * @return + * "page=X" if the page number is greater than zero; empty string otherwise. + */ +function comment_new_page_count($num_comments, $new_replies, $node) { + $comments_per_page = _comment_get_display_setting('comments_per_page', $node); + $mode = _comment_get_display_setting('mode', $node); + $order = _comment_get_display_setting('sort', $node); + $pagenum = NULL; + $flat = in_array($mode, array(COMMENT_MODE_FLAT_COLLAPSED, COMMENT_MODE_FLAT_EXPANDED)); + if ($num_comments <= $comments_per_page || ($flat && $order == COMMENT_ORDER_NEWEST_FIRST)) { + // Only one page of comments or flat forum and newest first. + // First new comment will always be on first page. + $pageno = 0; + } + else { + if ($flat) { + // Flat comments and oldest first. + $count = $num_comments - $new_replies; + } + else { + // Threaded comments. See the documentation for comment_render(). + if ($order == COMMENT_ORDER_NEWEST_FIRST) { + // Newest first: find the last thread with new comment + $result = db_query('(SELECT thread FROM {comments} WHERE nid = %d AND status = 0 ORDER BY timestamp DESC LIMIT %d) ORDER BY thread DESC LIMIT 1', $node->nid, $new_replies); + $thread = db_result($result); + $result_count = db_query("SELECT COUNT(*) FROM {comments} WHERE nid = %d AND status = 0 AND thread > '". $thread ."'", $node->nid); + } + else { + // Oldest first: find the first thread with new comment + $result = db_query('(SELECT thread FROM {comments} WHERE nid = %d AND status = 0 ORDER BY timestamp DESC LIMIT %d) ORDER BY SUBSTRING(thread, 1, (LENGTH(thread) - 1)) LIMIT 1', $node->nid, $new_replies); + $thread = substr(db_result($result), 0, -1); + $result_count = db_query("SELECT COUNT(*) FROM {comments} WHERE nid = %d AND status = 0 AND SUBSTRING(thread, 1, (LENGTH(thread) - 1)) < '". $thread ."'", $node->nid); + } + $count = db_result($result_count); + } + $pageno = $count / $comments_per_page; + } + if ($pageno >= 1) { + $pagenum = "page=". intval($pageno); + } + return $pagenum; +} + +/** + * Returns a formatted list of recent comments to be displayed in the comment block. + * + * @return + * The comment list HTML. + * @ingroup themeable + */ +function theme_comment_block() { + $items = array(); + foreach (comment_get_recent() as $comment) { + $items[] = l($comment->subject, 'node/'. $comment->nid, array('fragment' => 'comment-'. $comment->cid)) .'
'. t('@time ago', array('@time' => format_interval(time() - $comment->timestamp))); + } + if ($items) { + return theme('item_list', $items); + } +} + +/** + * Implementation of hook_link(). + */ +function comment_link($type, $node = NULL, $teaser = FALSE) { + $links = array(); + + if ($type == 'node' && $node->comment) { + + if ($teaser) { + // Main page: display the number of comments that have been posted. + + if (user_access('access comments')) { + $all = comment_num_all($node->nid); + + if ($all) { + $links['comment_comments'] = array( + 'title' => format_plural($all, '1 comment', '@count comments'), + 'href' => "node/$node->nid", + 'attributes' => array('title' => t('Jump to the first comment of this posting.')), + 'fragment' => 'comments' + ); + + $new = comment_num_new($node->nid); + + if ($new) { + $links['comment_new_comments'] = array( + 'title' => format_plural($new, '1 new comment', '@count new comments'), + 'href' => "node/$node->nid", + 'query' => comment_new_page_count($all, $new, $node), + 'attributes' => array('title' => t('Jump to the first new comment of this posting.')), + 'fragment' => 'new' + ); + } + } + else { + if ($node->comment == COMMENT_NODE_READ_WRITE) { + if (user_access('post comments')) { + $links['comment_add'] = array( + 'title' => t('Add new comment'), + 'href' => "comment/reply/$node->nid", + 'attributes' => array('title' => t('Add a new comment to this page.')), + 'fragment' => 'comment-form' + ); + } + else { + $links['comment_forbidden']['title'] = theme('comment_post_forbidden', $node); + } + } + } + } + } + else { + // Node page: add a "post comment" link if the user is allowed to + // post comments, if this node is not read-only, and if the comment form isn't already shown + + if ($node->comment == COMMENT_NODE_READ_WRITE) { + if (user_access('post comments')) { + if (variable_get('comment_form_location_'. $node->type, COMMENT_FORM_SEPARATE_PAGE) == COMMENT_FORM_SEPARATE_PAGE) { + $links['comment_add'] = array( + 'title' => t('Add new comment'), + 'href' => "comment/reply/$node->nid", + 'attributes' => array('title' => t('Share your thoughts and opinions related to this posting.')), + 'fragment' => 'comment-form' + ); + } + } + else { + $links['comment_forbidden']['title'] = theme('comment_post_forbidden', $node); + } + } + } + } + + if ($type == 'comment') { + $links = comment_links($node, $teaser); + } + if (isset($links['comment_forbidden'])) { + $links['comment_forbidden']['html'] = TRUE; + } + + return $links; +} + +/** + * Implementation of hook_form_alter(). + */ +function comment_form_alter(&$form, $form_state, $form_id) { + if ($form_id == 'node_type_form' && isset($form['identity']['type'])) { + $form['comment'] = array( + '#type' => 'fieldset', + '#title' => t('Comment settings'), + '#collapsible' => TRUE, + '#collapsed' => TRUE, + ); + $form['comment']['comment'] = array( + '#type' => 'radios', + '#title' => t('Default comment setting'), + '#default_value' => variable_get('comment_'. $form['#node_type']->type, COMMENT_NODE_READ_WRITE), + '#options' => array(t('Disabled'), t('Read only'), t('Read/Write')), + '#description' => t('Users with the administer comments permission will be able to override this setting.'), + ); + $form['comment']['comment_default_mode'] = array( + '#type' => 'radios', + '#title' => t('Default display mode'), + '#default_value' => variable_get('comment_default_mode_'. $form['#node_type']->type, COMMENT_MODE_THREADED_EXPANDED), + '#options' => _comment_get_modes(), + '#description' => t('The default view for comments. Expanded views display the body of the comment. Threaded views keep replies together.'), + ); + $form['comment']['comment_default_order'] = array( + '#type' => 'radios', + '#title' => t('Default display order'), + '#default_value' => variable_get('comment_default_order_'. $form['#node_type']->type, COMMENT_ORDER_NEWEST_FIRST), + '#options' => _comment_get_orders(), + '#description' => t('The default sorting for new users and anonymous users while viewing comments. These users may change their view using the comment control panel. For registered users, this change is remembered as a persistent user preference.'), + ); + $form['comment']['comment_default_per_page'] = array( + '#type' => 'select', + '#title' => t('Default comments per page'), + '#default_value' => variable_get('comment_default_per_page_'. $form['#node_type']->type, 50), + '#options' => _comment_per_page(), + '#description' => t('Default number of comments for each page: more comments are distributed in several pages.'), + ); + $form['comment']['comment_controls'] = array( + '#type' => 'radios', + '#title' => t('Comment controls'), + '#default_value' => variable_get('comment_controls_'. $form['#node_type']->type, COMMENT_CONTROLS_HIDDEN), + '#options' => array( + t('Display above the comments'), + t('Display below the comments'), + t('Display above and below the comments'), + t('Do not display')), + '#description' => t('Position of the comment controls box. The comment controls let the user change the default display mode and display order of comments.'), + ); + $form['comment']['comment_anonymous'] = array( + '#type' => 'radios', + '#title' => t('Anonymous commenting'), + '#default_value' => variable_get('comment_anonymous_'. $form['#node_type']->type, COMMENT_ANONYMOUS_MAYNOT_CONTACT), + '#options' => array( + COMMENT_ANONYMOUS_MAYNOT_CONTACT => t('Anonymous posters may not enter their contact information'), + COMMENT_ANONYMOUS_MAY_CONTACT => t('Anonymous posters may leave their contact information'), + COMMENT_ANONYMOUS_MUST_CONTACT => t('Anonymous posters must leave their contact information')), + '#description' => t('This option is enabled when anonymous users have permission to post comments on the permissions page.', array('@url' => url('admin/user/permissions', array('fragment' => 'module-comment')))), + ); + if (!user_access('post comments', drupal_anonymous_user())) { + $form['comment']['comment_anonymous']['#disabled'] = TRUE; + } + $form['comment']['comment_subject_field'] = array( + '#type' => 'radios', + '#title' => t('Comment subject field'), + '#default_value' => variable_get('comment_subject_field_'. $form['#node_type']->type, 1), + '#options' => array(t('Disabled'), t('Enabled')), + '#description' => t('Can users provide a unique subject for their comments?'), + ); + $form['comment']['comment_preview'] = array( + '#type' => 'radios', + '#title' => t('Preview comment'), + '#default_value' => variable_get('comment_preview_'. $form['#node_type']->type, COMMENT_PREVIEW_REQUIRED), + '#options' => array(t('Optional'), t('Required')), + '#description' => t("Forces a user to look at their comment by clicking on a 'Preview' button before they can actually add the comment"), + ); + $form['comment']['comment_form_location'] = array( + '#type' => 'radios', + '#title' => t('Location of comment submission form'), + '#default_value' => variable_get('comment_form_location_'. $form['#node_type']->type, COMMENT_FORM_SEPARATE_PAGE), + '#options' => array(t('Display on separate page'), t('Display below post or comments')), + ); + } + elseif (isset($form['type']) && isset($form['#node'])) { + if ($form['type']['#value'] .'_node_form' == $form_id) { + $node = $form['#node']; + $form['comment_settings'] = array( + '#type' => 'fieldset', + '#access' => user_access('administer comments'), + '#title' => t('Comment settings'), + '#collapsible' => TRUE, + '#collapsed' => TRUE, + '#weight' => 30, + ); + $form['comment_settings']['comment'] = array( + '#type' => 'radios', + '#parents' => array('comment'), + '#default_value' => $node->comment, + '#options' => array(t('Disabled'), t('Read only'), t('Read/Write')), + ); + } + } +} + +/** + * Implementation of hook_nodeapi(). + */ +function comment_nodeapi(&$node, $op, $arg = 0) { + switch ($op) { + case 'load': + return db_fetch_array(db_query("SELECT last_comment_timestamp, last_comment_name, comment_count FROM {node_comment_statistics} WHERE nid = %d", $node->nid)); + break; + + case 'prepare': + if (!isset($node->comment)) { + $node->comment = variable_get("comment_$node->type", COMMENT_NODE_READ_WRITE); + } + break; + + case 'insert': + db_query('INSERT INTO {node_comment_statistics} (nid, last_comment_timestamp, last_comment_name, last_comment_uid, comment_count) VALUES (%d, %d, NULL, %d, 0)', $node->nid, $node->changed, $node->uid); + break; + + case 'delete': + db_query('DELETE FROM {comments} WHERE nid = %d', $node->nid); + db_query('DELETE FROM {node_comment_statistics} WHERE nid = %d', $node->nid); + break; + + case 'update index': + $text = ''; + $comments = db_query('SELECT subject, comment, format FROM {comments} WHERE nid = %d AND status = %d', $node->nid, COMMENT_PUBLISHED); + while ($comment = db_fetch_object($comments)) { + $text .= '

'. check_plain($comment->subject) .'

'. check_markup($comment->comment, $comment->format, FALSE); + } + return $text; + + case 'search result': + $comments = db_result(db_query('SELECT comment_count FROM {node_comment_statistics} WHERE nid = %d', $node->nid)); + return format_plural($comments, '1 comment', '@count comments'); + + case 'rss item': + if ($node->comment != COMMENT_NODE_DISABLED) { + return array(array('key' => 'comments', 'value' => url('node/'. $node->nid, array('fragment' => 'comments', 'absolute' => TRUE)))); + } + else { + return array(); + } + } +} + +/** + * Implementation of hook_user(). + */ +function comment_user($type, $edit, &$user, $category = NULL) { + if ($type == 'delete') { + db_query('UPDATE {comments} SET uid = 0 WHERE uid = %d', $user->uid); + db_query('UPDATE {node_comment_statistics} SET last_comment_uid = 0 WHERE last_comment_uid = %d', $user->uid); + } +} + +/** + * This is *not* a hook_access() implementation. This function is called + * to determine whether the current user has access to a particular comment. + * + * Authenticated users can edit their comments as long they have not been + * replied to. This prevents people from changing or revising their + * statements based on the replies to their posts. + * + * @param $op + * The operation that is to be performed on the comment. Only 'edit' is recognized now. + * @param $comment + * The comment object. + * @return + * TRUE if the current user has acces to the comment, FALSE otherwise. + */ +function comment_access($op, $comment) { + global $user; + + if ($op == 'edit') { + return ($user->uid && $user->uid == $comment->uid && comment_num_replies($comment->cid) == 0) || user_access('administer comments'); + } +} + +/** + * A simple helper function. + * + * @return + * The 0th and the 1st path components joined by a slash. + */ +function comment_node_url() { + return arg(0) .'/'. arg(1); +} + +/** + * Accepts a submission of new or changed comment content. + * + * @param $edit + * A comment array. + * + * @return + * If the comment is successfully saved the comment ID is returned. If the comment + * is not saved, FALSE is returned. + */ +function comment_save($edit) { + global $user; + if (user_access('post comments') && (user_access('administer comments') || node_comment_mode($edit['nid']) == COMMENT_NODE_READ_WRITE)) { + if (!form_get_errors()) { + $edit += array( + 'mail' => '', + 'homepage' => '', + 'name' => '', + 'status' => user_access('post comments without approval') ? COMMENT_PUBLISHED : COMMENT_NOT_PUBLISHED, + ); + if ($edit['cid']) { + // Update the comment in the database. + db_query("UPDATE {comments} SET status = %d, timestamp = %d, subject = '%s', comment = '%s', format = %d, uid = %d, name = '%s', mail = '%s', homepage = '%s' WHERE cid = %d", $edit['status'], $edit['timestamp'], $edit['subject'], $edit['comment'], $edit['format'], $edit['uid'], $edit['name'], $edit['mail'], $edit['homepage'], $edit['cid']); + + // Allow modules to respond to the updating of a comment. + comment_invoke_comment($edit, 'update'); + + // Add an entry to the watchdog log. + watchdog('content', 'Comment: updated %subject.', array('%subject' => $edit['subject']), WATCHDOG_NOTICE, l(t('view'), 'node/'. $edit['nid'], array('fragment' => 'comment-'. $edit['cid']))); + } + else { + // Add the comment to database. + // Here we are building the thread field. See the documentation for + // comment_render(). + if ($edit['pid'] == 0) { + // This is a comment with no parent comment (depth 0): we start + // by retrieving the maximum thread level. + $max = db_result(db_query('SELECT MAX(thread) FROM {comments} WHERE nid = %d', $edit['nid'])); + + // Strip the "/" from the end of the thread. + $max = rtrim($max, '/'); + + // Finally, build the thread field for this new comment. + $thread = int2vancode(vancode2int($max) + 1) .'/'; + } + else { + // This is comment with a parent comment: we increase + // the part of the thread value at the proper depth. + + // Get the parent comment: + $parent = _comment_load($edit['pid']); + + // Strip the "/" from the end of the parent thread. + $parent->thread = (string) rtrim((string) $parent->thread, '/'); + + // Get the max value in _this_ thread. + $max = db_result(db_query("SELECT MAX(thread) FROM {comments} WHERE thread LIKE '%s.%%' AND nid = %d", $parent->thread, $edit['nid'])); + + if ($max == '') { + // First child of this parent. + $thread = $parent->thread .'.'. int2vancode(0) .'/'; + } + else { + // Strip the "/" at the end of the thread. + $max = rtrim($max, '/'); + + // We need to get the value at the correct depth. + $parts = explode('.', $max); + $parent_depth = count(explode('.', $parent->thread)); + $last = $parts[$parent_depth]; + + // Finally, build the thread field for this new comment. + $thread = $parent->thread .'.'. int2vancode(vancode2int($last) + 1) .'/'; + } + } + + $edit['timestamp'] = time(); + + if ($edit['uid'] === $user->uid) { // '===' because we want to modify anonymous users too + $edit['name'] = $user->name; + } + + db_query("INSERT INTO {comments} (nid, pid, uid, subject, comment, format, hostname, timestamp, status, thread, name, mail, homepage) VALUES (%d, %d, %d, '%s', '%s', %d, '%s', %d, %d, '%s', '%s', '%s', '%s')", $edit['nid'], $edit['pid'], $edit['uid'], $edit['subject'], $edit['comment'], $edit['format'], ip_address(), $edit['timestamp'], $edit['status'], $thread, $edit['name'], $edit['mail'], $edit['homepage']); + $edit['cid'] = db_last_insert_id('comments', 'cid'); + + // Tell the other modules a new comment has been submitted. + comment_invoke_comment($edit, 'insert'); + + // Add an entry to the watchdog log. + watchdog('content', 'Comment: added %subject.', array('%subject' => $edit['subject']), WATCHDOG_NOTICE, l(t('view'), 'node/'. $edit['nid'], array('fragment' => 'comment-'. $edit['cid']))); + } + _comment_update_node_statistics($edit['nid']); + + // Clear the cache so an anonymous user can see his comment being added. + cache_clear_all(); + + // Explain the approval queue if necessary, and then + // redirect the user to the node he's commenting on. + if ($edit['status'] == COMMENT_NOT_PUBLISHED) { + drupal_set_message(t('Your comment has been queued for moderation by site administrators and will be published after approval.')); + } + else { + comment_invoke_comment($edit, 'publish'); + } + return $edit['cid']; + } + else { + return FALSE; + } + } + else { + watchdog('content', 'Comment: unauthorized comment submitted or comment submitted to a closed post %subject.', array('%subject' => $edit['subject']), WATCHDOG_WARNING); + drupal_set_message(t('Comment: unauthorized comment submitted or comment submitted to a closed post %subject.', array('%subject' => $edit['subject'])), 'error'); + return FALSE; + } +} + +/** + * Build command links for a comment (e.g.\ edit, reply, delete) with respect to the current user's access permissions. + * + * @param $comment + * The comment to which the links will be related. + * @param $return + * Not used. + * @return + * An associative array containing the links. + */ +function comment_links($comment, $return = 1) { + global $user; + + $links = array(); + + // If we are viewing just this comment, we link back to the node. + if ($return) { + $links['comment_parent'] = array( + 'title' => t('parent'), + 'href' => comment_node_url(), + 'fragment' => "comment-$comment->cid" + ); + } + + if (node_comment_mode($comment->nid) == COMMENT_NODE_READ_WRITE) { + if (user_access('administer comments') && user_access('post comments')) { + $links['comment_delete'] = array( + 'title' => t('delete'), + 'href' => "comment/delete/$comment->cid" + ); + $links['comment_edit'] = array( + 'title' => t('edit'), + 'href' => "comment/edit/$comment->cid" + ); + $links['comment_reply'] = array( + 'title' => t('reply'), + 'href' => "comment/reply/$comment->nid/$comment->cid" + ); + } + else if (user_access('post comments')) { + if (comment_access('edit', $comment)) { + $links['comment_edit'] = array( + 'title' => t('edit'), + 'href' => "comment/edit/$comment->cid" + ); + } + $links['comment_reply'] = array( + 'title' => t('reply'), + 'href' => "comment/reply/$comment->nid/$comment->cid" + ); + } + else { + $node = node_load($comment->nid); + $links['comment_forbidden']['title'] = theme('comment_post_forbidden', $node); + } + } + + return $links; +} + +/** + * Renders comment(s). + * + * @param $node + * The node which comment(s) needs rendering. + * @param $cid + * Optional, if given, only one comment is rendered. + * + * To display threaded comments in the correct order we keep a 'thread' field + * and order by that value. This field keeps this data in + * a way which is easy to update and convenient to use. + * + * A "thread" value starts at "1". If we add a child (A) to this comment, + * we assign it a "thread" = "1.1". A child of (A) will have "1.1.1". Next + * brother of (A) will get "1.2". Next brother of the parent of (A) will get + * "2" and so on. + * + * First of all note that the thread field stores the depth of the comment: + * depth 0 will be "X", depth 1 "X.X", depth 2 "X.X.X", etc. + * + * Now to get the ordering right, consider this example: + * + * 1 + * 1.1 + * 1.1.1 + * 1.2 + * 2 + * + * If we "ORDER BY thread ASC" we get the above result, and this is the + * natural order sorted by time. However, if we "ORDER BY thread DESC" + * we get: + * + * 2 + * 1.2 + * 1.1.1 + * 1.1 + * 1 + * + * Clearly, this is not a natural way to see a thread, and users will get + * confused. The natural order to show a thread by time desc would be: + * + * 2 + * 1 + * 1.2 + * 1.1 + * 1.1.1 + * + * which is what we already did before the standard pager patch. To achieve + * this we simply add a "/" at the end of each "thread" value. This way out + * thread fields will look like depicted below: + * + * 1/ + * 1.1/ + * 1.1.1/ + * 1.2/ + * 2/ + * + * we add "/" since this char is, in ASCII, higher than every number, so if + * now we "ORDER BY thread DESC" we get the correct order. However this would + * spoil the reverse ordering, "ORDER BY thread ASC" -- here, we do not need + * to consider the trailing "/" so we use a substring only. + */ +function comment_render($node, $cid = 0) { + global $user; + + $output = ''; + + if (user_access('access comments')) { + // Pre-process variables. + $nid = $node->nid; + if (empty($nid)) { + $nid = 0; + } + + $mode = _comment_get_display_setting('mode', $node); + $order = _comment_get_display_setting('sort', $node); + $comments_per_page = _comment_get_display_setting('comments_per_page', $node); + + if ($cid && is_numeric($cid)) { + // Single comment view. + $query = 'SELECT c.cid, c.pid, c.nid, c.subject, c.comment, c.format, c.timestamp, c.name, c.mail, c.homepage, u.uid, u.name AS registered_name, u.signature, u.picture, u.data, c.status FROM {comments} c INNER JOIN {users} u ON c.uid = u.uid WHERE c.cid = %d'; + $query_args = array($cid); + if (!user_access('administer comments')) { + $query .= ' AND c.status = %d'; + $query_args[] = COMMENT_PUBLISHED; + } + + $query = db_rewrite_sql($query, 'c', 'cid'); + $result = db_query($query, $query_args); + + if ($comment = db_fetch_object($result)) { + $comment->name = $comment->uid ? $comment->registered_name : $comment->name; + $links = module_invoke_all('link', 'comment', $comment, 1); + drupal_alter('link', $links, $node); + + $output .= theme('comment_view', $comment, $node, $links); + } + } + else { + // Multiple comment view + $query_count = 'SELECT COUNT(*) FROM {comments} WHERE nid = %d'; + $query = 'SELECT c.cid as cid, c.pid, c.nid, c.subject, c.comment, c.format, c.timestamp, c.name, c.mail, c.homepage, u.uid, u.name AS registered_name, u.signature, u.picture, u.data, c.thread, c.status FROM {comments} c INNER JOIN {users} u ON c.uid = u.uid WHERE c.nid = %d'; + + $query_args = array($nid); + if (!user_access('administer comments')) { + $query .= ' AND c.status = %d'; + $query_count .= ' AND status = %d'; + $query_args[] = COMMENT_PUBLISHED; + } + + if ($order == COMMENT_ORDER_NEWEST_FIRST) { + if ($mode == COMMENT_MODE_FLAT_COLLAPSED || $mode == COMMENT_MODE_FLAT_EXPANDED) { + $query .= ' ORDER BY c.cid DESC'; + } + else { + $query .= ' ORDER BY c.thread DESC'; + } + } + else if ($order == COMMENT_ORDER_OLDEST_FIRST) { + if ($mode == COMMENT_MODE_FLAT_COLLAPSED || $mode == COMMENT_MODE_FLAT_EXPANDED) { + $query .= ' ORDER BY c.cid'; + } + else { + // See comment above. Analysis reveals that this doesn't cost too + // much. It scales much much better than having the whole comment + // structure. + $query .= ' ORDER BY SUBSTRING(c.thread, 1, (LENGTH(c.thread) - 1))'; + } + } + $query = db_rewrite_sql($query, 'c', 'cid'); + $query_count = db_rewrite_sql($query_count, 'c', 'cid'); + + // Start a form, for use with comment control. + $result = pager_query($query, $comments_per_page, 0, $query_count, $query_args); + + $divs = 0; + $num_rows = FALSE; + $comments = ''; + drupal_add_css(drupal_get_path('module', 'comment') .'/comment.css'); + while ($comment = db_fetch_object($result)) { + $comment = drupal_unpack($comment); + $comment->name = $comment->uid ? $comment->registered_name : $comment->name; + $comment->depth = count(explode('.', $comment->thread)) - 1; + + if ($mode == COMMENT_MODE_THREADED_COLLAPSED || $mode == COMMENT_MODE_THREADED_EXPANDED) { + if ($comment->depth > $divs) { + $divs++; + $comments .= '

'; + } + else { + while ($comment->depth < $divs) { + $divs--; + $comments .= '

'; + } + } + } + + if ($mode == COMMENT_MODE_FLAT_COLLAPSED) { + $comments .= theme('comment_flat_collapsed', $comment, $node); + } + else if ($mode == COMMENT_MODE_FLAT_EXPANDED) { + $comments .= theme('comment_flat_expanded', $comment, $node); + } + else if ($mode == COMMENT_MODE_THREADED_COLLAPSED) { + $comments .= theme('comment_thread_collapsed', $comment, $node); + } + else if ($mode == COMMENT_MODE_THREADED_EXPANDED) { + $comments .= theme('comment_thread_expanded', $comment, $node); + } + + $num_rows = TRUE; + } + while ($divs-- > 0) { + $comments .= '

+ + + new): ?> + + + +

+ +

+ + +

+ +

+ + +

'. t("Personal contact forms allow users to be contacted via e-mail, while keeping recipient e-mail addresses private. Users may enable or disable their personal contact forms by editing their My account page. If enabled, a Contact tab leading to their personal contact form is available on their user profile. Site administrators have access to all personal contact forms (even if they have been disabled). The Contact tab is only visible when viewing another user's profile (users do not see their own Contact tab).") .'

'. t('The contact page provides a simple form for visitors to leave comments, feedback, or other requests. Messages are routed by selecting a category from a list of administrator-defined options; each category has its own set of e-mail recipients. Common categories for a business site include, for example, "Website feedback" (messages are forwarded to web site administrators) and "Product information" (messages are forwarded to members of the sales department). The actual e-mail addresses defined within a category are not displayed. Only users in roles with the access site-wide contact form permission may access the contact page.', array('@contact' => url('contact'))) .'

'. t('A link to your site\'s contact page from the main Navigation menu is created, but is disabled by default. Create a similar link on another menu by adding a menu item pointing to the path "contact"', array('@contact' => url('contact'))) .'

'. t('Customize the contact page with additional information (like physical location, mailing address, and telephone number) using the contact form settings page. The settings page also provides configuration options for the maximum number of contact form submissions a user may perform per hour, and the default status of users\' personal contact forms.', array('@contact-settings' => url('admin/build/contact/settings'), '@contact' => url('contact'))) .'

'. t('For more information, see the online handbook entry for Contact module.', array('@contact' => url('http://drupal.org/handbook/modules/contact/', array('absolute' => TRUE)))) .'

'. t('This page lets you set up your site-wide contact form. To do so, add one or more categories. You can associate different recipients with each category to route e-mails to different people. For example, you can route website feedback to the webmaster and direct product information requests to the sales department. On the settings page, you can customize the information shown above the contact form. This can be useful to provide additional contact information such as your postal address and telephone number.', array('@settings' => url('admin/build/contact/settings'), '@form' => url('contact'))) .'

'. t('The contact module also adds a menu item (disabled by default) to the navigation block.', array('@menu-settings' => url('admin/build/menu'))) .' '. $menu_note .'

'. t('The dblog log is simply a list of recorded events containing usage data, performance data, errors, warnings and operational information. Administrators should check the dblog report on a regular basis to ensure their site is working properly.') .'

'. t('For more information, see the online handbook entry for Dblog module.', array('@dblog' => 'http://drupal.org/handbook/modules/dblog/')) .'

'. t('The dblog module monitors your website, capturing system events in a log to be reviewed by an authorized individual at a later time. The dblog log is simply a list of recorded events containing usage data, performance data, errors, warnings and operational information. It is vital to check the dblog report on a regular basis as it is often the only way to tell what is going on.') .'

'. t('These are the guidelines that users will see for posting in this input format. They are automatically generated from the filter settings.') .'

'. t('Formatting guidelines') .'

'. t('Each input format uses filters to manipulate text, and most input formats apply several different filters to text in a specific order. Each filter is designed for a specific purpose, and generally either adds, removes or transforms elements within user-entered text before it is displayed. A filter does not change the actual content of a post, but instead, modifies it temporarily before it is displayed. A filter may remove unapproved HTML tags, for instance, while another automatically adds HTML to make links referenced in text clickable.') .'

'. t('Users can choose between the available input formats when creating or editing content. Administrators can configure which input formats are available to which user roles, as well as choose a default input format.') .'

'. t('For more information, see the online handbook entry for Filter module.', array('@filter' => 'http://drupal.org/handbook/modules/filter/')) .'

'. t('Input formats define a way of processing user-supplied text in Drupal. Each input format uses filters to manipulate text, and most input formats apply several different filters to text, in a specific order. Each filter is designed to accomplish a specific purpose, and generally either removes elements from or adds elements to text before it is displayed. Users can choose between the available input formats when submitting content.') .'

'. t('Use the list below to configure which input formats are available to which roles, as well as choose a default input format (used for imported content, for example). The default format is always available to users. All input formats are available to users in a role with the "administer filters" permission.') .'

'. t('Every filter performs one particular change on the user input, for example stripping out malicious HTML or making URLs clickable. Choose which filters you want to apply to text in this input format. If you notice some filters are causing conflicts in the output, you can rearrange them.', array('@rearrange' => url('admin/settings/filters/'. $arg[3] .'/order'))) .'

'. t('If you cannot find the settings for a certain filter, make sure you have enabled it on the view tab first.', array('@url' => url('admin/settings/filters/'. $arg[3]))) .'

'. t('Because of the flexible filtering system, you might encounter a situation where one filter prevents another from doing its job. For example: a word in an URL gets converted into a glossary term, before the URL can be converted to a clickable link. When this happens, rearrange the order of the filters.') .'

'. t("Filters are executed from top-to-bottom. To change the order of the filters, modify the values in the Weight column or grab a drag-and-drop handle under the Name column and drag filters to new locations in the list. (Grab a handle by clicking and holding the mouse while hovering over a handle icon.) Remember that your changes will not be saved until you click the Save configuration button at the bottom of the page.") .'




block_title; ?>	region_select; ?>	weight_select; ?>	throttle_check; ?>	configure_link; ?>	delete_link; ?>

'. t('Table header') .'
'. t('Table cell') .'


is_container ? 'colspan="4" class="container"' : 'class="forum"'; ?>> + + ', $forum->depth); ?> + name; ?> + description): ?> + description; ?> + + ', $forum->depth); ?> +	+ num_topics ?> + new_topics): ?> + + new_text; ?> + +	num_posts ?>	last_reply ?>


icon; ?>	title; ?>	message; ?>	+ num_comments; ?> + new_replies): ?> + + new_text; ?> + +	created; ?> +	last_reply; ?> + +

'. $requirement['title'] .'	'. $requirement['value'] .'
'. $requirement['description'] .'
'. $requirement['title'] .'	'. $requirement['value'] .'

+ 'links', 'id' => 'subnavlist')) ?> +	+ +

'. $title .'

'. $title .'

'. $title .':

'. $title .':

'. $title .':

'. $title .':

+ +

'. t('Category overview') .'

'. t('Preview') .'

Lorem ipsum dolor

'. check_plain($comment->subject) .'

'. t('Formatting guidelines') .'

'. t('Title') .'

'. t('Subtitle') .'

'. t('Subtitle three') .'

'. t('Subtitle four') .'

'. t('Subtitle five') .'

'. t('Subtitle six') .'

Welcome to your new Drupal website!

'. check_plain($node->title) .'

'. t('Preview trimmed version') .'

'. t('Preview full version') .'

'. t('Using custom PHP code') .'

'. t('Add new field') .'

subject ?>

+ +

+ +

'. t('Command counters') .'

'. t('Query performance') .'

'. t('Query cache information') .'

+ $block[title] +

'. $info['name'] .'

'. t('Actions available to Drupal:') .'

". $type_label ."

subject; ?>

". l(variable_get('site_name', 'drupal'), "") ."

$title

". ($teaser ? l($node->title, "node/$node->nid") : check_plain($node->title)) ."

". l($comment->subject, $_GET['q'], array('fragment' => "comment-$comment->cid")) ."

subject ?>

'; + if ($logo) { + print ''; + } + print $site_html .'

'; + if ($logo) { + print ''; + } + print $site_html .'

'. t('Comments') .'

subject ?>

The following queries were executed

'. $module .' module

Update #'. $number .'