diff --git CHANGELOG.txt CHANGELOG.txt index 87e7d1a..35a5eae 100644 --- CHANGELOG.txt +++ CHANGELOG.txt @@ -140,6 +140,13 @@ Drupal 7.0, xxxx-xx-xx (development version) - Added RDF support: * Modules can declare RDF namespaces which are serialized in the tag for RDFa support. +- Search engine optimization and web linking: + * Added a rel="canonical" link on node and comment pages to prevent + duplicate content indexing by search engines. + * Added default a rel="shortlink" link on node and comment pages + that advertises a short link as an alternative to third-party services. + * drupal_set_html_head now stores structured data for link, meta, and + other elements, allowing it to be altered by modules before rendering. - Field API: * Custom data fields may be attached to nodes, users, comments and taxonomy terms. diff --git includes/batch.inc includes/batch.inc index 289626e..553f381 100644 --- includes/batch.inc +++ includes/batch.inc @@ -190,7 +190,14 @@ function _batch_progress_page_nojs() { } $url = url($batch['url'], array('query' => array('id' => $batch['id'], 'op' => $new_op))); - drupal_add_html_head(''); + drupal_add_html_head(array( + '#type' => 'head_tag', + '#tag_type' => 'meta', + '#attributes' => array( + 'http-equiv' => 'Refresh', + 'content' => '0; URL=' . $url, + ), + )); return theme('progress_bar', $percentage, $message); } diff --git includes/common.inc includes/common.inc index 063174e..4b0f4c1 100644 --- includes/common.inc +++ includes/common.inc @@ -250,12 +250,25 @@ function drupal_get_rdf_namespaces() { * Add output to the head tag of the HTML page. * * This function can be called as long the headers aren't sent. + * + * @param $data + * Optional renderable array, of type 'head_tag'. + * @param $key + * Optional key for identifying the element in hook_html_head_alter(). + * + * @return + * An array of all the store head elements. */ -function drupal_add_html_head($data = NULL) { - $stored_head = &drupal_static(__FUNCTION__, ''); +function drupal_add_html_head($data = NULL, $key = NULL) { + $stored_head = &drupal_static(__FUNCTION__, array()); - if (!is_null($data)) { - $stored_head .= $data . "\n"; + if (isset($data)) { + if (isset($key)) { + $stored_head[$key] = $data; + } + else { + $stored_head[] = $data; + } } return $stored_head; } @@ -264,8 +277,34 @@ function drupal_add_html_head($data = NULL) { * Retrieve output to be displayed in the head tag of the HTML page. */ function drupal_get_html_head() { - $output = "\n"; - return $output . drupal_add_html_head(); + $head_elements = drupal_add_html_head(); + // Get the major version + list($version, ) = explode('.', VERSION); + // Add default elements. Make sure the Content-Type comes first. + $meta_elements['system_meta_content_type'] = array( + '#type' => 'head_tag', + '#tag_type' => 'meta', + '#attributes' => array( + 'http-equiv' => 'Content-Type', + 'content' => 'text/html; charset=utf-8', + ), + ); + // Send Drupal and the major version number in the META GENERATOR HTML. + $meta_elements['system_meta_generator'] = array( + '#type' => 'head_tag', + '#tag_type' => 'meta', + '#attributes' => array( + 'name' => 'Generator', + 'content' => 'Drupal ' . $version . ' (http://drupal.org)', + ), + ); + // Send Drupal and the major version number in the HTTP headers. + $meta_elements['system_meta_generator']['#attached']['drupal_set_header'][] = array('X-Generator', 'Drupal ' . $version . ' (http://drupal.org)'); + // Make sure the Content-Type comes first. + $head_elements = array_merge($meta_elements, $head_elements); + + drupal_alter('html_head', $head_elements); + return drupal_render($head_elements); } /** @@ -2503,9 +2542,47 @@ function base_path() { * Add a tag to the page's HEAD. * * This function can be called as long the HTML header hasn't been sent. + * + * @param $attributes + * Associative array of element attributes. + * @param $header + * Optional flag to determine if a HTTP LINK header should be sent. + */ +function drupal_add_link($attributes, $header = FALSE) { + $head_element = array( + '#type' => 'head_tag', + '#tag_type' => 'link', + '#attributes' => $attributes, + ); + + if ($header) { + $head_element['#attached']['drupal_set_link_header'][] = array($attributes); + } + + // Add a LINK element under the xhtml HEAD element. + drupal_add_html_head($head_element); +} + +/** + * Add a HTTP Link: header. + * + * @param $attributes + * Associative array of element attributes. */ -function drupal_add_link($attributes) { - drupal_add_html_head('\n"); +function drupal_set_link_header($attributes) { + // Mimic drupal_attributes() but with different seperators. + foreach ($attributes as $attribute => &$data) { + if ($attribute != 'href') { + if (is_array($data)) { + $data = implode(' ', $data); + } + $data = $attribute . '="' . check_plain($data) . '"'; + } + } + + $href = '<' . $attributes['href'] . '> '; + unset($attributes['href']); + drupal_set_header('Link', $href . implode('; ', $attributes), TRUE); } /** @@ -4612,6 +4689,9 @@ function drupal_common_theme() { 'indentation' => array( 'arguments' => array('size' => 1), ), + 'head_tag' => array( + 'arguments' => array('element' => NULL), + ), // from pager.inc 'pager' => array( 'arguments' => array('tags' => array(), 'element' => 0, 'parameters' => array(), 'quantity' => 9), diff --git includes/theme.inc includes/theme.inc index 9c646a0..39a9268 100644 --- includes/theme.inc +++ includes/theme.inc @@ -1843,6 +1843,15 @@ function theme_feed_icon($url, $title) { } /** + * Generate the output for an xhtml element in the head region of the page. + * + * @ingroup themeable + */ +function theme_head_tag(array $element) { + return '<' . $element['#tag_type'] . drupal_attributes($element['#attributes']) . " />\n"; +} + +/** * Returns code that emits the 'more' link used on blocks. * * @param $url @@ -2040,7 +2049,11 @@ function template_preprocess_page(&$variables) { if (theme_get_setting('toggle_favicon')) { $favicon = theme_get_setting('favicon'); $type = theme_get_setting('favicon_mimetype'); - drupal_add_html_head(''); + drupal_add_link(array( + 'rel' => 'shortcut icon', + 'href' => check_url($favicon), + 'type' => $type, + )); } // Set up layout variable. @@ -2214,7 +2227,11 @@ function template_preprocess_maintenance_page(&$variables) { if (theme_get_setting('toggle_favicon')) { $favicon = theme_get_setting('favicon'); $type = theme_get_setting('favicon_mimetype'); - drupal_add_html_head(''); + drupal_add_link(array( + 'rel' => 'shortcut icon', + 'href' => check_url($favicon), + 'type' => $type, + )); } global $theme; diff --git modules/comment/comment.module modules/comment/comment.module index f048a8b..ae33b30 100644 --- modules/comment/comment.module +++ modules/comment/comment.module @@ -349,9 +349,6 @@ function comment_permalink($comment) { $_GET['q'] = 'node/' . $node->nid; $_GET['page'] = $page; - // Set the node path as the canonical URL to prevent duplicate content. - drupal_add_link(array('rel' => 'canonical', 'href' => url('node/' . $node->nid))); - // Return the node view, this will show the correct comment in context. return menu_execute_active_handler('node/' . $node->nid); } diff --git modules/node/node.module modules/node/node.module index 0ae1104..9319ff0 100644 --- modules/node/node.module +++ modules/node/node.module @@ -1955,6 +1955,11 @@ function node_page_default() { */ function node_page_view($node) { drupal_set_title($node->title); + + // Set the node path as the canonical URL to prevent duplicate content. + drupal_add_link(array('rel' => 'canonical', 'href' => url('node/' . $node->nid)), TRUE); + // Set the non-aliased path as a default shortlink. + drupal_add_link(array('rel' => 'shortlink', 'href' => url('node/' . $node->nid, array('alias' => TRUE))), TRUE); return node_show($node); } diff --git modules/openid/tests/openid_test.module modules/openid/tests/openid_test.module index b101b50..51962e4 100644 --- modules/openid/tests/openid_test.module +++ modules/openid/tests/openid_test.module @@ -97,7 +97,14 @@ function openid_test_yadis_x_xrds_location() { * Menu callback; regular HTML page with element. */ function openid_test_yadis_http_equiv() { - drupal_add_html_head(''); + drupal_add_html_head(array( + '#type' => 'head_tag', + '#tag_type' => 'meta', + '#attributes' => array( + 'http-equiv' => 'X-XRDS-Location', + 'content' => url('openid-test/yadis/xrds', array('absolute' => TRUE)), + ), + )); return t('This page includes a <meta equiv=...> element containing the URL of an XRDS document.'); } @@ -105,7 +112,10 @@ function openid_test_yadis_http_equiv() { * Menu callback; regular HTML page with OpenID 1.0 element. */ function openid_test_html_openid1() { - drupal_add_html_head(''); + drupal_add_link(array( + 'rel' => 'openid.server', + 'href' => url('openid-test/endpoint', array('absolute' => TRUE)), + )); return t('This page includes a <link rel=...> element containing the URL of an OpenID Provider Endpoint.'); } @@ -113,7 +123,10 @@ function openid_test_html_openid1() { * Menu callback; regular HTML page with OpenID 2.0 element. */ function openid_test_html_openid2() { - drupal_add_html_head(''); + drupal_add_link(array( + 'rel' => 'openid2.provider', + 'href' => url('openid-test/endpoint', array('absolute' => TRUE)), + )); return t('This page includes a <link rel=...> element containing the URL of an OpenID Provider Endpoint.'); } diff --git modules/simpletest/tests/browser_test.module modules/simpletest/tests/browser_test.module index ea2ea8f..50f0e2d 100644 --- modules/simpletest/tests/browser_test.module +++ modules/simpletest/tests/browser_test.module @@ -61,7 +61,14 @@ function browser_test_print_post_form_submit($form, &$form_state) { function browser_test_refresh_meta() { if (!isset($_GET['refresh'])) { $url = url('browser_test/refresh/meta', array('absolute' => TRUE, 'query' => 'refresh=true')); - drupal_add_html_head(''); + drupal_add_html_head(array( + '#type' => 'head_tag', + '#tag_type' => 'meta', + '#attributes' => array( + 'http-equiv' => 'Refresh', + 'content' => '0; URL=' . $url, + ) + )); return ''; } echo 'Refresh successful'; diff --git modules/system/system.api.php modules/system/system.api.php index df2ff32..7a5920e 100644 --- modules/system/system.api.php +++ modules/system/system.api.php @@ -2213,6 +2213,28 @@ function hook_drupal_goto_alter(array $args) { } /** + * Alter xhtml HEAD tags before they are rendered by drupal_get_html_head(). + * + * Elements available to be altered are only those added using drupal_add_link() + * or drupal_add_html_head(). CSS and JS files are handled using + * drupal_add_css() and drupal_add_js(), so the head links for those files will + * not appear in the $head_elements array. + * + * @param $head_elements + * An array of renderable elements. The elements will have the keys #type, + * #value, #theme, and #attributes, and generally the elements of the + * #attributes array will be the most likely target for changes. + */ +function hook_html_head_alter(&$head_elements) { + foreach($head_elements as $key => $element) { + if (isset($element['#attributes']['rel']) && $element['#attributes']['rel'] == 'canonical') { + // I want a custom canonical url. + $element['#attributes']['href'] = mymodule_canonical_url(); + } + } +} + +/** * Alter MIME type mappings used to determine MIME type from a file extension. * * This hook is run when file_mimetype_mapping() is called. It is used to diff --git modules/system/system.module modules/system/system.module index 3eb3656..dece155 100644 --- modules/system/system.module +++ modules/system/system.module @@ -194,12 +194,6 @@ function system_theme() { 'system_powered_by' => array( 'arguments' => array('image_path' => NULL), ), - 'meta_generator_html' => array( - 'arguments' => array('version' => NULL), - ), - 'meta_generator_header' => array( - 'arguments' => array('version' => NULL), - ), 'system_compact_link' => array(), 'system_run_cron_image' => array( 'arguments' => array('image_path' => NULL), @@ -486,6 +480,10 @@ function system_elements() { '#theme' => array('hidden'), ); + $type['head_tag'] = array( + '#theme' => 'head_tag', + ); + return $type; } @@ -1496,22 +1494,6 @@ function system_init() { } /** - * Implement MODULE_preprocess_HOOK(). - */ -function system_preprocess_page(&$variables) { - // Get the major version - list($version, ) = explode('.', VERSION); - - // Emit the META tag in the HTML HEAD section - theme('meta_generator_html', $version); - - // Emit the HTTP Header too - theme('meta_generator_header', $version); - - $variables['head'] = drupal_get_html_head(); -} - -/** * Implement hook_user_form(). */ function system_user_form(&$edit, $account, $category) { @@ -3022,25 +3004,6 @@ function theme_system_compact_link() { return $output; } - -/** - * Send Drupal and the major version number in the META GENERATOR HTML. - * - * @ingroup themeable - */ -function theme_meta_generator_html($version = VERSION) { - drupal_add_html_head(''); -} - -/** - * Send Drupal and the major version number in the HTTP headers. - * - * @ingroup themeable - */ -function theme_meta_generator_header($version = VERSION) { - drupal_set_header('X-Generator', 'Drupal ' . $version . ' (http://drupal.org)'); -} - /** * Implement hook_image_toolkits(). */