content');
$this->assertEqual($f, '
content
', 'HTML corrector -- unclosed tag with attribute.');
// XHTML slash for empty elements.
$f = _filter_htmlcorrector('
');
$this->assertEqual($f, '
', 'HTML corrector -- XHTML closing slash.');
$f = _filter_htmlcorrector('
test
');
$this->assertEqual($f, '
test
', 'HTML corrector -- Convert uppercased tags to proper lowercased ones.');
$f = _filter_htmlcorrector('
test
');
$this->assertEqual($f, '
test
', 'HTML corrector -- Convert uppercased tags to proper lowercased ones.');
$f = _filter_htmlcorrector('test
');
$this->assertEqual($f, 'test
', 'HTML corrector -- Let proper XHTML pass through.');
$f = _filter_htmlcorrector('test
');
$this->assertEqual($f, 'test
', 'HTML corrector -- Let proper XHTML pass through, but ensure there is a single space before the closing slash.');
$f = _filter_htmlcorrector('test
');
$this->assertEqual($f, 'test
', 'HTML corrector -- Let proper XHTML pass through, but ensure there are not too many spaces before the closing slash.');
$f = _filter_htmlcorrector('
');
$this->assertEqual($f, '
', 'HTML corrector -- Convert XHTML that is properly formed but that would not be compatible with typical HTML user agents.');
$f = _filter_htmlcorrector('test1
test2');
$this->assertEqual($f, 'test1
test2', 'HTML corrector -- Automatically close single tags.');
$f = _filter_htmlcorrector('line1
line2');
$this->assertEqual($f, 'line1
line2', 'HTML corrector -- Automatically close single tags.');
$f = _filter_htmlcorrector('line1
line2');
$this->assertEqual($f, 'line1
line2', 'HTML corrector -- Automatically close single tags.');
$f = _filter_htmlcorrector('
test');
$this->assertEqual($f, '
test', 'HTML corrector -- Automatically close single tags.');
$f = _filter_htmlcorrector('
');
$this->assertEqual($f, '
', "HTML corrector -- Transform empty tags to a single closed tag if the tag's content model is EMPTY.");
$f = _filter_htmlcorrector('
');
$this->assertEqual($f, '
', "HTML corrector -- Do not transform empty tags to a single closed tag if the tag's content model is not EMPTY.");
$f = _filter_htmlcorrector('
line1
line2');
$this->assertEqual($f, '
line1
line2', 'HTML corrector -- Move non-inline elements outside of inline containers.');
$f = _filter_htmlcorrector('
line1
line2
');
$this->assertEqual($f, '
line1
line2
', 'HTML corrector -- Move non-inline elements outside of inline containers.');
$f = _filter_htmlcorrector('
test
test
\n');
$this->assertEqual($f, '
test
test
\n', 'HTML corrector -- Auto-close improperly nested tags.');
$f = _filter_htmlcorrector('
Line1bold stuff');
$this->assertEqual($f, 'Line1bold stuff
', 'HTML corrector -- Properly close unclosed tags, and remove useless closing tags.');
$f = _filter_htmlcorrector('test ');
$this->assertEqual($f, 'test ', 'HTML corrector -- Do not touch HTML comments.');
$f = _filter_htmlcorrector('test ');
$this->assertEqual($f, 'test ', 'HTML corrector -- Do not touch HTML comments.');
$f = _filter_htmlcorrector('test ');
$this->assertEqual($f, 'test ', 'HTML corrector -- Do not touch HTML comments.');
$f = _filter_htmlcorrector('test ');
$this->assertEqual($f, 'test ', 'HTML corrector -- Do not touch HTML comments.');
$f = _filter_htmlcorrector('test ');
$this->assertEqual($f, 'test ', 'HTML corrector -- Do not touch HTML comments.');
$f = _filter_htmlcorrector('test\n
\n');
$this->assertEqual($f, 'test\n
\n', 'HTML corrector -- New-lines are accepted and kept as-is.');
$f = _filter_htmlcorrector('دروبال');
$this->assertEqual($f, '
دروبال
', 'HTML corrector -- Encoding is correctly kept.');
$f = _filter_htmlcorrector('');
$this->assertEqual($f, '', 'HTML corrector -- CDATA added to script element');
$f = _filter_htmlcorrector('
');
$this->assertEqual($f, '
', 'HTML corrector -- CDATA added to a nested script element');
$f = _filter_htmlcorrector('
');
$this->assertEqual($f, '
', 'HTML corrector -- CDATA added to a style element.');
$filtered_data = _filter_htmlcorrector('
');
$this->assertEqual($filtered_data, '
',
format_string('HTML corrector -- Existing cdata section @pattern_name properly escaped', array('@pattern_name' => '/*
');
$this->assertEqual($filtered_data, '
',
format_string('HTML corrector -- Existing cdata section @pattern_name properly escaped', array('@pattern_name' => '
');
$this->assertEqual($filtered_data, '
',
format_string('HTML corrector -- Existing cdata section @pattern_name properly escaped', array('@pattern_name' => '
',
format_string('HTML corrector -- Existing cdata section @pattern_name properly escaped', array('@pattern_name' => '// assertTrue(strpos(strtolower(decode_entities($haystack)), $needle) !== FALSE, $message, $group);
}
/**
* Asserts that text transformed to lowercase with HTML entities decoded does not contain a given string.
*
* Otherwise fails the test with a given message, similar to all the
* SimpleTest assert* functions.
*
* Note that this does not remove nulls, new lines, and other character that
* could be used to obscure a tag or an attribute name.
*
* @param $haystack
* Text to look in.
* @param $needle
* Lowercase, plain text to look for.
* @param $message
* (optional) Message to display if failed. Defaults to an empty string.
* @param $group
* (optional) The group this message belongs to. Defaults to 'Other'.
* @return
* TRUE on pass, FALSE on fail.
*/
function assertNoNormalized($haystack, $needle, $message = '', $group = 'Other') {
return $this->assertTrue(strpos(strtolower(decode_entities($haystack)), $needle) === FALSE, $message, $group);
}
}
/**
* Tests for Filter's hook invocations.
*/
class FilterHooksTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Filter format hooks',
'description' => 'Test hooks for text formats insert/update/disable.',
'group' => 'Filter',
);
}
function setUp() {
parent::setUp('block', 'filter_test');
$admin_user = $this->drupalCreateUser(array('administer filters', 'administer blocks'));
$this->drupalLogin($admin_user);
}
/**
* Tests hooks on format management.
*
* Tests that hooks run correctly on creating, editing, and deleting a text
* format.
*/
function testFilterHooks() {
// Add a text format.
$name = $this->randomName();
$edit = array();
$edit['format'] = drupal_strtolower($this->randomName());
$edit['name'] = $name;
$edit['roles[' . DRUPAL_ANONYMOUS_RID . ']'] = 1;
$this->drupalPost('admin/config/content/formats/add', $edit, t('Save configuration'));
$this->assertRaw(t('Added text format %format.', array('%format' => $name)), 'New format created.');
$this->assertText('hook_filter_format_insert invoked.', 'hook_filter_format_insert was invoked.');
$format_id = $edit['format'];
// Update text format.
$edit = array();
$edit['roles[' . DRUPAL_AUTHENTICATED_RID . ']'] = 1;
$this->drupalPost('admin/config/content/formats/' . $format_id, $edit, t('Save configuration'));
$this->assertRaw(t('The text format %format has been updated.', array('%format' => $name)), 'Format successfully updated.');
$this->assertText('hook_filter_format_update invoked.', 'hook_filter_format_update() was invoked.');
// Add a new custom block.
$custom_block = array();
$custom_block['info'] = $this->randomName(8);
$custom_block['title'] = $this->randomName(8);
$custom_block['body[value]'] = $this->randomName(32);
// Use the format created.
$custom_block['body[format]'] = $format_id;
$this->drupalPost('admin/structure/block/add', $custom_block, t('Save block'));
$this->assertText(t('The block has been created.'), 'New block successfully created.');
// Verify the new block is in the database.
$bid = db_query("SELECT bid FROM {block_custom} WHERE info = :info", array(':info' => $custom_block['info']))->fetchField();
$this->assertNotNull($bid, 'New block found in database');
// Disable the text format.
$this->drupalPost('admin/config/content/formats/' . $format_id . '/disable', array(), t('Disable'));
$this->assertRaw(t('Disabled text format %format.', array('%format' => $name)), 'Format successfully disabled.');
$this->assertText('hook_filter_format_disable invoked.', 'hook_filter_format_disable() was invoked.');
}
}
/**
* Tests filter settings.
*/
class FilterSettingsTestCase extends DrupalWebTestCase {
/**
* The installation profile to use with this test class.
*
* @var string
*/
protected $profile = 'testing';
public static function getInfo() {
return array(
'name' => 'Filter settings',
'description' => 'Tests filter settings.',
'group' => 'Filter',
);
}
/**
* Tests explicit and implicit default settings for filters.
*/
function testFilterDefaults() {
$filter_info = filter_filter_info();
$filters = array_fill_keys(array_keys($filter_info), array());
// Create text format using filter default settings.
$filter_defaults_format = (object) array(
'format' => 'filter_defaults',
'name' => 'Filter defaults',
'filters' => $filters,
);
filter_format_save($filter_defaults_format);
// Verify that default weights defined in hook_filter_info() were applied.
$saved_settings = array();
foreach ($filter_defaults_format->filters as $name => $settings) {
$expected_weight = (isset($filter_info[$name]['weight']) ? $filter_info[$name]['weight'] : 0);
$this->assertEqual($settings['weight'], $expected_weight, format_string('@name filter weight %saved equals %default', array(
'@name' => $name,
'%saved' => $settings['weight'],
'%default' => $expected_weight,
)));
$saved_settings[$name]['weight'] = $expected_weight;
}
// Re-save the text format.
filter_format_save($filter_defaults_format);
// Reload it from scratch.
filter_formats_reset();
$filter_defaults_format = filter_format_load($filter_defaults_format->format);
$filter_defaults_format->filters = filter_list_format($filter_defaults_format->format);
// Verify that saved filter settings have not been changed.
foreach ($filter_defaults_format->filters as $name => $settings) {
$this->assertEqual($settings->weight, $saved_settings[$name]['weight'], format_string('@name filter weight %saved equals %previous', array(
'@name' => $name,
'%saved' => $settings->weight,
'%previous' => $saved_settings[$name]['weight'],
)));
}
}
}
/**
* Tests DOMDocument serialization.
*/
class FilterDOMSerializeTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Serialization',
'description' => 'Test serialization of DOMDocument objects.',
'group' => 'Filter',
);
}
/**
* Tests empty DOMDocument object.
*/
function testFilterEmptyDOMSerialization() {
$document = new DOMDocument();
$result = filter_dom_serialize($document);
$this->assertEqual('', $result);
}
}
This is just a www.test.com. paragraph with person@test.com. some http://www.test.com. urls thrown in and also
using www.test.com the code tag.
This is just a www.test.com. paragraph with person@test.com. some http://www.test.com. urls thrown in and also using www.test.com the code tag.
Testing code tag http://www.test.com abc
http://www.test.com
www.test.com
person@test.com
www.test.com
What about tags that don't exist
like x say www.test.com ? And what about tag
beginning www.test.com with p?
Test <br/>: This is just a www.test.com. paragraph
with some http://www.test.com urls thrown in. *
This is just a www.test.com paragraph *
with some http://www.test.com urls thrown in. *
This is just a www.test.com paragraph person@test.com with some http://www.test.com urls *img*
thrown in. This is just a www.test.com paragraph with some http://www.test.com urls thrown in. This is just a www.test.com paragraph person@test.com with some http://www.test.com urls thrown in.
This is just a www.test.com paragraph
with some http://www.test.com urls thrown in.
This is just a www.test.com paragraph with some http://www.test.com urls thrown in. This is just a www.test.com paragraph person@test.com with some http://www.test.com urls thrown in. This is just a www.test.com paragraph with some http://www.test.com urls thrown in. This is just a www.test.com paragraph person@test.com with some http://www.test.com urls thrown in.
The old URL filter has problems with
this kind of link with www address as part of text in title. www.test.com
www.test.com
http://www.test.com
person@test.com
check www.test.com
this with some text around: http://www.test.com not so easy person@test.com now?
This is the end!This is just a
www.test.com . paragraph with
person@test.com . some
http://www.test.com . urls thrown in and also
using www.test.com the code tag.
This is just a www.test.com . paragraph with person@test.com . some http://www.test.com . urls thrown in and also using www.test.com the code tag.
Testing code tag http://www.test.com abc
http://www.test.com
www.test.com
person@test.com
www.test.com
What about tags that don't exist
like x say www.test.com ? And what about tag
beginning www.test.com with p?
Test <br/>: This is just a
www.test.com . paragraph
with some
http://www.test.com urls thrown in. *
This is just a
www.test.com paragraph *
with some
http://www.test.com urls thrown in. *
This is just a
www.test.com paragraph
person@test.com with some
http://www.test.com urls *img*
thrown in. This is just a
www.test.com paragraph with some
http://www.test.com urls thrown in. This is just a
www.test.com paragraph
person@test.com with some
http://www.test.com urls thrown in.
This is just a
www.test.com paragraph
with some
http://www.test.com urls thrown in.
This is just a
www.test.com paragraph with some
http://www.test.com urls thrown in. This is just a
www.test.com paragraph
person@test.com with some
http://www.test.com urls thrown in. This is just a
www.test.com paragraph with some
http://www.test.com urls thrown in. This is just a
www.test.com paragraph
person@test.com with some
http://www.test.com urls thrown in.
The old URL filter has problems with
this kind of link with www address as part of text in title.
www.test.com
www.test.com http://www.test.com person@test.com check www.test.com
this with some text around: http://www.test.com not so easy person@test.com now?
This is the end!
is_container: TRUE if the forum can contain other forums. FALSE
* if the forum can contain only topics.
* - $forum->depth: How deep the forum is in the current hierarchy.
* - $forum->zebra: 'even' or 'odd' string used for row class.
* - $forum->icon_class: 'default' or 'new' string used for forum icon class.
* - $forum->icon_title: Text alternative for the forum icon.
* - $forum->name: The name of the forum.
* - $forum->link: The URL to link to this forum.
* - $forum->description: The description of this forum.
* - $forum->new_topics: TRUE if the forum contains unread posts.
* - $forum->new_url: A URL to the forum's unread posts.
* - $forum->new_text: Text for the above URL, which tells how many new posts.
* - $forum->old_topics: A count of posts that have already been read.
* - $forum->num_posts: The total number of posts in the forum.
* - $forum->last_reply: Text representing the last time a forum was posted or
* commented in.
* - $forum_id: Forum ID for the current forum. Parent to all items within the
* $forums array.
*
* @see template_preprocess_forum_list()
* @see theme_forum_list()
*
* @ingroup themeable
*/
?>
$forum): ?>
is_container ? 'colspan="4" class="container"' : 'class="forum"'; ?>>
', $forum->depth); ?>
icon_title; ?>
description): ?>
description; ?>
', $forum->depth); ?>
is_container): ?>
num_topics ?>
new_topics): ?>
new_text; ?>
num_posts ?>
last_reply ?>
/**
* @file
* Right-to-left styling for the Forum module.
*/
#forum td.forum .icon {
float: right;
margin: 0 0 0 9px;
}
#forum div.indent {
margin-left: 0;
margin-right: 20px;
}
.forum-topic-navigation {
padding: 1em 3em 0 0;
}
.forum-topic-navigation .topic-previous {
text-align: left;
float: right;
}
.forum-topic-navigation .topic-next {
text-align: right;
float: left;
}
$time,
'!author' => $author,
)); ?>
icon: The icon to display.
* - $topic->moved: A flag to indicate whether the topic has been moved to
* another forum.
* - $topic->title: The title of the topic. Safe to output.
* - $topic->message: If the topic has been moved, this contains an
* explanation and a link.
* - $topic->zebra: 'even' or 'odd' string used for row class.
* - $topic->comment_count: The number of replies on this topic.
* - $topic->new_replies: A flag to indicate whether there are unread
* comments.
* - $topic->new_url: If there are unread replies, this is a link to them.
* - $topic->new_text: Text containing the translated, properly pluralized
* count.
* - $topic->created: A string representing when the topic was posted. Safe
* to output.
* - $topic->last_reply: An outputtable string representing when the topic was
* last replied to.
* - $topic->timestamp: The raw timestamp this topic was posted.
* - $topic_id: Numeric ID for the current forum topic.
*
* @see template_preprocess_forum_topic_list()
* @see theme_forum_topic_list()
*
* @ingroup themeable
*/
?>
icon; ?>
title; ?>
created; ?>
moved): ?>
message; ?>
comment_count; ?>
new_replies): ?>
new_text; ?>
last_reply; ?>
'',
'description' => '',
'tid' => NULL,
'weight' => 0,
);
$form['name'] = array('#type' => 'textfield',
'#title' => t('Forum name'),
'#default_value' => $edit['name'],
'#maxlength' => 255,
'#description' => t('Short but meaningful name for this collection of threaded discussions.'),
'#required' => TRUE,
);
$form['description'] = array('#type' => 'textarea',
'#title' => t('Description'),
'#default_value' => $edit['description'],
'#description' => t('Description and guidelines for discussions within this forum.'),
);
$form['parent']['#tree'] = TRUE;
$form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'forum');
$form['weight'] = array('#type' => 'weight',
'#title' => t('Weight'),
'#default_value' => $edit['weight'],
'#description' => t('Forums are displayed in ascending order by weight (forums with equal weights are displayed alphabetically).'),
);
$form['vid'] = array('#type' => 'hidden', '#value' => variable_get('forum_nav_vocabulary', ''));
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array('#type' => 'submit', '#value' => t('Save'));
if ($edit['tid']) {
$form['actions']['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
$form['tid'] = array('#type' => 'hidden', '#value' => $edit['tid']);
}
$form['#submit'][] = 'forum_form_submit';
$form['#theme'] = 'forum_form';
return $form;
}
/**
* Form submission handler for forum_form_forum() and forum_form_container().
*/
function forum_form_submit($form, &$form_state) {
if ($form['form_id']['#value'] == 'forum_form_container') {
$container = TRUE;
$type = t('forum container');
}
else {
$container = FALSE;
$type = t('forum');
}
$term = (object) $form_state['values'];
$status = taxonomy_term_save($term);
switch ($status) {
case SAVED_NEW:
if ($container) {
$containers = variable_get('forum_containers', array());
$containers[] = $term->tid;
variable_set('forum_containers', $containers);
}
$form_state['values']['tid'] = $term->tid;
drupal_set_message(t('Created new @type %term.', array('%term' => $form_state['values']['name'], '@type' => $type)));
break;
case SAVED_UPDATED:
drupal_set_message(t('The @type %term has been updated.', array('%term' => $form_state['values']['name'], '@type' => $type)));
// Clear the page and block caches to avoid stale data.
cache_clear_all();
break;
}
$form_state['redirect'] = 'admin/structure/forum';
return;
}
/**
* Returns HTML for a forum form.
*
* By default this does not alter the appearance of a form at all, but is
* provided as a convenience for themers.
*
* @param $variables
* An associative array containing:
* - form: A render element representing the form.
*
* @ingroup themeable
*/
function theme_forum_form($variables) {
return drupal_render_children($variables['form']);
}
/**
* Form constructor for adding and editing forum containers.
*
* @param $edit
* (optional) Associative array containing a container term to be added or edited.
* Defaults to an empty array.
*
* @see forum_form_submit()
* @ingroup forms
*/
function forum_form_container($form, &$form_state, $edit = array()) {
$edit += array(
'name' => '',
'description' => '',
'tid' => NULL,
'weight' => 0,
);
// Handle a delete operation.
$form['name'] = array(
'#title' => t('Container name'),
'#type' => 'textfield',
'#default_value' => $edit['name'],
'#maxlength' => 255,
'#description' => t('Short but meaningful name for this collection of related forums.'),
'#required' => TRUE
);
$form['description'] = array(
'#type' => 'textarea',
'#title' => t('Description'),
'#default_value' => $edit['description'],
'#description' => t('Description and guidelines for forums within this container.')
);
$form['parent']['#tree'] = TRUE;
$form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'container');
$form['weight'] = array(
'#type' => 'weight',
'#title' => t('Weight'),
'#default_value' => $edit['weight'],
'#description' => t('Containers are displayed in ascending order by weight (containers with equal weights are displayed alphabetically).')
);
$form['vid'] = array(
'#type' => 'hidden',
'#value' => variable_get('forum_nav_vocabulary', ''),
);
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Save')
);
if ($edit['tid']) {
$form['actions']['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
$form['tid'] = array('#type' => 'value', '#value' => $edit['tid']);
}
$form['#submit'][] = 'forum_form_submit';
$form['#theme'] = 'forum_form';
return $form;
}
/**
* Form constructor for confirming deletion of a forum taxonomy term.
*
* @param $tid
* ID of the term to be deleted.
*
* @see forum_confirm_delete_submit()
* @ingroup forms
*/
function forum_confirm_delete($form, &$form_state, $tid) {
$term = taxonomy_term_load($tid);
$form['tid'] = array('#type' => 'value', '#value' => $tid);
$form['name'] = array('#type' => 'value', '#value' => $term->name);
return confirm_form($form, t('Are you sure you want to delete the forum %name?', array('%name' => $term->name)), 'admin/structure/forum', t('Deleting a forum or container will also delete its sub-forums, if any. To delete posts in this forum, visit
content administration first. This action cannot be undone.', array('@content' => url('admin/content'))), t('Delete'), t('Cancel'));
}
/**
* Form submission handler for forum_confirm_delete().
*/
function forum_confirm_delete_submit($form, &$form_state) {
taxonomy_term_delete($form_state['values']['tid']);
drupal_set_message(t('The forum %term and all sub-forums have been deleted.', array('%term' => $form_state['values']['name'])));
watchdog('content', 'forum: deleted %term and all its sub-forums.', array('%term' => $form_state['values']['name']));
$form_state['redirect'] = 'admin/structure/forum';
return;
}
/**
* Form constructor for the forum settings page.
*
* @see forum_menu()
* @see system_settings_form()
* @ingroup forms
*/
function forum_admin_settings($form) {
$number = drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 50, 60, 80, 100, 150, 200, 250, 300, 350, 400, 500));
$form['forum_hot_topic'] = array('#type' => 'select',
'#title' => t('Hot topic threshold'),
'#default_value' => variable_get('forum_hot_topic', 15),
'#options' => $number,
'#description' => t('The number of replies a topic must have to be considered "hot".'),
);
$number = drupal_map_assoc(array(10, 25, 50, 75, 100));
$form['forum_per_page'] = array('#type' => 'select',
'#title' => t('Topics per page'),
'#default_value' => variable_get('forum_per_page', 25),
'#options' => $number,
'#description' => t('Default number of forum topics displayed per page.'),
);
$forder = array(1 => t('Date - newest first'), 2 => t('Date - oldest first'), 3 => t('Posts - most active first'), 4 => t('Posts - least active first'));
$form['forum_order'] = array('#type' => 'radios',
'#title' => t('Default order'),
'#default_value' => variable_get('forum_order', 1),
'#options' => $forder,
'#description' => t('Default display order for topics.'),
);
return system_settings_form($form);
}
/**
* Form constructor for the forum overview form.
*
* Returns a form for controlling the hierarchy of existing forums and
* containers.
*
* @see forum_menu()
* @ingroup forms
*/
function forum_overview($form, &$form_state) {
module_load_include('inc', 'taxonomy', 'taxonomy.admin');
$vid = variable_get('forum_nav_vocabulary', '');
$vocabulary = taxonomy_vocabulary_load($vid);
$form = taxonomy_overview_terms($form, $form_state, $vocabulary);
foreach (element_children($form) as $key) {
if (isset($form[$key]['#term'])) {
$term = $form[$key]['#term'];
$form[$key]['view']['#href'] = 'forum/' . $term['tid'];
if (in_array($form[$key]['#term']['tid'], variable_get('forum_containers', array()))) {
$form[$key]['edit']['#title'] = t('edit container');
$form[$key]['edit']['#href'] = 'admin/structure/forum/edit/container/' . $term['tid'];
}
else {
$form[$key]['edit']['#title'] = t('edit forum');
$form[$key]['edit']['#href'] = 'admin/structure/forum/edit/forum/' . $term['tid'];
}
}
}
// Remove the alphabetical reset.
unset($form['actions']['reset_alphabetical']);
// The form needs to have submit and validate handlers set explicitly.
$form['#theme'] = 'taxonomy_overview_terms';
$form['#submit'] = array('taxonomy_overview_terms_submit'); // Use the existing taxonomy overview submit handler.
$form['#empty_text'] = t('No containers or forums available.
Add container or
Add forum .', array('@container' => url('admin/structure/forum/add/container'), '@forum' => url('admin/structure/forum/add/forum')));
return $form;
}
/**
* Returns a select box for available parent terms.
*
* @param $tid
* ID of the term that is being added or edited.
* @param $title
* Title for the select box.
* @param $child_type
* Whether the child is a forum or a container.
*
* @return
* A select form element.
*/
function _forum_parent_select($tid, $title, $child_type) {
$parents = taxonomy_get_parents($tid);
if ($parents) {
$parent = array_shift($parents);
$parent = $parent->tid;
}
else {
$parent = 0;
}
$vid = variable_get('forum_nav_vocabulary', '');
$children = taxonomy_get_tree($vid, $tid);
// A term can't be the child of itself, nor of its children.
foreach ($children as $child) {
$exclude[] = $child->tid;
}
$exclude[] = $tid;
$tree = taxonomy_get_tree($vid);
$options[0] = '<' . t('root') . '>';
if ($tree) {
foreach ($tree as $term) {
if (!in_array($term->tid, $exclude)) {
$options[$term->tid] = str_repeat(' -- ', $term->depth) . $term->name;
}
}
}
if ($child_type == 'container') {
$description = t('Containers are usually placed at the top (root) level, but may also be placed inside another container or forum.');
}
elseif ($child_type == 'forum') {
$description = t('Forums may be placed at the top (root) level, or inside another container or forum.');
}
return array('#type' => 'select', '#title' => $title, '#default_value' => $parent, '#options' => $options, '#description' => $description, '#required' => TRUE);
}
/**
* @file
* Styling for the Forum module.
*/
#forum .description {
font-size: 0.9em;
margin: 0.5em;
}
#forum td.created,
#forum td.posts,
#forum td.topics,
#forum td.last-reply,
#forum td.replies,
#forum td.pager {
white-space: nowrap;
}
#forum td.forum .icon {
background-image: url(../../misc/forum-icons.png);
background-repeat: no-repeat;
float: left; /* LTR */
height: 24px;
margin: 0 9px 0 0; /* LTR */
width: 24px;
}
#forum td.forum .forum-status-new {
background-position: -24px 0;
}
#forum div.indent {
margin-left: 20px; /* LTR */
}
#forum .icon div {
background-image: url(../../misc/forum-icons.png);
background-repeat: no-repeat;
width: 24px;
height: 24px;
}
#forum .icon .topic-status-new {
background-position: -24px 0;
}
#forum .icon .topic-status-hot {
background-position: -48px 0;
}
#forum .icon .topic-status-hot-new {
background-position: -72px 0;
}
#forum .icon .topic-status-sticky {
background-position: -96px 0;
}
#forum .icon .topic-status-closed {
background-position: -120px 0;
}
name = Forum
description = Provides discussion forums.
dependencies[] = taxonomy
dependencies[] = comment
package = Core
version = VERSION
core = 7.x
files[] = forum.test
configure = admin/structure/forum
stylesheets[all][] = forum.css
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
fields(array('weight' => 1))
->condition('name', 'forum')
->execute();
// Forum topics are published by default, but do not have any other default
// options set (for example, they are not promoted to the front page).
variable_set('node_options_forum', array('status'));
}
/**
* Implements hook_enable().
*/
function forum_enable() {
// If we enable forum at the same time as taxonomy we need to call
// field_associate_fields() as otherwise the field won't be enabled until
// hook modules_enabled is called which takes place after hook_enable events.
field_associate_fields('taxonomy');
// Create the forum vocabulary if it does not exist.
$vocabulary = taxonomy_vocabulary_load(variable_get('forum_nav_vocabulary', 0));
if (!$vocabulary) {
$edit = array(
'name' => t('Forums'),
'machine_name' => 'forums',
'description' => t('Forum navigation vocabulary'),
'hierarchy' => 1,
'module' => 'forum',
'weight' => -10,
);
$vocabulary = (object) $edit;
taxonomy_vocabulary_save($vocabulary);
variable_set('forum_nav_vocabulary', $vocabulary->vid);
}
// Create the 'taxonomy_forums' field if it doesn't already exist.
if (!field_info_field('taxonomy_forums')) {
$field = array(
'field_name' => 'taxonomy_forums',
'type' => 'taxonomy_term_reference',
'settings' => array(
'allowed_values' => array(
array(
'vocabulary' => $vocabulary->machine_name,
'parent' => 0,
),
),
),
);
field_create_field($field);
// Create a default forum so forum posts can be created.
$edit = array(
'name' => t('General discussion'),
'description' => '',
'parent' => array(0),
'vid' => $vocabulary->vid,
);
$term = (object) $edit;
taxonomy_term_save($term);
// Create the instance on the bundle.
$instance = array(
'field_name' => 'taxonomy_forums',
'entity_type' => 'node',
'label' => $vocabulary->name,
'bundle' => 'forum',
'required' => TRUE,
'widget' => array(
'type' => 'options_select',
),
'display' => array(
'default' => array(
'type' => 'taxonomy_term_reference_link',
'weight' => 10,
),
'teaser' => array(
'type' => 'taxonomy_term_reference_link',
'weight' => 10,
),
),
);
field_create_instance($instance);
}
// Ensure the forum node type is available.
node_types_rebuild();
$types = node_type_get_types();
node_add_body_field($types['forum']);
}
/**
* Implements hook_uninstall().
*/
function forum_uninstall() {
// Load the dependent Taxonomy module, in case it has been disabled.
drupal_load('module', 'taxonomy');
variable_del('forum_containers');
variable_del('forum_hot_topic');
variable_del('forum_per_page');
variable_del('forum_order');
variable_del('forum_block_num_active');
variable_del('forum_block_num_new');
variable_del('node_options_forum');
field_delete_field('taxonomy_forums');
// Purge field data now to allow taxonomy module to be uninstalled
// if this is the only field remaining.
field_purge_batch(10);
}
/**
* Implements hook_schema().
*/
function forum_schema() {
$schema['forum'] = array(
'description' => 'Stores the relationship of nodes to forum terms.',
'fields' => array(
'nid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => 'The {node}.nid of the node.',
),
'vid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => 'Primary Key: The {node}.vid of the node.',
),
'tid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => 'The {taxonomy_term_data}.tid of the forum term assigned to the node.',
),
),
'indexes' => array(
'forum_topic' => array('nid', 'tid'),
'tid' => array('tid'),
),
'primary key' => array('vid'),
'foreign keys' => array(
'forum_node' => array(
'table' => 'node',
'columns' => array(
'nid' => 'nid',
'vid' => 'vid',
),
),
),
);
$schema['forum_index'] = array(
'description' => 'Maintains denormalized information about node/term relationships.',
'fields' => array(
'nid' => array(
'description' => 'The {node}.nid this record tracks.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
),
'title' => array(
'description' => 'The title of this node, always treated as non-markup plain text.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'tid' => array(
'description' => 'The term ID.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
),
'sticky' => array(
'description' => 'Boolean indicating whether the node is sticky.',
'type' => 'int',
'not null' => FALSE,
'default' => 0,
'size' => 'tiny',
),
'created' => array(
'description' => 'The Unix timestamp when the node was created.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default'=> 0,
),
'last_comment_timestamp' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'The Unix timestamp of the last comment that was posted within this node, from {comment}.timestamp.',
),
'comment_count' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => 'The total number of comments on this node.',
),
),
'indexes' => array(
'forum_topics' => array('nid', 'tid', 'sticky', 'last_comment_timestamp'),
'created' => array('created'),
'last_comment_timestamp' => array('last_comment_timestamp'),
),
'foreign keys' => array(
'tracked_node' => array(
'table' => 'node',
'columns' => array('nid' => 'nid'),
),
'term' => array(
'table' => 'taxonomy_term_data',
'columns' => array(
'tid' => 'tid',
),
),
),
);
return $schema;
}
/**
* Implements hook_update_dependencies().
*/
function forum_update_dependencies() {
$dependencies['forum'][7003] = array(
// Forum update 7003 uses field API update functions, so must run after
// Field API has been enabled.
'system' => 7020,
// Forum update 7003 relies on updated taxonomy module schema. Ensure it
// runs after all taxonomy updates.
'taxonomy' => 7010,
);
return $dependencies;
}
/**
* Add new index to forum table.
*/
function forum_update_7000() {
db_drop_index('forum', 'nid');
db_add_index('forum', 'forum_topic', array('nid', 'tid'));
}
/**
* Create new {forum_index} table.
*/
function forum_update_7001() {
$forum_index = array(
'description' => 'Maintains denormalized information about node/term relationships.',
'fields' => array(
'nid' => array(
'description' => 'The {node}.nid this record tracks.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
),
'title' => array(
'description' => 'The title of this node, always treated as non-markup plain text.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'tid' => array(
'description' => 'The term ID.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
),
'sticky' => array(
'description' => 'Boolean indicating whether the node is sticky.',
'type' => 'int',
'not null' => FALSE,
'default' => 0,
'size' => 'tiny',
),
'created' => array(
'description' => 'The Unix timestamp when the node was created.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default'=> 0,
),
'last_comment_timestamp' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'The Unix timestamp of the last comment that was posted within this node, from {comment}.timestamp.',
),
'comment_count' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => 'The total number of comments on this node.',
),
),
'indexes' => array(
'forum_topics' => array('tid', 'sticky', 'last_comment_timestamp'),
),
'foreign keys' => array(
'tracked_node' => array(
'table' => 'node',
'columns' => array('nid' => 'nid'),
),
'term' => array(
'table' => 'taxonomy_term_data',
'columns' => array(
'tid' => 'tid',
),
),
),
);
db_create_table('forum_index', $forum_index);
$select = db_select('node', 'n');
$forum_alias = $select->join('forum', 'f', 'n.vid = f.vid');
$ncs_alias = $select->join('node_comment_statistics', 'ncs', 'n.nid = ncs.nid');
$select
->fields('n', array('nid', 'title', 'sticky', 'created'))
->fields($forum_alias, array('tid'))
->fields($ncs_alias, array('last_comment_timestamp', 'comment_count'));
db_insert('forum_index')
->fields(array('nid', 'title', 'sticky', 'created', 'tid', 'last_comment_timestamp', 'comment_count'))
->from($select)
->execute();
}
/**
* @addtogroup updates-7.x-extra
* @{
*/
/**
* Add new index to forum_index table.
*/
function forum_update_7002() {
db_drop_index('forum_index', 'forum_topics');
db_add_index('forum_index', 'forum_topics', array('nid', 'tid', 'sticky', 'last_comment_timestamp'));
}
/**
* Rename field to 'taxonomy_forums'.
*/
function forum_update_7003() {
$messages = array();
$new_field_name = 'taxonomy_forums';
// Test to see if the taxonomy_forums field exists.
$fields = _update_7000_field_read_fields(array('field_name' => $new_field_name));
if ($fields) {
// Since the field exists, we're done.
return;
}
// Calculate the old field name.
$vid = variable_get('forum_nav_vocabulary', 0);
$vocabulary_machine_name = db_select('taxonomy_vocabulary', 'tv')
->fields('tv', array('machine_name'))
->condition('vid', $vid)
->execute()
->fetchField();
$old_field_name = 'taxonomy_' . $vocabulary_machine_name;
// Read the old fields.
$old_fields = _update_7000_field_read_fields(array('field_name' => $old_field_name));
foreach ($old_fields as $old_field) {
if ($old_field['storage']['type'] != 'field_sql_storage') {
$messages[] = t('Cannot rename field %id (%old_field_name) to %new_field_name because it does not use the field_sql_storage storage type.', array(
'%id' => $old_field['id'],
'%old_field_name' => $old_field_name,
'%new_field_name' => $new_field_name,
));
continue;
}
// Update {field_config}.
db_update('field_config')
->fields(array('field_name' => $new_field_name))
->condition('id', $old_field['id'])
->execute();
// Update {field_config_instance}.
db_update('field_config_instance')
->fields(array('field_name' => $new_field_name))
->condition('field_id', $old_field['id'])
->execute();
// The tables that need updating in the form 'old_name' => 'new_name'.
$tables = array(
'field_data_' . $old_field_name => 'field_data_' . $new_field_name,
'field_revision_' . $old_field_name => 'field_revision_' . $new_field_name,
);
foreach ($tables as $old_table => $new_table) {
$old_column_name = $old_field_name . '_tid';
$new_column_name = $new_field_name . '_tid';
// Rename the column.
db_drop_index($old_table, $old_column_name);
db_change_field($old_table, $old_column_name, $new_column_name, array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => FALSE,
));
db_drop_index($old_table, $new_column_name);
db_add_index($old_table, $new_column_name, array($new_column_name));
// Rename the table.
db_rename_table($old_table, $new_table);
}
}
cache_clear_all('*', 'cache_field', TRUE);
return $messages;
}
/**
* Update {forum_index} so that only published nodes are indexed.
*/
function forum_update_7011() {
$select = db_select('node', 'n')
->fields('n', array('nid'))
->condition('status', 0 );
db_delete('forum_index')
->condition('nid', $select, 'IN')
->execute();
}
/**
* Add 'created' and 'last_comment_timestamp' indexes.
*/
function forum_update_7012() {
db_add_index('forum_index', 'created', array('created'));
db_add_index('forum_index', 'last_comment_timestamp', array('last_comment_timestamp'));
}
/**
* @} End of "addtogroup updates-7.x-extra".
*/
' . t('About') . '';
$output .= '
' . t('The Forum module lets you create threaded discussion forums with functionality similar to other message board systems. Forums are useful because they allow community members to discuss topics with one another while ensuring those conversations are archived for later reference. In a forum, users post topics and threads in nested hierarchies, allowing discussions to be categorized and grouped. The forum hierarchy consists of:') . '
';
$output .= '
';
$output .= '' . t('Optional containers (for example, Support ), which can hold:') . ' ';
$output .= '' . t('Forums (for example, Installing Drupal ), which can hold:') . ' ';
$output .= '' . t('Forum topics submitted by users (for example, How to start a Drupal 6 Multisite ), which start discussions and are starting points for:') . ' ';
$output .= '' . t('Threaded comments submitted by users (for example, You have these options... ).') . ' ';
$output .= ' ';
$output .= '
' . t('For more information, see the online handbook entry for Forum module .', array('@forum' => 'http://drupal.org/documentation/modules/forum')) . '
';
$output .= '
' . t('Uses') . ' ';
$output .= '
';
$output .= '' . t('Setting up forum structure') . ' ';
$output .= '' . t('Visit the Forums page to set up containers and forums to hold your discussion topics.', array('@forums' => url('admin/structure/forum'))) . ' ';
$output .= '' . t('Starting a discussion') . ' ';
$output .= '' . t('The Forum topic link on the Add new content page creates the first post of a new threaded discussion, or thread.', array('@create-topic' => url('node/add/forum'), '@content-add' => url('node/add'))) . ' ';
$output .= '' . t('Navigation') . ' ';
$output .= '' . t('Enabling the Forum module provides a default Forums menu item in the navigation menu that links to the Forums page .', array('@forums' => url('forum'))) . ' ';
$output .= '' . t('Moving forum topics') . ' ';
$output .= '' . t('A forum topic (and all of its comments) may be moved between forums by selecting a different forum while editing a forum topic. When moving a forum topic between forums, the Leave shadow copy option creates a link in the original forum pointing to the new location.') . ' ';
$output .= '' . t('Locking and disabling comments') . ' ';
$output .= '' . t('Selecting Closed under Comment settings while editing a forum topic will lock (prevent new comments on) the thread. Selecting Hidden under Comment settings while editing a forum topic will hide all existing comments on the thread, and prevent new ones.') . ' ';
$output .= ' ';
return $output;
case 'admin/structure/forum':
$output = '
' . t('Forums contain forum topics. Use containers to group related forums.') . '
';
$output .= theme('more_help_link', array('url' => 'admin/help/forum'));
return $output;
case 'admin/structure/forum/add/container':
return '
' . t('Use containers to group related forums.') . '
';
case 'admin/structure/forum/add/forum':
return '
' . t('A forum holds related forum topics.') . '
';
case 'admin/structure/forum/settings':
return '
' . t('Adjust the display of your forum topics. Organize the forums on the forum structure page .', array('@forum-structure' => url('admin/structure/forum'))) . '
';
}
}
/**
* Implements hook_theme().
*/
function forum_theme() {
return array(
'forums' => array(
'template' => 'forums',
'variables' => array('forums' => NULL, 'topics' => NULL, 'parents' => NULL, 'tid' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL),
),
'forum_list' => array(
'template' => 'forum-list',
'variables' => array('forums' => NULL, 'parents' => NULL, 'tid' => NULL),
),
'forum_topic_list' => array(
'template' => 'forum-topic-list',
'variables' => array('tid' => NULL, 'topics' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL),
),
'forum_icon' => array(
'template' => 'forum-icon',
'variables' => array('new_posts' => NULL, 'num_posts' => 0, 'comment_mode' => 0, 'sticky' => 0, 'first_new' => FALSE),
),
'forum_submitted' => array(
'template' => 'forum-submitted',
'variables' => array('topic' => NULL),
),
'forum_form' => array(
'render element' => 'form',
'file' => 'forum.admin.inc',
),
);
}
/**
* Implements hook_menu().
*/
function forum_menu() {
$items['forum'] = array(
'title' => 'Forums',
'page callback' => 'forum_page',
'access arguments' => array('access content'),
'file' => 'forum.pages.inc',
);
$items['forum/%forum_forum'] = array(
'title' => 'Forums',
'page callback' => 'forum_page',
'page arguments' => array(1),
'access arguments' => array('access content'),
'file' => 'forum.pages.inc',
);
$items['admin/structure/forum'] = array(
'title' => 'Forums',
'description' => 'Control forum hierarchy settings.',
'page callback' => 'drupal_get_form',
'page arguments' => array('forum_overview'),
'access arguments' => array('administer forums'),
'file' => 'forum.admin.inc',
);
$items['admin/structure/forum/list'] = array(
'title' => 'List',
'type' => MENU_DEFAULT_LOCAL_TASK,
'weight' => -10,
);
$items['admin/structure/forum/add/container'] = array(
'title' => 'Add container',
'page callback' => 'forum_form_main',
'page arguments' => array('container'),
'access arguments' => array('administer forums'),
'type' => MENU_LOCAL_ACTION,
'parent' => 'admin/structure/forum',
'file' => 'forum.admin.inc',
);
$items['admin/structure/forum/add/forum'] = array(
'title' => 'Add forum',
'page callback' => 'forum_form_main',
'page arguments' => array('forum'),
'access arguments' => array('administer forums'),
'type' => MENU_LOCAL_ACTION,
'parent' => 'admin/structure/forum',
'file' => 'forum.admin.inc',
);
$items['admin/structure/forum/settings'] = array(
'title' => 'Settings',
'page callback' => 'drupal_get_form',
'page arguments' => array('forum_admin_settings'),
'access arguments' => array('administer forums'),
'weight' => 5,
'type' => MENU_LOCAL_TASK,
'parent' => 'admin/structure/forum',
'file' => 'forum.admin.inc',
);
$items['admin/structure/forum/edit/container/%taxonomy_term'] = array(
'title' => 'Edit container',
'page callback' => 'forum_form_main',
'page arguments' => array('container', 5),
'access arguments' => array('administer forums'),
'file' => 'forum.admin.inc',
);
$items['admin/structure/forum/edit/forum/%taxonomy_term'] = array(
'title' => 'Edit forum',
'page callback' => 'forum_form_main',
'page arguments' => array('forum', 5),
'access arguments' => array('administer forums'),
'file' => 'forum.admin.inc',
);
return $items;
}
/**
* Implements hook_menu_local_tasks_alter().
*/
function forum_menu_local_tasks_alter(&$data, $router_item, $root_path) {
global $user;
// Add action link to 'node/add/forum' on 'forum' sub-pages.
if ($root_path == 'forum' || $root_path == 'forum/%') {
$tid = (isset($router_item['page_arguments'][0]) ? $router_item['page_arguments'][0]->tid : 0);
$forum_term = forum_forum_load($tid);
if ($forum_term) {
$links = array();
// Loop through all bundles for forum taxonomy vocabulary field.
$field = field_info_field('taxonomy_forums');
foreach ($field['bundles']['node'] as $type) {
if (node_access('create', $type)) {
$links[$type] = array(
'#theme' => 'menu_local_action',
'#link' => array(
'title' => t('Add new @node_type', array('@node_type' => node_type_get_name($type))),
'href' => 'node/add/' . str_replace('_', '-', $type) . '/' . $forum_term->tid,
),
);
}
}
if (empty($links)) {
// Authenticated user does not have access to create new topics.
if ($user->uid) {
$links['disallowed'] = array(
'#theme' => 'menu_local_action',
'#link' => array(
'title' => t('You are not allowed to post new content in the forum.'),
),
);
}
// Anonymous user does not have access to create new topics.
else {
$links['login'] = array(
'#theme' => 'menu_local_action',
'#link' => array(
'title' => t('
Log in to post new content in the forum.', array(
'@login' => url('user/login', array('query' => drupal_get_destination())),
)),
'localized_options' => array('html' => TRUE),
),
);
}
}
$data['actions']['output'] = array_merge($data['actions']['output'], $links);
}
}
}
/**
* Implements hook_entity_info_alter().
*/
function forum_entity_info_alter(&$info) {
// Take over URI construction for taxonomy terms that are forums.
if ($vid = variable_get('forum_nav_vocabulary', 0)) {
// Within hook_entity_info(), we can't invoke entity_load() as that would
// cause infinite recursion, so we call taxonomy_vocabulary_get_names()
// instead of taxonomy_vocabulary_load(). All we need is the machine name
// of $vid, so retrieving and iterating all the vocabulary names is somewhat
// inefficient, but entity info is cached across page requests, and an
// iteration of all vocabularies once per cache clearing isn't a big deal,
// and is done as part of taxonomy_entity_info() anyway.
foreach (taxonomy_vocabulary_get_names() as $machine_name => $vocabulary) {
if ($vid == $vocabulary->vid) {
$info['taxonomy_term']['bundles'][$machine_name]['uri callback'] = 'forum_uri';
}
}
}
}
/**
* Implements callback_entity_info_uri().
*
* Entity URI callback used in forum_entity_info_alter().
*/
function forum_uri($forum) {
return array(
'path' => 'forum/' . $forum->tid,
);
}
/**
* Checks whether a node can be used in a forum, based on its content type.
*
* @param $node
* A node object.
*
* @return
* Boolean indicating if the node can be assigned to a forum.
*/
function _forum_node_check_node_type($node) {
// Fetch information about the forum field.
$field = field_info_instance('node', 'taxonomy_forums', $node->type);
return is_array($field);
}
/**
* Implements hook_node_view().
*/
function forum_node_view($node, $view_mode) {
if (_forum_node_check_node_type($node)) {
if ($view_mode == 'full' && node_is_page($node)) {
$vid = variable_get('forum_nav_vocabulary', 0);
$vocabulary = taxonomy_vocabulary_load($vid);
// Breadcrumb navigation
$breadcrumb[] = l(t('Home'), NULL);
$breadcrumb[] = l($vocabulary->name, 'forum');
if ($parents = taxonomy_get_parents_all($node->forum_tid)) {
$parents = array_reverse($parents);
foreach ($parents as $parent) {
$breadcrumb[] = l($parent->name, 'forum/' . $parent->tid);
}
}
drupal_set_breadcrumb($breadcrumb);
}
}
}
/**
* Implements hook_node_validate().
*
* Checks in particular that the node is assigned only a "leaf" term in the
* forum taxonomy.
*/
function forum_node_validate($node, $form) {
if (_forum_node_check_node_type($node)) {
$langcode = $form['taxonomy_forums']['#language'];
// vocabulary is selected, not a "container" term.
if (!empty($node->taxonomy_forums[$langcode])) {
// Extract the node's proper topic ID.
$containers = variable_get('forum_containers', array());
foreach ($node->taxonomy_forums[$langcode] as $delta => $item) {
// If no term was selected (e.g. when no terms exist yet), remove the
// item.
if (empty($item['tid'])) {
unset($node->taxonomy_forums[$langcode][$delta]);
continue;
}
$term = taxonomy_term_load($item['tid']);
if (!$term) {
form_set_error('taxonomy_forums', t('Select a forum.'));
continue;
}
$used = db_query_range('SELECT 1 FROM {taxonomy_term_data} WHERE tid = :tid AND vid = :vid',0 , 1, array(
':tid' => $term->tid,
':vid' => $term->vid,
))->fetchField();
if ($used && in_array($term->tid, $containers)) {
form_set_error('taxonomy_forums', t('The item %forum is a forum container, not a forum. Select one of the forums below instead.', array('%forum' => $term->name)));
}
}
}
}
}
/**
* Implements hook_node_presave().
*
* Assigns the forum taxonomy when adding a topic from within a forum.
*/
function forum_node_presave($node) {
if (_forum_node_check_node_type($node)) {
// Make sure all fields are set properly:
$node->icon = !empty($node->icon) ? $node->icon : '';
reset($node->taxonomy_forums);
$langcode = key($node->taxonomy_forums);
if (!empty($node->taxonomy_forums[$langcode])) {
$node->forum_tid = $node->taxonomy_forums[$langcode][0]['tid'];
if (isset($node->nid)) {
$old_tid = db_query_range("SELECT f.tid FROM {forum} f INNER JOIN {node} n ON f.vid = n.vid WHERE n.nid = :nid ORDER BY f.vid DESC", 0, 1, array(':nid' => $node->nid))->fetchField();
if ($old_tid && isset($node->forum_tid) && ($node->forum_tid != $old_tid) && !empty($node->shadow)) {
// A shadow copy needs to be created. Retain new term and add old term.
$node->taxonomy_forums[$langcode][] = array('tid' => $old_tid);
}
}
}
}
}
/**
* Implements hook_node_update().
*/
function forum_node_update($node) {
if (_forum_node_check_node_type($node)) {
if (empty($node->revision) && db_query('SELECT tid FROM {forum} WHERE nid=:nid', array(':nid' => $node->nid))->fetchField()) {
if (!empty($node->forum_tid)) {
db_update('forum')
->fields(array('tid' => $node->forum_tid))
->condition('vid', $node->vid)
->execute();
}
// The node is removed from the forum.
else {
db_delete('forum')
->condition('nid', $node->nid)
->execute();
}
}
else {
if (!empty($node->forum_tid)) {
db_insert('forum')
->fields(array(
'tid' => $node->forum_tid,
'vid' => $node->vid,
'nid' => $node->nid,
))
->execute();
}
}
// If the node has a shadow forum topic, update the record for this
// revision.
if (!empty($node->shadow)) {
db_delete('forum')
->condition('nid', $node->nid)
->condition('vid', $node->vid)
->execute();
db_insert('forum')
->fields(array(
'nid' => $node->nid,
'vid' => $node->vid,
'tid' => $node->forum_tid,
))
->execute();
}
}
}
/**
* Implements hook_node_insert().
*/
function forum_node_insert($node) {
if (_forum_node_check_node_type($node)) {
if (!empty($node->forum_tid)) {
$nid = db_insert('forum')
->fields(array(
'tid' => $node->forum_tid,
'vid' => $node->vid,
'nid' => $node->nid,
))
->execute();
}
}
}
/**
* Implements hook_node_delete().
*/
function forum_node_delete($node) {
if (_forum_node_check_node_type($node)) {
db_delete('forum')
->condition('nid', $node->nid)
->execute();
db_delete('forum_index')
->condition('nid', $node->nid)
->execute();
}
}
/**
* Implements hook_node_load().
*/
function forum_node_load($nodes) {
$node_vids = array();
foreach ($nodes as $node) {
if (_forum_node_check_node_type($node)) {
$node_vids[] = $node->vid;
}
}
if (!empty($node_vids)) {
$query = db_select('forum', 'f');
$query
->fields('f', array('nid', 'tid'))
->condition('f.vid', $node_vids);
$result = $query->execute();
foreach ($result as $record) {
$nodes[$record->nid]->forum_tid = $record->tid;
}
}
}
/**
* Implements hook_node_info().
*/
function forum_node_info() {
return array(
'forum' => array(
'name' => t('Forum topic'),
'base' => 'forum',
'description' => t('A
forum topic starts a new discussion thread within a forum.'),
'title_label' => t('Subject'),
)
);
}
/**
* Implements hook_permission().
*/
function forum_permission() {
$perms = array(
'administer forums' => array(
'title' => t('Administer forums'),
),
);
return $perms;
}
/**
* Implements hook_taxonomy_term_delete().
*/
function forum_taxonomy_term_delete($term) {
// For containers, remove the tid from the forum_containers variable.
$containers = variable_get('forum_containers', array());
$key = array_search($term->tid, $containers);
if ($key !== FALSE) {
unset($containers[$key]);
}
variable_set('forum_containers', $containers);
}
/**
* Implements hook_comment_publish().
*
* This actually handles the insertion and update of published nodes since
* comment_save() calls hook_comment_publish() for all published comments.
*/
function forum_comment_publish($comment) {
_forum_update_forum_index($comment->nid);
}
/**
* Implements hook_comment_update().
*
* The Comment module doesn't call hook_comment_unpublish() when saving
* individual comments, so we need to check for those here.
*/
function forum_comment_update($comment) {
// comment_save() calls hook_comment_publish() for all published comments,
// so we need to handle all other values here.
if (!$comment->status) {
_forum_update_forum_index($comment->nid);
}
}
/**
* Implements hook_comment_unpublish().
*/
function forum_comment_unpublish($comment) {
_forum_update_forum_index($comment->nid);
}
/**
* Implements hook_comment_delete().
*/
function forum_comment_delete($comment) {
_forum_update_forum_index($comment->nid);
}
/**
* Implements hook_field_storage_pre_insert().
*/
function forum_field_storage_pre_insert($entity_type, $entity, &$skip_fields) {
if ($entity_type == 'node' && $entity->status && _forum_node_check_node_type($entity)) {
$query = db_insert('forum_index')->fields(array('nid', 'title', 'tid', 'sticky', 'created', 'comment_count', 'last_comment_timestamp'));
foreach ($entity->taxonomy_forums as $language) {
foreach ($language as $item) {
$query->values(array(
'nid' => $entity->nid,
'title' => $entity->title,
'tid' => $item['tid'],
'sticky' => $entity->sticky,
'created' => $entity->created,
'comment_count' => 0,
'last_comment_timestamp' => $entity->created,
));
}
}
$query->execute();
}
}
/**
* Implements hook_field_storage_pre_update().
*/
function forum_field_storage_pre_update($entity_type, $entity, &$skip_fields) {
$first_call = &drupal_static(__FUNCTION__, array());
if ($entity_type == 'node' && _forum_node_check_node_type($entity)) {
// If the node is published, update the forum index.
if ($entity->status) {
// We don't maintain data for old revisions, so clear all previous values
// from the table. Since this hook runs once per field, per object, make
// sure we only wipe values once.
if (!isset($first_call[$entity->nid])) {
$first_call[$entity->nid] = FALSE;
db_delete('forum_index')->condition('nid', $entity->nid)->execute();
}
$query = db_insert('forum_index')->fields(array('nid', 'title', 'tid', 'sticky', 'created', 'comment_count', 'last_comment_timestamp'));
foreach ($entity->taxonomy_forums as $language) {
foreach ($language as $item) {
$query->values(array(
'nid' => $entity->nid,
'title' => $entity->title,
'tid' => $item['tid'],
'sticky' => $entity->sticky,
'created' => $entity->created,
'comment_count' => 0,
'last_comment_timestamp' => $entity->created,
));
}
}
$query->execute();
// The logic for determining last_comment_count is fairly complex, so
// call _forum_update_forum_index() too.
_forum_update_forum_index($entity->nid);
}
// When a forum node is unpublished, remove it from the forum_index table.
else {
db_delete('forum_index')->condition('nid', $entity->nid)->execute();
}
}
}
/**
* Implements hook_form_FORM_ID_alter() for taxonomy_form_vocabulary().
*/
function forum_form_taxonomy_form_vocabulary_alter(&$form, &$form_state, $form_id) {
$vid = variable_get('forum_nav_vocabulary', 0);
if (isset($form['vid']['#value']) && $form['vid']['#value'] == $vid) {
$form['help_forum_vocab'] = array(
'#markup' => t('This is the designated forum vocabulary. Some of the normal vocabulary options have been removed.'),
'#weight' => -1,
);
// Forum's vocabulary always has single hierarchy. Forums and containers
// have only one parent or no parent for root items. By default this value
// is 0.
$form['hierarchy']['#value'] = 1;
// Do not allow to delete forum's vocabulary.
$form['actions']['delete']['#access'] = FALSE;
}
}
/**
* Implements hook_form_FORM_ID_alter() for taxonomy_form_term().
*/
function forum_form_taxonomy_form_term_alter(&$form, &$form_state, $form_id) {
$vid = variable_get('forum_nav_vocabulary', 0);
if (isset($form['vid']['#value']) && $form['vid']['#value'] == $vid) {
// Hide multiple parents select from forum terms.
$form['relations']['parent']['#access'] = FALSE;
}
}
/**
* Implements hook_form_BASE_FORM_ID_alter() for node_form().
*/
function forum_form_node_form_alter(&$form, &$form_state, $form_id) {
if (isset($form['taxonomy_forums'])) {
$langcode = $form['taxonomy_forums']['#language'];
// Make the vocabulary required for 'real' forum-nodes.
$form['taxonomy_forums'][$langcode]['#required'] = TRUE;
$form['taxonomy_forums'][$langcode]['#multiple'] = FALSE;
if (empty($form['taxonomy_forums'][$langcode]['#default_value'])) {
// If there is no default forum already selected, try to get the forum
// ID from the URL (e.g., if we are on a page like node/add/forum/2, we
// expect "2" to be the ID of the forum that was requested).
$requested_forum_id = arg(3);
$form['taxonomy_forums'][$langcode]['#default_value'] = is_numeric($requested_forum_id) ? $requested_forum_id : '';
}
}
}
/**
* Implements hook_block_info().
*/
function forum_block_info() {
$blocks['active'] = array(
'info' => t('Active forum topics'),
'cache' => DRUPAL_CACHE_CUSTOM,
'properties' => array('administrative' => TRUE),
);
$blocks['new'] = array(
'info' => t('New forum topics'),
'cache' => DRUPAL_CACHE_CUSTOM,
'properties' => array('administrative' => TRUE),
);
return $blocks;
}
/**
* Implements hook_block_configure().
*/
function forum_block_configure($delta = '') {
$form['forum_block_num_' . $delta] = array(
'#type' => 'select',
'#title' => t('Number of topics'),
'#default_value' => variable_get('forum_block_num_' . $delta, '5'),
'#options' => drupal_map_assoc(range(2, 20))
);
return $form;
}
/**
* Implements hook_block_save().
*/
function forum_block_save($delta = '', $edit = array()) {
variable_set('forum_block_num_' . $delta, $edit['forum_block_num_' . $delta]);
}
/**
* Implements hook_block_view().
*
* Generates a block containing the currently active forum topics and the most
* recently added forum topics.
*/
function forum_block_view($delta = '') {
$query = db_select('forum_index', 'f')
->fields('f')
->addTag('node_access');
switch ($delta) {
case 'active':
$title = t('Active forum topics');
$query
->orderBy('f.last_comment_timestamp', 'DESC')
->range(0, variable_get('forum_block_num_active', '5'));
break;
case 'new':
$title = t('New forum topics');
$query
->orderBy('f.created', 'DESC')
->range(0, variable_get('forum_block_num_new', '5'));
break;
}
$block['subject'] = $title;
// Cache based on the altered query. Enables us to cache with node access enabled.
$block['content'] = drupal_render_cache_by_query($query, 'forum_block_view');
$block['content']['#access'] = user_access('access content');
return $block;
}
/**
* Render API callback: Lists nodes based on the element's #query property.
*
* This function can be used as a #pre_render callback.
*
* @see forum_block_view()
*/
function forum_block_view_pre_render($elements) {
$result = $elements['#query']->execute();
if ($node_title_list = node_title_list($result)) {
$elements['forum_list'] = $node_title_list;
$elements['forum_more'] = array('#theme' => 'more_link', '#url' => 'forum', '#title' => t('Read the latest forum topics.'));
}
return $elements;
}
/**
* Implements hook_form().
*/
function forum_form($node, $form_state) {
$type = node_type_get_type($node);
$form['title'] = array(
'#type' => 'textfield',
'#title' => check_plain($type->title_label),
'#default_value' => !empty($node->title) ? $node->title : '',
'#required' => TRUE, '#weight' => -5
);
if (!empty($node->nid)) {
$forum_terms = $node->taxonomy_forums;
// If editing, give option to leave shadows.
$shadow = (count($forum_terms) > 1);
$form['shadow'] = array('#type' => 'checkbox', '#title' => t('Leave shadow copy'), '#default_value' => $shadow, '#description' => t('If you move this topic, you can leave a link in the old forum to the new forum.'));
$form['forum_tid'] = array('#type' => 'value', '#value' => $node->forum_tid);
}
return $form;
}
/**
* Returns a tree of all forums for a given taxonomy term ID.
*
* @param $tid
* (optional) Taxonomy term ID of the forum. If not given all forums will be
* returned.
*
* @return
* A tree of taxonomy objects, with the following additional properties:
* - num_topics: Number of topics in the forum.
* - num_posts: Total number of posts in all topics.
* - last_post: Most recent post for the forum.
* - forums: An array of child forums.
*/
function forum_forum_load($tid = NULL) {
$cache = &drupal_static(__FUNCTION__, array());
// Return a cached forum tree if available.
if (!isset($tid)) {
$tid = 0;
}
if (isset($cache[$tid])) {
return $cache[$tid];
}
$vid = variable_get('forum_nav_vocabulary', 0);
// Load and validate the parent term.
if ($tid) {
$forum_term = taxonomy_term_load($tid);
if (!$forum_term || ($forum_term->vid != $vid)) {
return $cache[$tid] = FALSE;
}
}
// If $tid is 0, create an empty object to hold the child terms.
elseif ($tid === 0) {
$forum_term = (object) array(
'tid' => 0,
);
}
// Determine if the requested term is a container.
if (!$forum_term->tid || in_array($forum_term->tid, variable_get('forum_containers', array()))) {
$forum_term->container = 1;
}
// Load parent terms.
$forum_term->parents = taxonomy_get_parents_all($forum_term->tid);
// Load the tree below.
$forums = array();
$_forums = taxonomy_get_tree($vid, $tid);
if (count($_forums)) {
$query = db_select('node', 'n');
$query->join('node_comment_statistics', 'ncs', 'n.nid = ncs.nid');
$query->join('forum', 'f', 'n.vid = f.vid');
$query->addExpression('COUNT(n.nid)', 'topic_count');
$query->addExpression('SUM(ncs.comment_count)', 'comment_count');
$counts = $query
->fields('f', array('tid'))
->condition('n.status', 1)
->groupBy('tid')
->addTag('node_access')
->execute()
->fetchAllAssoc('tid');
}
foreach ($_forums as $forum) {
// Determine if the child term is a container.
if (in_array($forum->tid, variable_get('forum_containers', array()))) {
$forum->container = 1;
}
// Merge in the topic and post counters.
if (!empty($counts[$forum->tid])) {
$forum->num_topics = $counts[$forum->tid]->topic_count;
$forum->num_posts = $counts[$forum->tid]->topic_count + $counts[$forum->tid]->comment_count;
}
else {
$forum->num_topics = 0;
$forum->num_posts = 0;
}
// Query "Last Post" information for this forum.
$query = db_select('node', 'n');
$query->join('users', 'u1', 'n.uid = u1.uid');
$query->join('forum', 'f', 'n.vid = f.vid AND f.tid = :tid', array(':tid' => $forum->tid));
$query->join('node_comment_statistics', 'ncs', 'n.nid = ncs.nid');
$query->join('users', 'u2', 'ncs.last_comment_uid = u2.uid');
$query->addExpression('CASE ncs.last_comment_uid WHEN 0 THEN ncs.last_comment_name ELSE u2.name END', 'last_comment_name');
$topic = $query
->fields('ncs', array('last_comment_timestamp', 'last_comment_uid'))
->condition('n.status', 1)
->orderBy('last_comment_timestamp', 'DESC')
->range(0, 1)
->addTag('node_access')
->execute()
->fetchObject();
// Merge in the "Last Post" information.
$last_post = new stdClass();
if (!empty($topic->last_comment_timestamp)) {
$last_post->created = $topic->last_comment_timestamp;
$last_post->name = $topic->last_comment_name;
$last_post->uid = $topic->last_comment_uid;
}
$forum->last_post = $last_post;
$forums[$forum->tid] = $forum;
}
// Cache the result, and return the tree.
$forum_term->forums = $forums;
$cache[$tid] = $forum_term;
return $forum_term;
}
/**
* Calculates the number of new posts in a forum that the user has not yet read.
*
* Nodes are new if they are newer than NODE_NEW_LIMIT.
*
* @param $term
* The term ID of the forum.
* @param $uid
* The user ID.
*
* @return
* The number of new posts in the forum that have not been read by the user.
*/
function _forum_topics_unread($term, $uid) {
$query = db_select('node', 'n');
$query->join('forum', 'f', 'n.vid = f.vid AND f.tid = :tid', array(':tid' => $term));
$query->leftJoin('history', 'h', 'n.nid = h.nid AND h.uid = :uid', array(':uid' => $uid));
$query->addExpression('COUNT(n.nid)', 'count');
return $query
->condition('status', 1)
->condition('n.created', NODE_NEW_LIMIT, '>')
->isNull('h.nid')
->addTag('node_access')
->execute()
->fetchField();
}
/**
* Gets all the topics in a forum.
*
* @param $tid
* The term ID of the forum.
* @param $sortby
* One of the following integers indicating the sort criteria:
* - 1: Date - newest first.
* - 2: Date - oldest first.
* - 3: Posts with the most comments first.
* - 4: Posts with the least comments first.
* @param $forum_per_page
* The maximum number of topics to display per page.
*
* @return
* A list of all the topics in a forum.
*/
function forum_get_topics($tid, $sortby, $forum_per_page) {
global $user, $forum_topic_list_header;
$forum_topic_list_header = array(
NULL,
array('data' => t('Topic'), 'field' => 'f.title'),
array('data' => t('Replies'), 'field' => 'f.comment_count'),
array('data' => t('Last reply'), 'field' => 'f.last_comment_timestamp'),
);
$order = _forum_get_topic_order($sortby);
// Skip element with index 0 which is NULL.
for ($i = 1; $i < count($forum_topic_list_header); $i++) {
if ($forum_topic_list_header[$i]['field'] == $order['field']) {
$forum_topic_list_header[$i]['sort'] = $order['sort'];
}
}
$query = db_select('forum_index', 'f')->extend('PagerDefault')->extend('TableSort');
$query->fields('f');
$query
->condition('f.tid', $tid)
->addTag('node_access')
->orderBy('f.sticky', 'DESC')
->orderByHeader($forum_topic_list_header)
->limit($forum_per_page);
$count_query = db_select('forum_index', 'f');
$count_query->condition('f.tid', $tid);
$count_query->addExpression('COUNT(*)');
$count_query->addTag('node_access');
$query->setCountQuery($count_query);
$result = $query->execute();
$nids = array();
foreach ($result as $record) {
$nids[] = $record->nid;
}
if ($nids) {
$query = db_select('node', 'n')->extend('TableSort');
$query->fields('n', array('title', 'nid', 'type', 'sticky', 'created', 'uid'));
$query->addField('n', 'comment', 'comment_mode');
$query->join('node_comment_statistics', 'ncs', 'n.nid = ncs.nid');
$query->fields('ncs', array('cid', 'last_comment_uid', 'last_comment_timestamp', 'comment_count'));
$query->join('forum_index', 'f', 'f.nid = ncs.nid');
$query->addField('f', 'tid', 'forum_tid');
$query->join('users', 'u', 'n.uid = u.uid');
$query->addField('u', 'name');
$query->join('users', 'u2', 'ncs.last_comment_uid = u2.uid');
$query->addExpression('CASE ncs.last_comment_uid WHEN 0 THEN ncs.last_comment_name ELSE u2.name END', 'last_comment_name');
$query
->orderBy('f.sticky', 'DESC')
->orderByHeader($forum_topic_list_header)
->condition('n.nid', $nids);
$result = $query->execute();
}
else {
$result = array();
}
$topics = array();
$first_new_found = FALSE;
foreach ($result as $topic) {
if ($user->uid) {
// A forum is new if the topic is new, or if there are new comments since
// the user's last visit.
if ($topic->forum_tid != $tid) {
$topic->new = 0;
}
else {
$history = _forum_user_last_visit($topic->nid);
$topic->new_replies = comment_num_new($topic->nid, $history);
$topic->new = $topic->new_replies || ($topic->last_comment_timestamp > $history);
}
}
else {
// Do not track "new replies" status for topics if the user is anonymous.
$topic->new_replies = 0;
$topic->new = 0;
}
// Make sure only one topic is indicated as the first new topic.
$topic->first_new = FALSE;
if ($topic->new != 0 && !$first_new_found) {
$topic->first_new = TRUE;
$first_new_found = TRUE;
}
if ($topic->comment_count > 0) {
$last_reply = new stdClass();
$last_reply->created = $topic->last_comment_timestamp;
$last_reply->name = $topic->last_comment_name;
$last_reply->uid = $topic->last_comment_uid;
$topic->last_reply = $last_reply;
}
$topics[] = $topic;
}
return $topics;
}
/**
* Preprocesses variables for forums.tpl.php.
*
* @param $variables
* An array containing the following elements:
* - forums: An array of all forum objects to display for the given taxonomy
* term ID. If tid = 0 then all the top-level forums are displayed.
* - topics: An array of all the topics in the current forum.
* - parents: An array of taxonomy term objects that are ancestors of the
* current term ID.
* - tid: Taxonomy term ID of the current forum.
* - sortby: One of the following integers indicating the sort criteria:
* - 1: Date - newest first.
* - 2: Date - oldest first.
* - 3: Posts with the most comments first.
* - 4: Posts with the least comments first.
* - forum_per_page: The maximum number of topics to display per page.
*
* @see forums.tpl.php
*/
function template_preprocess_forums(&$variables) {
global $user;
$vid = variable_get('forum_nav_vocabulary', 0);
$vocabulary = taxonomy_vocabulary_load($vid);
$title = !empty($vocabulary->name) ? $vocabulary->name : '';
// Breadcrumb navigation:
$breadcrumb[] = l(t('Home'), NULL);
if ($variables['tid']) {
$breadcrumb[] = l($vocabulary->name, 'forum');
}
if ($variables['parents']) {
$variables['parents'] = array_reverse($variables['parents']);
foreach ($variables['parents'] as $p) {
if ($p->tid == $variables['tid']) {
$title = $p->name;
}
else {
$breadcrumb[] = l($p->name, 'forum/' . $p->tid);
}
}
}
drupal_set_breadcrumb($breadcrumb);
drupal_set_title($title);
if ($variables['forums_defined'] = count($variables['forums']) || count($variables['parents'])) {
if (!empty($variables['forums'])) {
$variables['forums'] = theme('forum_list', $variables);
}
else {
$variables['forums'] = '';
}
if ($variables['tid'] && !in_array($variables['tid'], variable_get('forum_containers', array()))) {
$variables['topics'] = theme('forum_topic_list', $variables);
drupal_add_feed('taxonomy/term/' . $variables['tid'] . '/feed', 'RSS - ' . $title);
}
else {
$variables['topics'] = '';
}
// Provide separate template suggestions based on what's being output. Topic id is also accounted for.
// Check both variables to be safe then the inverse. Forums with topic ID's take precedence.
if ($variables['forums'] && !$variables['topics']) {
$variables['theme_hook_suggestions'][] = 'forums__containers';
$variables['theme_hook_suggestions'][] = 'forums__' . $variables['tid'];
$variables['theme_hook_suggestions'][] = 'forums__containers__' . $variables['tid'];
}
elseif (!$variables['forums'] && $variables['topics']) {
$variables['theme_hook_suggestions'][] = 'forums__topics';
$variables['theme_hook_suggestions'][] = 'forums__' . $variables['tid'];
$variables['theme_hook_suggestions'][] = 'forums__topics__' . $variables['tid'];
}
else {
$variables['theme_hook_suggestions'][] = 'forums__' . $variables['tid'];
}
}
else {
drupal_set_title(t('No forums defined'));
$variables['forums'] = '';
$variables['topics'] = '';
}
}
/**
* Preprocesses variables for forum-list.tpl.php.
*
* @param $variables
* An array containing the following elements:
* - forums: An array of all forum objects to display for the given taxonomy
* term ID. If tid = 0 then all the top-level forums are displayed.
* - parents: An array of taxonomy term objects that are ancestors of the
* current term ID.
* - tid: Taxonomy term ID of the current forum.
*
* @see forum-list.tpl.php
* @see theme_forum_list()
*/
function template_preprocess_forum_list(&$variables) {
global $user;
$row = 0;
// Sanitize each forum so that the template can safely print the data.
foreach ($variables['forums'] as $id => $forum) {
$variables['forums'][$id]->description = !empty($forum->description) ? filter_xss_admin($forum->description) : '';
$variables['forums'][$id]->link = url("forum/$forum->tid");
$variables['forums'][$id]->name = check_plain($forum->name);
$variables['forums'][$id]->is_container = !empty($forum->container);
$variables['forums'][$id]->zebra = $row % 2 == 0 ? 'odd' : 'even';
$row++;
$variables['forums'][$id]->new_text = '';
$variables['forums'][$id]->new_url = '';
$variables['forums'][$id]->new_topics = 0;
$variables['forums'][$id]->old_topics = $forum->num_topics;
$variables['forums'][$id]->icon_class = 'default';
$variables['forums'][$id]->icon_title = t('No new posts');
if ($user->uid) {
$variables['forums'][$id]->new_topics = _forum_topics_unread($forum->tid, $user->uid);
if ($variables['forums'][$id]->new_topics) {
$variables['forums'][$id]->new_text = format_plural($variables['forums'][$id]->new_topics, '1 new', '@count new');
$variables['forums'][$id]->new_url = url("forum/$forum->tid", array('fragment' => 'new'));
$variables['forums'][$id]->icon_class = 'new';
$variables['forums'][$id]->icon_title = t('New posts');
}
$variables['forums'][$id]->old_topics = $forum->num_topics - $variables['forums'][$id]->new_topics;
}
$variables['forums'][$id]->last_reply = theme('forum_submitted', array('topic' => $forum->last_post));
}
// Give meaning to $tid for themers. $tid actually stands for term id.
$variables['forum_id'] = $variables['tid'];
unset($variables['tid']);
}
/**
* Preprocesses variables for forum-topic-list.tpl.php.
*
* @param $variables
* An array containing the following elements:
* - tid: Taxonomy term ID of the current forum.
* - topics: An array of all the topics in the current forum.
* - forum_per_page: The maximum number of topics to display per page.
*
* @see forum-topic-list.tpl.php
* @see theme_forum_topic_list()
*/
function template_preprocess_forum_topic_list(&$variables) {
global $forum_topic_list_header;
// Create the tablesorting header.
$ts = tablesort_init($forum_topic_list_header);
$header = '';
foreach ($forum_topic_list_header as $cell) {
$cell = tablesort_header($cell, $forum_topic_list_header, $ts);
$header .= _theme_table_cell($cell, TRUE);
}
$variables['header'] = $header;
if (!empty($variables['topics'])) {
$row = 0;
foreach ($variables['topics'] as $id => $topic) {
$variables['topics'][$id]->icon = theme('forum_icon', array('new_posts' => $topic->new, 'num_posts' => $topic->comment_count, 'comment_mode' => $topic->comment_mode, 'sticky' => $topic->sticky, 'first_new' => $topic->first_new));
$variables['topics'][$id]->zebra = $row % 2 == 0 ? 'odd' : 'even';
$row++;
// We keep the actual tid in forum table, if it's different from the
// current tid then it means the topic appears in two forums, one of
// them is a shadow copy.
if ($variables['tid'] != $topic->forum_tid) {
$variables['topics'][$id]->moved = TRUE;
$variables['topics'][$id]->title = check_plain($topic->title);
$variables['topics'][$id]->message = l(t('This topic has been moved'), "forum/$topic->forum_tid");
}
else {
$variables['topics'][$id]->moved = FALSE;
$variables['topics'][$id]->title = l($topic->title, "node/$topic->nid");
$variables['topics'][$id]->message = '';
}
$variables['topics'][$id]->created = theme('forum_submitted', array('topic' => $topic));
$variables['topics'][$id]->last_reply = theme('forum_submitted', array('topic' => isset($topic->last_reply) ? $topic->last_reply : NULL));
$variables['topics'][$id]->new_text = '';
$variables['topics'][$id]->new_url = '';
if ($topic->new_replies) {
$variables['topics'][$id]->new_text = format_plural($topic->new_replies, '1 new', '@count new');
$variables['topics'][$id]->new_url = url("node/$topic->nid", array('query' => comment_new_page_count($topic->comment_count, $topic->new_replies, $topic), 'fragment' => 'new'));
}
}
}
else {
// Make this safe for the template.
$variables['topics'] = array();
}
// Give meaning to $tid for themers. $tid actually stands for term id.
$variables['topic_id'] = $variables['tid'];
unset($variables['tid']);
$variables['pager'] = theme('pager');
}
/**
* Preprocesses variables for forum-icon.tpl.php.
*
* @param $variables
* An array containing the following elements:
* - new_posts: Indicates whether or not the topic contains new posts.
* - num_posts: The total number of posts in all topics.
* - comment_mode: An integer indicating whether comments are open, closed,
* or hidden.
* - sticky: Indicates whether the topic is sticky.
* - first_new: Indicates whether this is the first topic with new posts.
*
* @see forum-icon.tpl.php
* @see theme_forum_icon()
*/
function template_preprocess_forum_icon(&$variables) {
$variables['hot_threshold'] = variable_get('forum_hot_topic', 15);
if ($variables['num_posts'] > $variables['hot_threshold']) {
$variables['icon_class'] = $variables['new_posts'] ? 'hot-new' : 'hot';
$variables['icon_title'] = $variables['new_posts'] ? t('Hot topic, new comments') : t('Hot topic');
}
else {
$variables['icon_class'] = $variables['new_posts'] ? 'new' : 'default';
$variables['icon_title'] = $variables['new_posts'] ? t('New comments') : t('Normal topic');
}
if ($variables['comment_mode'] == COMMENT_NODE_CLOSED || $variables['comment_mode'] == COMMENT_NODE_HIDDEN) {
$variables['icon_class'] = 'closed';
$variables['icon_title'] = t('Closed topic');
}
if ($variables['sticky'] == 1) {
$variables['icon_class'] = 'sticky';
$variables['icon_title'] = t('Sticky topic');
}
}
/**
* Preprocesses variables for forum-submitted.tpl.php.
*
* The submission information will be displayed in the forum list and topic
* list.
*
* @param $variables
* An array containing the following elements:
* - topic: The topic object.
*
* @see forum-submitted.tpl.php
* @see theme_forum_submitted()
*/
function template_preprocess_forum_submitted(&$variables) {
$variables['author'] = isset($variables['topic']->uid) ? theme('username', array('account' => $variables['topic'])) : '';
$variables['time'] = isset($variables['topic']->created) ? format_interval(REQUEST_TIME - $variables['topic']->created) : '';
}
/**
* Gets the last time the user viewed a node.
*
* @param $nid
* The node ID.
*
* @return
* The timestamp when the user last viewed this node, if the user has
* previously viewed the node; otherwise NODE_NEW_LIMIT.
*/
function _forum_user_last_visit($nid) {
global $user;
$history = &drupal_static(__FUNCTION__, array());
if (empty($history)) {
$result = db_query('SELECT nid, timestamp FROM {history} WHERE uid = :uid', array(':uid' => $user->uid));
foreach ($result as $t) {
$history[$t->nid] = $t->timestamp > NODE_NEW_LIMIT ? $t->timestamp : NODE_NEW_LIMIT;
}
}
return isset($history[$nid]) ? $history[$nid] : NODE_NEW_LIMIT;
}
/**
* Gets topic sorting information based on an integer code.
*
* @param $sortby
* One of the following integers indicating the sort criteria:
* - 1: Date - newest first.
* - 2: Date - oldest first.
* - 3: Posts with the most comments first.
* - 4: Posts with the least comments first.
*
* @return
* An array with the following values:
* - field: A field for an SQL query.
* - sort: 'asc' or 'desc'.
*/
function _forum_get_topic_order($sortby) {
switch ($sortby) {
case 1:
return array('field' => 'f.last_comment_timestamp', 'sort' => 'desc');
break;
case 2:
return array('field' => 'f.last_comment_timestamp', 'sort' => 'asc');
break;
case 3:
return array('field' => 'f.comment_count', 'sort' => 'desc');
break;
case 4:
return array('field' => 'f.comment_count', 'sort' => 'asc');
break;
}
}
/**
* Updates the taxonomy index for a given node.
*
* @param $nid
* The ID of the node to update.
*/
function _forum_update_forum_index($nid) {
$count = db_query('SELECT COUNT(cid) FROM {comment} c INNER JOIN {forum_index} i ON c.nid = i.nid WHERE c.nid = :nid AND c.status = :status', array(
':nid' => $nid,
':status' => COMMENT_PUBLISHED,
))->fetchField();
if ($count > 0) {
// Comments exist.
$last_reply = db_query_range('SELECT cid, name, created, uid FROM {comment} WHERE nid = :nid AND status = :status ORDER BY cid DESC', 0, 1, array(
':nid' => $nid,
':status' => COMMENT_PUBLISHED,
))->fetchObject();
db_update('forum_index')
->fields( array(
'comment_count' => $count,
'last_comment_timestamp' => $last_reply->created,
))
->condition('nid', $nid)
->execute();
}
else {
// Comments do not exist.
$node = db_query('SELECT uid, created FROM {node} WHERE nid = :nid', array(':nid' => $nid))->fetchObject();
db_update('forum_index')
->fields( array(
'comment_count' => 0,
'last_comment_timestamp' => $node->created,
))
->condition('nid', $nid)
->execute();
}
}
/**
* Implements hook_rdf_mapping().
*/
function forum_rdf_mapping() {
return array(
array(
'type' => 'node',
'bundle' => 'forum',
'mapping' => array(
'rdftype' => array('sioc:Post', 'sioct:BoardPost'),
'taxonomy_forums' => array(
'predicates' => array('sioc:has_container'),
'type' => 'rel',
),
),
),
array(
'type' => 'taxonomy_term',
'bundle' => 'forums',
'mapping' => array(
'rdftype' => array('sioc:Container', 'sioc:Forum'),
),
),
);
}
container)) {
$topics = forum_get_topics($forum_term->tid, $sortby, $forum_per_page);
}
else {
$topics = '';
}
return theme('forums', array('forums' => $forum_term->forums, 'topics' => $topics, 'parents' => $forum_term->parents, 'tid' => $forum_term->tid, 'sortby' => $sortby, 'forums_per_page' => $forum_per_page));
}
'Forum functionality',
'description' => 'Create, view, edit, delete, and change forum entries and verify its consistency in the database.',
'group' => 'Forum',
);
}
function setUp() {
parent::setUp('taxonomy', 'comment', 'forum');
// Create users.
$this->admin_user = $this->drupalCreateUser(array(
'access administration pages',
'administer modules',
'administer blocks',
'administer forums',
'administer menu',
'administer taxonomy',
'create forum content',
));
$this->edit_any_topics_user = $this->drupalCreateUser(array(
'access administration pages',
'create forum content',
'edit any forum content',
'delete any forum content',
));
$this->edit_own_topics_user = $this->drupalCreateUser(array(
'create forum content',
'edit own forum content',
'delete own forum content',
));
$this->web_user = $this->drupalCreateUser(array());
}
/**
* Tests disabling and re-enabling the Forum module.
*/
function testEnableForumField() {
$this->drupalLogin($this->admin_user);
// Disable the Forum module.
$edit = array();
$edit['modules[Core][forum][enable]'] = FALSE;
$this->drupalPost('admin/modules', $edit, t('Save configuration'));
$this->assertText(t('The configuration options have been saved.'), 'Modules status has been updated.');
module_list(TRUE);
$this->assertFalse(module_exists('forum'), 'Forum module is not enabled.');
// Attempt to re-enable the Forum module and ensure it does not try to
// recreate the taxonomy_forums field.
$edit = array();
$edit['modules[Core][forum][enable]'] = 'forum';
$this->drupalPost('admin/modules', $edit, t('Save configuration'));
$this->assertText(t('The configuration options have been saved.'), 'Modules status has been updated.');
module_list(TRUE);
$this->assertTrue(module_exists('forum'), 'Forum module is enabled.');
}
/**
* Tests forum functionality through the admin and user interfaces.
*/
function testForum() {
//Check that the basic forum install creates a default forum topic
$this->drupalGet("/forum");
// Look for the "General discussion" default forum
$this->assertText(t("General discussion"), "Found the default forum at the /forum listing");
// Do the admin tests.
$this->doAdminTests($this->admin_user);
// Generate topics to populate the active forum block.
$this->generateForumTopics($this->forum);
// Login an unprivileged user to view the forum topics and generate an
// active forum topics list.
$this->drupalLogin($this->web_user);
// Verify that this user is shown a message that they may not post content.
$this->drupalGet('forum/' . $this->forum['tid']);
$this->assertText(t('You are not allowed to post new content in the forum'), "Authenticated user without permission to post forum content is shown message in local tasks to that effect.");
$this->viewForumTopics($this->nids);
// Log in, and do basic tests for a user with permission to edit any forum
// content.
$this->doBasicTests($this->edit_any_topics_user, TRUE);
// Create a forum node authored by this user.
$any_topics_user_node = $this->createForumTopic($this->forum, FALSE);
// Log in, and do basic tests for a user with permission to edit only its
// own forum content.
$this->doBasicTests($this->edit_own_topics_user, FALSE);
// Create a forum node authored by this user.
$own_topics_user_node = $this->createForumTopic($this->forum, FALSE);
// Verify that this user cannot edit forum content authored by another user.
$this->verifyForums($this->edit_any_topics_user, $any_topics_user_node, FALSE, 403);
// Verify that this user is shown a local task to add new forum content.
$this->drupalGet('forum');
$this->assertLink(t('Add new Forum topic'));
$this->drupalGet('forum/' . $this->forum['tid']);
$this->assertLink(t('Add new Forum topic'));
// Login a user with permission to edit any forum content.
$this->drupalLogin($this->edit_any_topics_user);
// Verify that this user can edit forum content authored by another user.
$this->verifyForums($this->edit_own_topics_user, $own_topics_user_node, TRUE);
// Verify the topic and post counts on the forum page.
$this->drupalGet('forum');
// Verify row for testing forum.
$forum_arg = array(':forum' => 'forum-list-' . $this->forum['tid']);
// Topics cell contains number of topics and number of unread topics.
$xpath = $this->buildXPathQuery('//tr[@id=:forum]//td[@class="topics"]', $forum_arg);
$topics = $this->xpath($xpath);
$topics = trim($topics[0]);
$this->assertEqual($topics, '6', 'Number of topics found.');
// Verify the number of unread topics.
$unread_topics = _forum_topics_unread($this->forum['tid'], $this->edit_any_topics_user->uid);
$unread_topics = format_plural($unread_topics, '1 new', '@count new');
$xpath = $this->buildXPathQuery('//tr[@id=:forum]//td[@class="topics"]//a', $forum_arg);
$this->assertFieldByXPath($xpath, $unread_topics, 'Number of unread topics found.');
// Verify total number of posts in forum.
$xpath = $this->buildXPathQuery('//tr[@id=:forum]//td[@class="posts"]', $forum_arg);
$this->assertFieldByXPath($xpath, '6', 'Number of posts found.');
// Test loading multiple forum nodes on the front page.
$this->drupalLogin($this->drupalCreateUser(array('administer content types', 'create forum content')));
$this->drupalPost('admin/structure/types/manage/forum', array('node_options[promote]' => 'promote'), t('Save content type'));
$this->createForumTopic($this->forum, FALSE);
$this->createForumTopic($this->forum, FALSE);
$this->drupalGet('node');
// Test adding a comment to a forum topic.
$node = $this->createForumTopic($this->forum, FALSE);
$edit = array();
$edit['comment_body[' . LANGUAGE_NONE . '][0][value]'] = $this->randomName();
$this->drupalPost("node/$node->nid", $edit, t('Save'));
$this->assertResponse(200);
// Test editing a forum topic that has a comment.
$this->drupalLogin($this->edit_any_topics_user);
$this->drupalGet('forum/' . $this->forum['tid']);
$this->drupalPost("node/$node->nid/edit", array(), t('Save'));
$this->assertResponse(200);
// Make sure constructing a forum node programmatically produces no notices.
$node = new stdClass;
$node->type = 'forum';
$node->title = 'Test forum notices';
$node->uid = 1;
$node->taxonomy_forums[LANGUAGE_NONE][0]['tid'] = $this->root_forum['tid'];
node_save($node);
}
/**
* Tests that forum nodes can't be added without a parent.
*
* Verifies that forum nodes are not created without choosing "forum" from the
* select list.
*/
function testAddOrphanTopic() {
// Must remove forum topics to test creating orphan topics.
$vid = variable_get('forum_nav_vocabulary');
$tree = taxonomy_get_tree($vid);
foreach ($tree as $term) {
taxonomy_term_delete($term->tid);
}
// Create an orphan forum item.
$this->drupalLogin($this->admin_user);
$this->drupalPost('node/add/forum', array('title' => $this->randomName(10), 'body[' . LANGUAGE_NONE .'][0][value]' => $this->randomName(120)), t('Save'));
$nid_count = db_query('SELECT COUNT(nid) FROM {node}')->fetchField();
$this->assertEqual(0, $nid_count, 'A forum node was not created when missing a forum vocabulary.');
// Reset the defaults for future tests.
module_enable(array('forum'));
}
/**
* Runs admin tests on the admin user.
*
* @param object $user
* The logged in user.
*/
private function doAdminTests($user) {
// Login the user.
$this->drupalLogin($user);
// Enable the active forum block.
$edit = array();
$edit['blocks[forum_active][region]'] = 'sidebar_second';
$this->drupalPost('admin/structure/block', $edit, t('Save blocks'));
$this->assertResponse(200);
$this->assertText(t('The block settings have been updated.'), 'Active forum topics forum block was enabled');
// Enable the new forum block.
$edit = array();
$edit['blocks[forum_new][region]'] = 'sidebar_second';
$this->drupalPost('admin/structure/block', $edit, t('Save blocks'));
$this->assertResponse(200);
$this->assertText(t('The block settings have been updated.'), '[New forum topics] Forum block was enabled');
// Retrieve forum menu id.
$mlid = db_query_range("SELECT mlid FROM {menu_links} WHERE link_path = 'forum' AND menu_name = 'navigation' AND module = 'system' ORDER BY mlid ASC", 0, 1)->fetchField();
// Add forum to navigation menu.
$edit = array();
$this->drupalPost('admin/structure/menu/manage/navigation', $edit, t('Save configuration'));
$this->assertResponse(200);
// Edit forum taxonomy.
// Restoration of the settings fails and causes subsequent tests to fail.
$this->container = $this->editForumTaxonomy();
// Create forum container.
$this->container = $this->createForum('container');
// Verify "edit container" link exists and functions correctly.
$this->drupalGet('admin/structure/forum');
$this->clickLink('edit container');
$this->assertRaw('Edit container', 'Followed the link to edit the container');
// Create forum inside the forum container.
$this->forum = $this->createForum('forum', $this->container['tid']);
// Verify the "edit forum" link exists and functions correctly.
$this->drupalGet('admin/structure/forum');
$this->clickLink('edit forum');
$this->assertRaw('Edit forum', 'Followed the link to edit the forum');
// Navigate back to forum structure page.
$this->drupalGet('admin/structure/forum');
// Create second forum in container.
$this->delete_forum = $this->createForum('forum', $this->container['tid']);
// Save forum overview.
$this->drupalPost('admin/structure/forum/', array(), t('Save'));
$this->assertRaw(t('The configuration options have been saved.'));
// Delete this second forum.
$this->deleteForum($this->delete_forum['tid']);
// Create forum at the top (root) level.
$this->root_forum = $this->createForum('forum');
// Test vocabulary form alterations.
$this->drupalGet('admin/structure/taxonomy/forums/edit');
$this->assertFieldByName('op', t('Save'), 'Save button found.');
$this->assertNoFieldByName('op', t('Delete'), 'Delete button not found.');
// Test term edit form alterations.
$this->drupalGet('taxonomy/term/' . $this->container['tid'] . '/edit');
// Test parent field been hidden by forum module.
$this->assertNoField('parent[]', 'Parent field not found.');
// Test tags vocabulary form is not affected.
$this->drupalGet('admin/structure/taxonomy/tags/edit');
$this->assertFieldByName('op', t('Save'), 'Save button found.');
$this->assertFieldByName('op', t('Delete'), 'Delete button found.');
// Test tags vocabulary term form is not affected.
$this->drupalGet('admin/structure/taxonomy/tags/add');
$this->assertField('parent[]', 'Parent field found.');
// Test relations fieldset exists.
$relations_fieldset = $this->xpath("//fieldset[@id='edit-relations']");
$this->assertTrue(isset($relations_fieldset[0]), 'Relations fieldset element found.');
}
/**
* Edits the forum taxonomy.
*/
function editForumTaxonomy() {
// Backup forum taxonomy.
$vid = variable_get('forum_nav_vocabulary', '');
$original_settings = taxonomy_vocabulary_load($vid);
// Generate a random name/description.
$title = $this->randomName(10);
$description = $this->randomName(100);
$edit = array(
'name' => $title,
'description' => $description,
'machine_name' => drupal_strtolower(drupal_substr($this->randomName(), 3, 9)),
);
// Edit the vocabulary.
$this->drupalPost('admin/structure/taxonomy/' . $original_settings->machine_name . '/edit', $edit, t('Save'));
$this->assertResponse(200);
$this->assertRaw(t('Updated vocabulary %name.', array('%name' => $title)), 'Vocabulary was edited');
// Grab the newly edited vocabulary.
entity_get_controller('taxonomy_vocabulary')->resetCache();
$current_settings = taxonomy_vocabulary_load($vid);
// Make sure we actually edited the vocabulary properly.
$this->assertEqual($current_settings->name, $title, 'The name was updated');
$this->assertEqual($current_settings->description, $description, 'The description was updated');
// Restore the original vocabulary.
taxonomy_vocabulary_save($original_settings);
drupal_static_reset('taxonomy_vocabulary_load');
$current_settings = taxonomy_vocabulary_load($vid);
$this->assertEqual($current_settings->name, $original_settings->name, 'The original vocabulary settings were restored');
}
/**
* Creates a forum container or a forum.
*
* @param $type
* The forum type (forum container or forum).
* @param $parent
* The forum parent. This defaults to 0, indicating a root forum.
* another forum).
*
* @return
* The created taxonomy term data.
*/
function createForum($type, $parent = 0) {
// Generate a random name/description.
$name = $this->randomName(10);
$description = $this->randomName(100);
$edit = array(
'name' => $name,
'description' => $description,
'parent[0]' => $parent,
'weight' => '0',
);
// Create forum.
$this->drupalPost('admin/structure/forum/add/' . $type, $edit, t('Save'));
$this->assertResponse(200);
$type = ($type == 'container') ? 'forum container' : 'forum';
$this->assertRaw(t('Created new @type %term.', array('%term' => $name, '@type' => t($type))), format_string('@type was created', array('@type' => ucfirst($type))));
// Verify forum.
$term = db_query("SELECT * FROM {taxonomy_term_data} t WHERE t.vid = :vid AND t.name = :name AND t.description = :desc", array(':vid' => variable_get('forum_nav_vocabulary', ''), ':name' => $name, ':desc' => $description))->fetchAssoc();
$this->assertTrue(!empty($term), 'The ' . $type . ' exists in the database');
// Verify forum hierarchy.
$tid = $term['tid'];
$parent_tid = db_query("SELECT t.parent FROM {taxonomy_term_hierarchy} t WHERE t.tid = :tid", array(':tid' => $tid))->fetchField();
$this->assertTrue($parent == $parent_tid, 'The ' . $type . ' is linked to its container');
return $term;
}
/**
* Deletes a forum.
*
* @param $tid
* The forum ID.
*/
function deleteForum($tid) {
// Delete the forum.
$this->drupalPost('admin/structure/forum/edit/forum/' . $tid, array(), t('Delete'));
$this->drupalPost(NULL, array(), t('Delete'));
// Assert that the forum no longer exists.
$this->drupalGet('forum/' . $tid);
$this->assertResponse(404, 'The forum was not found');
// Assert that the associated term has been removed from the
// forum_containers variable.
$containers = variable_get('forum_containers', array());
$this->assertFalse(in_array($tid, $containers), 'The forum_containers variable has been updated.');
}
/**
* Runs basic tests on the indicated user.
*
* @param $user
* The logged in user.
* @param $admin
* User has 'access administration pages' privilege.
*/
private function doBasicTests($user, $admin) {
// Login the user.
$this->drupalLogin($user);
// Attempt to create forum topic under a container.
$this->createForumTopic($this->container, TRUE);
// Create forum node.
$node = $this->createForumTopic($this->forum, FALSE);
// Verify the user has access to all the forum nodes.
$this->verifyForums($user, $node, $admin);
}
/**
* Creates forum topic.
*
* @param array $forum
* A forum array.
* @param boolean $container
* TRUE if $forum is a container; FALSE otherwise.
*
* @return object
* The created topic node.
*/
function createForumTopic($forum, $container = FALSE) {
// Generate a random subject/body.
$title = $this->randomName(20);
$body = $this->randomName(200);
$langcode = LANGUAGE_NONE;
$edit = array(
"title" => $title,
"body[$langcode][0][value]" => $body,
);
$tid = $forum['tid'];
// Create the forum topic, preselecting the forum ID via a URL parameter.
$this->drupalPost('node/add/forum/' . $tid, $edit, t('Save'));
$type = t('Forum topic');
if ($container) {
$this->assertNoRaw(t('@type %title has been created.', array('@type' => $type, '%title' => $title)), 'Forum topic was not created');
$this->assertRaw(t('The item %title is a forum container, not a forum.', array('%title' => $forum['name'])), 'Error message was shown');
return;
}
else {
$this->assertRaw(t('@type %title has been created.', array('@type' => $type, '%title' => $title)), 'Forum topic was created');
$this->assertNoRaw(t('The item %title is a forum container, not a forum.', array('%title' => $forum['name'])), 'No error message was shown');
}
// Retrieve node object, ensure that the topic was created and in the proper forum.
$node = $this->drupalGetNodeByTitle($title);
$this->assertTrue($node != NULL, format_string('Node @title was loaded', array('@title' => $title)));
$this->assertEqual($node->taxonomy_forums[LANGUAGE_NONE][0]['tid'], $tid, 'Saved forum topic was in the expected forum');
// View forum topic.
$this->drupalGet('node/' . $node->nid);
$this->assertRaw($title, 'Subject was found');
$this->assertRaw($body, 'Body was found');
return $node;
}
/**
* Verifies that the logged in user has access to a forum nodes.
*
* @param $node_user
* The user who creates the node.
* @param $node
* The node being checked.
* @param $admin
* Boolean to indicate whether the user can 'access administration pages'.
* @param $response
* The exptected HTTP response code.
*/
private function verifyForums($node_user, $node, $admin, $response = 200) {
$response2 = ($admin) ? 200 : 403;
// View forum help node.
$this->drupalGet('admin/help/forum');
$this->assertResponse($response2);
if ($response2 == 200) {
$this->assertTitle(t('Forum | Drupal'), 'Forum help title was displayed');
$this->assertText(t('Forum'), 'Forum help node was displayed');
}
// Verify the forum blocks were displayed.
$this->drupalGet('');
$this->assertResponse(200);
$this->assertText(t('New forum topics'), '[New forum topics] Forum block was displayed');
// View forum container page.
$this->verifyForumView($this->container);
// View forum page.
$this->verifyForumView($this->forum, $this->container);
// View root forum page.
$this->verifyForumView($this->root_forum);
// View forum node.
$this->drupalGet('node/' . $node->nid);
$this->assertResponse(200);
$this->assertTitle($node->title . ' | Drupal', 'Forum node was displayed');
$breadcrumb = array(
l(t('Home'), NULL),
l(t('Forums'), 'forum'),
l($this->container['name'], 'forum/' . $this->container['tid']),
l($this->forum['name'], 'forum/' . $this->forum['tid']),
);
$this->assertRaw(theme('breadcrumb', array('breadcrumb' => $breadcrumb)), 'Breadcrumbs were displayed');
// View forum edit node.
$this->drupalGet('node/' . $node->nid . '/edit');
$this->assertResponse($response);
if ($response == 200) {
$this->assertTitle('Edit Forum topic ' . $node->title . ' | Drupal', 'Forum edit node was displayed');
}
if ($response == 200) {
// Edit forum node (including moving it to another forum).
$edit = array();
$langcode = LANGUAGE_NONE;
$edit["title"] = 'node/' . $node->nid;
$edit["body[$langcode][0][value]"] = $this->randomName(256);
// Assume the topic is initially associated with $forum.
$edit["taxonomy_forums[$langcode]"] = $this->root_forum['tid'];
$edit['shadow'] = TRUE;
$this->drupalPost('node/' . $node->nid . '/edit', $edit, t('Save'));
$this->assertRaw(t('Forum topic %title has been updated.', array('%title' => $edit["title"])), 'Forum node was edited');
// Verify topic was moved to a different forum.
$forum_tid = db_query("SELECT tid FROM {forum} WHERE nid = :nid AND vid = :vid", array(
':nid' => $node->nid,
':vid' => $node->vid,
))->fetchField();
$this->assertTrue($forum_tid == $this->root_forum['tid'], 'The forum topic is linked to a different forum');
// Delete forum node.
$this->drupalPost('node/' . $node->nid . '/delete', array(), t('Delete'));
$this->assertResponse($response);
$this->assertRaw(t('Forum topic %title has been deleted.', array('%title' => $edit['title'])), 'Forum node was deleted');
}
}
/**
* Verifies display of forum page.
*
* @param $forum
* A row from the taxonomy_term_data table in an array.
* @param $parent
* (optional) An array representing the forum's parent.
*/
private function verifyForumView($forum, $parent = NULL) {
// View forum page.
$this->drupalGet('forum/' . $forum['tid']);
$this->assertResponse(200);
$this->assertTitle($forum['name'] . ' | Drupal', 'Forum name was displayed');
$breadcrumb = array(
l(t('Home'), NULL),
l(t('Forums'), 'forum'),
);
if (isset($parent)) {
$breadcrumb[] = l($parent['name'], 'forum/' . $parent['tid']);
}
$this->assertRaw(theme('breadcrumb', array('breadcrumb' => $breadcrumb)), 'Breadcrumbs were displayed');
}
/**
* Generates forum topics to test the display of an active forum block.
*
* @param array $forum
* The foorum array (a row from taxonomy_term_data table).
*/
private function generateForumTopics($forum) {
$this->nids = array();
for ($i = 0; $i < 5; $i++) {
$node = $this->createForumTopic($this->forum, FALSE);
$this->nids[] = $node->nid;
}
}
/**
* Views forum topics to test the display of an active forum block.
*
* @todo The logic here is completely incorrect, since the active forum topics
* block is determined by comments on the node, not by views.
* @todo DIE
*
* @param $nids
* An array of forum node IDs.
*/
private function viewForumTopics($nids) {
for ($i = 0; $i < 2; $i++) {
foreach ($nids as $nid) {
$this->drupalGet('node/' . $nid);
$this->drupalGet('node/' . $nid);
$this->drupalGet('node/' . $nid);
}
}
}
}
/**
* Tests the forum index listing.
*/
class ForumIndexTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Forum index',
'description' => 'Tests the forum index listing.',
'group' => 'Forum',
);
}
function setUp() {
parent::setUp('taxonomy', 'comment', 'forum');
// Create a test user.
$web_user = $this->drupalCreateUser(array('create forum content', 'edit own forum content', 'edit any forum content', 'administer nodes'));
$this->drupalLogin($web_user);
}
/**
* Tests the forum index for published and unpublished nodes.
*/
function testForumIndexStatus() {
$langcode = LANGUAGE_NONE;
// The forum ID to use.
$tid = 1;
// Create a test node.
$title = $this->randomName(20);
$edit = array(
"title" => $title,
"body[$langcode][0][value]" => $this->randomName(200),
);
// Create the forum topic, preselecting the forum ID via a URL parameter.
$this->drupalPost('node/add/forum/' . $tid, $edit, t('Save'));
// Check that the node exists in the database.
$node = $this->drupalGetNodeByTitle($title);
$this->assertTrue(!empty($node), 'New forum node found in database.');
// Verify that the node appears on the index.
$this->drupalGet('forum/' . $tid);
$this->assertText($title, 'Published forum topic appears on index.');
// Unpublish the node.
$edit = array(
'status' => FALSE,
);
$this->drupalPost("node/{$node->nid}/edit", $edit, t('Save'));
$this->drupalGet("node/{$node->nid}");
$this->assertText(t('Access denied'), 'Unpublished node is no longer accessible.');
// Verify that the node no longer appears on the index.
$this->drupalGet('forum/' . $tid);
$this->assertNoText($title, 'Unpublished forum topic no longer appears on index.');
}
}
.help-items {
float: right;
padding-right: 0;
padding-left: 3%;
}
.help-items-last {
padding-right: 0;
padding-left: 0;
}
' . t('Help topics') . '
' . t('Help is available on the following items:') . '
' . help_links_as_list();
return $output;
}
/**
* Menu callback; prints a page listing general help for a module.
*
* @param $name
* A module name to display a help page for.
*/
function help_page($name) {
$output = '';
if (module_hook($name, 'help')) {
$info = system_get_info('module');
drupal_set_title($info[$name]['name']);
$temp = module_invoke($name, 'help', "admin/help#$name", drupal_help_arg());
if (empty($temp)) {
$output .= t("No help is available for module %module.", array('%module' => $info[$name]['name']));
}
else {
$output .= $temp;
}
// Only print list of administration pages if the module in question has
// any such pages associated to it.
$admin_tasks = system_get_module_admin_tasks($name, $info[$name]);
if (!empty($admin_tasks)) {
$links = array();
foreach ($admin_tasks as $task) {
$links[] = l($task['title'], $task['link_path'], $task['localized_options']);
}
$output .= theme('item_list', array('items' => $links, 'title' => t('@module administration pages', array('@module' => $info[$name]['name']))));
}
}
return $output;
}
/**
* Provides a formatted list of available help topics.
*
* @return
* A string containing the formatted list.
*/
function help_links_as_list() {
$empty_arg = drupal_help_arg();
$module_info = system_rebuild_module_data();
$modules = array();
foreach (module_implements('help', TRUE) as $module) {
if (module_invoke($module, 'help', "admin/help#$module", $empty_arg)) {
$modules[$module] = $module_info[$module]->info['name'];
}
}
asort($modules);
// Output pretty four-column list.
$count = count($modules);
$break = ceil($count / 4);
$output = '
';
$i = 0;
foreach ($modules as $module => $name) {
$output .= '' . l($name, 'admin/help/' . $module) . ' ';
if (($i + 1) % $break == 0 && ($i + 1) != $count) {
$output .= ' ';
}
$i++;
}
$output .= ' ';
return $output;
}
.help-items {
float: left; /* LTR */
width: 22%;
padding-right: 3%; /* LTR */
}
.help-items-last {
padding-right: 0; /* LTR */
}
name = Help
description = Manages the display of online help.
package = Core
version = VERSION
core = 7.x
files[] = help.test
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
'Help',
'description' => 'Reference for usage, configuration, and modules.',
'page callback' => 'help_main',
'access arguments' => array('access administration pages'),
'weight' => 9,
'file' => 'help.admin.inc',
);
foreach (module_implements('help', TRUE) as $module) {
$items['admin/help/' . $module] = array(
'title' => $module,
'page callback' => 'help_page',
'page arguments' => array(2),
'access arguments' => array('access administration pages'),
'type' => MENU_VISIBLE_IN_BREADCRUMB,
'file' => 'help.admin.inc',
);
}
return $items;
}
/**
* Implements hook_help().
*/
function help_help($path, $arg) {
switch ($path) {
case 'admin/help':
$output = '
' . t('Follow these steps to set up and start using your website:') . '
';
$output .= '
';
$output .= '' . t('Configure your website Once logged in, visit the administration section , where you can customize and configure all aspects of your website.', array('@admin' => url('admin'), '@config' => url('admin/config'))) . ' ';
$output .= '' . t('Enable additional functionality Next, visit the module list and enable features which suit your specific needs. You can find additional modules in the Drupal modules download section .', array('@modules' => url('admin/modules'), '@download_modules' => 'http://drupal.org/project/modules')) . ' ';
$output .= '' . t('Customize your website design To change the "look and feel" of your website, visit the themes section . You may choose from one of the included themes or download additional themes from the Drupal themes download section .', array('@themes' => url('admin/appearance'), '@download_themes' => 'http://drupal.org/project/themes')) . ' ';
$output .= '' . t('Start posting content Finally, you can add new content for your website.', array('@content' => url('node/add'))) . ' ';
$output .= ' ';
$output .= '
' . t('For more information, refer to the specific topics listed in the next section or to the online Drupal handbooks . You may also post at the Drupal forum or view the wide range of other support options available.', array('@help' => url('admin/help'), '@handbook' => 'http://drupal.org/documentation', '@forum' => 'http://drupal.org/forum', '@support' => 'http://drupal.org/support')) . '
';
return $output;
case 'admin/help#help':
$output = '';
$output .= '
' . t('About') . ' ';
$output .= '
' . t('The Help module provides Help reference pages and context-sensitive advice to guide you through the use and configuration of modules. It is a starting point for the online Drupal handbooks . The handbooks contain more extensive and up-to-date information, are annotated with user-contributed comments, and serve as the definitive reference point for all Drupal documentation. For more information, see the online handbook entry for the Help module .', array('@help' => 'http://drupal.org/documentation/modules/help/', '@handbook' => 'http://drupal.org/documentation', '@help-page' => url('admin/help'))) . '
';
$output .= '
' . t('Uses') . ' ';
$output .= '
';
$output .= '' . t('Providing a help reference') . ' ';
$output .= '' . t('The Help module displays explanations for using each module listed on the main Help reference page .', array('@help' => url('admin/help'))) . ' ';
$output .= '' . t('Providing context-sensitive help') . ' ';
$output .= '' . t('The Help module displays context-sensitive advice and explanations on various pages.') . ' ';
$output .= ' ';
return $output;
}
}
'Help functionality',
'description' => 'Verify help display and user access to help based on permissions.',
'group' => 'Help',
);
}
function setUp() {
parent::setUp('blog', 'poll');
$this->getModuleList();
// Create users.
$this->big_user = $this->drupalCreateUser(array('access administration pages', 'view the administration theme', 'administer permissions'));
$this->any_user = $this->drupalCreateUser(array());
}
/**
* Logs in users, creates dblog events, and tests dblog functionality.
*/
function testHelp() {
// Login the admin user.
$this->drupalLogin($this->big_user);
$this->verifyHelp();
// Login the regular user.
$this->drupalLogin($this->any_user);
$this->verifyHelp(403);
// Check for css on admin/help.
$this->drupalLogin($this->big_user);
$this->drupalGet('admin/help');
$this->assertRaw(drupal_get_path('module', 'help') . '/help.css', 'The help.css file is present in the HTML.');
// Verify that introductory help text exists, goes for 100% module coverage.
$this->assertRaw(t('For more information, refer to the specific topics listed in the next section or to the
online Drupal handbooks .', array('@drupal' => 'http://drupal.org/documentation')), 'Help intro text correctly appears.');
// Verify that help topics text appears.
$this->assertRaw('
' . t('Help topics') . ' ' . t('Help is available on the following items:') . '
', 'Help topics text correctly appears.');
// Make sure links are properly added for modules implementing hook_help().
foreach ($this->modules as $module => $name) {
$this->assertLink($name, 0, format_string('Link properly added to @name (admin/help/@module)', array('@module' => $module, '@name' => $name)));
}
}
/**
* Verifies the logged in user has access to the various help nodes.
*
* @param integer $response
* An HTTP response code.
*/
protected function verifyHelp($response = 200) {
foreach ($this->modules as $module => $name) {
// View module help node.
$this->drupalGet('admin/help/' . $module);
$this->assertResponse($response);
if ($response == 200) {
$this->assertTitle($name . ' | Drupal', format_string('%module title was displayed', array('%module' => $module)));
$this->assertRaw('
' . t($name) . ' ', format_string('%module heading was displayed', array('%module' => $module)));
}
}
}
/**
* Gets the list of enabled modules that implement hook_help().
*
* @return array
* A list of enabled modules.
*/
protected function getModuleList() {
$this->modules = array();
$result = db_query("SELECT name, filename, info FROM {system} WHERE type = 'module' AND status = 1 ORDER BY weight ASC, filename ASC");
foreach ($result as $module) {
if (file_exists($module->filename) && function_exists($module->name . '_help')) {
$fullname = unserialize($module->info);
$this->modules[$module->name] = $fullname['name'];
}
}
}
}
/**
* Tests a module without help to verify it is not listed in the help page.
*/
class NoHelpTestCase extends DrupalWebTestCase {
/**
* The user who will be created.
*/
protected $big_user;
public static function getInfo() {
return array(
'name' => 'No help',
'description' => 'Verify no help is displayed for modules not providing any help.',
'group' => 'Help',
);
}
function setUp() {
// Use one of the test modules that do not implement hook_help().
parent::setUp('menu_test');
$this->big_user = $this->drupalCreateUser(array('access administration pages'));
}
/**
* Ensures modules not implementing help do not appear on admin/help.
*/
function testMainPageNoHelp() {
$this->drupalLogin($this->big_user);
$this->drupalGet('admin/help');
$this->assertNoText('Hook menu tests', 'Making sure the test module menu_test does not display a help link in admin/help');
}
}
/**
* Image upload widget.
*/
div.image-preview {
float: right;
padding: 0 0 10px 10px;
}
div.image-widget-data {
float: right;
}
/**
* Image style configuration pages.
*/
div.image-style-new,
div.image-style-new div {
display: inline;
}
div.image-style-preview div.preview-image-wrapper {
float: left;
padding-bottom: 2em;
text-align: center;
top: 50%;
width: 48%;
}
div.image-style-preview div.preview-image {
margin: auto;
position: relative;
}
div.image-style-preview div.preview-image div.width {
border: 1px solid #666;
border-top: none;
height: 2px;
left: -1px;
bottom: -6px;
position: absolute;
}
div.image-style-preview div.preview-image div.width span {
position: relative;
top: 4px;
}
div.image-style-preview div.preview-image div.height {
border: 1px solid #666;
border-left: none;
position: absolute;
right: -6px;
top: -1px;
width: 2px;
}
div.image-style-preview div.preview-image div.height span {
height: 2em;
left: 10px;
margin-top: -1em;
position: absolute;
top: 50%;
}
/**
* Image anchor element.
*/
table.image-anchor {
width: auto;
}
table.image-anchor tr.even,
table.image-anchor tr.odd {
background: none;
}
table.image-anchor td {
border: 1px solid #CCC;
}
theme('image_style_list', array('styles' => $styles)),
'#attached' => array(
'css' => array(drupal_get_path('module', 'image') . '/image.admin.css' => array()),
),
);
return $page;
}
/**
* Form builder; Edit an image style name and effects order.
*
* @param $form_state
* An associative array containing the current state of the form.
* @param $style
* An image style array.
* @ingroup forms
* @see image_style_form_submit()
*/
function image_style_form($form, &$form_state, $style) {
$title = t('Edit %name style', array('%name' => $style['label']));
drupal_set_title($title, PASS_THROUGH);
// Adjust this form for styles that must be overridden to edit.
$editable = (bool) ($style['storage'] & IMAGE_STORAGE_EDITABLE);
if (!$editable && empty($form_state['input'])) {
drupal_set_message(t('This image style is currently being provided by a module. Click the "Override defaults" button to change its settings.'), 'warning');
}
$form_state['image_style'] = $style;
$form['#tree'] = TRUE;
$form['#attached']['css'][drupal_get_path('module', 'image') . '/image.admin.css'] = array();
// Show the thumbnail preview.
$form['preview'] = array(
'#type' => 'item',
'#title' => t('Preview'),
'#markup' => theme('image_style_preview', array('style' => $style)),
);
// Show the Image Style label.
$form['label'] = array(
'#type' => 'textfield',
'#title' => t('Image style name'),
'#default_value' => $style['label'],
'#disabled' => !$editable,
'#required' => TRUE,
);
// Allow the name of the style to be changed, unless this style is
// provided by a module's hook_default_image_styles().
$form['name'] = array(
'#type' => 'machine_name',
'#size' => '64',
'#default_value' => $style['name'],
'#disabled' => !$editable,
'#description' => t('The name is used in URLs for generated images. Use only lowercase alphanumeric characters, underscores (_), and hyphens (-).'),
'#required' => TRUE,
'#machine_name' => array(
'exists' => 'image_style_load',
'source' => array('label'),
'replace_pattern' => '[^0-9a-z_\-]',
'error' => t('Please only use lowercase alphanumeric characters, underscores (_), and hyphens (-) for style names.'),
),
);
// Build the list of existing image effects for this image style.
$form['effects'] = array(
'#theme' => 'image_style_effects',
);
foreach ($style['effects'] as $key => $effect) {
$form['effects'][$key]['#weight'] = isset($form_state['input']['effects']) ? $form_state['input']['effects'][$key]['weight'] : NULL;
$form['effects'][$key]['label'] = array(
'#markup' => $effect['label'],
);
$form['effects'][$key]['summary'] = array(
'#markup' => isset($effect['summary theme']) ? theme($effect['summary theme'], array('data' => $effect['data'])) : '',
);
$form['effects'][$key]['weight'] = array(
'#type' => 'weight',
'#title' => t('Weight for @title', array('@title' => $effect['label'])),
'#title_display' => 'invisible',
'#default_value' => $effect['weight'],
'#access' => $editable,
);
// Only attempt to display these fields for editable styles as the 'ieid'
// key is not set for styles defined in code.
if ($editable) {
$form['effects'][$key]['configure'] = array(
'#type' => 'link',
'#title' => t('edit'),
'#href' => 'admin/config/media/image-styles/edit/' . $style['name'] . '/effects/' . $effect['ieid'],
'#access' => $editable && isset($effect['form callback']),
);
$form['effects'][$key]['remove'] = array(
'#type' => 'link',
'#title' => t('delete'),
'#href' => 'admin/config/media/image-styles/edit/' . $style['name'] . '/effects/' . $effect['ieid'] . '/delete',
'#access' => $editable,
);
}
}
// Build the new image effect addition form and add it to the effect list.
$new_effect_options = array();
foreach (image_effect_definitions() as $effect => $definition) {
$new_effect_options[$effect] = check_plain($definition['label']);
}
$form['effects']['new'] = array(
'#tree' => FALSE,
'#weight' => isset($form_state['input']['weight']) ? $form_state['input']['weight'] : NULL,
'#access' => $editable,
);
$form['effects']['new']['new'] = array(
'#type' => 'select',
'#title' => t('Effect'),
'#title_display' => 'invisible',
'#options' => $new_effect_options,
'#empty_option' => t('Select a new effect'),
);
$form['effects']['new']['weight'] = array(
'#type' => 'weight',
'#title' => t('Weight for new effect'),
'#title_display' => 'invisible',
'#default_value' => count($form['effects']) - 1,
);
$form['effects']['new']['add'] = array(
'#type' => 'submit',
'#value' => t('Add'),
'#validate' => array('image_style_form_add_validate'),
'#submit' => array('image_style_form_submit', 'image_style_form_add_submit'),
);
// Show the Override or Submit button for this style.
$form['actions'] = array('#type' => 'actions');
$form['actions']['override'] = array(
'#type' => 'submit',
'#value' => t('Override defaults'),
'#validate' => array(),
'#submit' => array('image_style_form_override_submit'),
'#access' => !$editable,
);
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Update style'),
'#access' => $editable,
);
return $form;
}
/**
* Validate handler for adding a new image effect to an image style.
*/
function image_style_form_add_validate($form, &$form_state) {
if (!$form_state['values']['new']) {
form_error($form['effects']['new']['new'], t('Select an effect to add.'));
}
}
/**
* Submit handler for adding a new image effect to an image style.
*/
function image_style_form_add_submit($form, &$form_state) {
$style = $form_state['image_style'];
// Check if this field has any configuration options.
$effect = image_effect_definition_load($form_state['values']['new']);
// Load the configuration form for this option.
if (isset($effect['form callback'])) {
$path = 'admin/config/media/image-styles/edit/' . $form_state['image_style']['name'] . '/add/' . $form_state['values']['new'];
$form_state['redirect'] = array($path, array('query' => array('weight' => $form_state['values']['weight'])));
}
// If there's no form, immediately add the image effect.
else {
$effect['isid'] = $style['isid'];
$effect['weight'] = $form_state['values']['weight'];
image_effect_save($effect);
drupal_set_message(t('The image effect was successfully applied.'));
}
}
/**
* Submit handler for overriding a module-defined style.
*/
function image_style_form_override_submit($form, &$form_state) {
drupal_set_message(t('The %style style has been overridden, allowing you to change its settings.', array('%style' => $form_state['image_style']['label'])));
image_default_style_save($form_state['image_style']);
}
/**
* Submit handler for saving an image style.
*/
function image_style_form_submit($form, &$form_state) {
// Update the image style.
$style = $form_state['image_style'];
$style['name'] = $form_state['values']['name'];
$style['label'] = $form_state['values']['label'];
// Update image effect weights.
if (!empty($form_state['values']['effects'])) {
foreach ($form_state['values']['effects'] as $ieid => $effect_data) {
if (isset($style['effects'][$ieid])) {
$effect = $style['effects'][$ieid];
$effect['weight'] = $effect_data['weight'];
image_effect_save($effect);
}
}
}
image_style_save($style);
if ($form_state['values']['op'] == t('Update style')) {
drupal_set_message(t('Changes to the style have been saved.'));
}
$form_state['redirect'] = 'admin/config/media/image-styles/edit/' . $style['name'];
}
/**
* Form builder; Form for adding a new image style.
*
* @ingroup forms
* @see image_style_add_form_submit()
*/
function image_style_add_form($form, &$form_state) {
$form['label'] = array(
'#type' => 'textfield',
'#title' => t('Style name'),
'#default_value' => '',
'#required' => TRUE,
);
$form['name'] = array(
'#type' => 'machine_name',
'#description' => t('The name is used in URLs for generated images. Use only lowercase alphanumeric characters, underscores (_), and hyphens (-).'),
'#size' => '64',
'#required' => TRUE,
'#machine_name' => array(
'exists' => 'image_style_load',
'source' => array('label'),
'replace_pattern' => '[^0-9a-z_\-]',
'error' => t('Please only use lowercase alphanumeric characters, underscores (_), and hyphens (-) for style names.'),
),
);
$form['submit'] = array(
'#type' => 'submit',
'#value' => t('Create new style'),
);
return $form;
}
/**
* Submit handler for adding a new image style.
*/
function image_style_add_form_submit($form, &$form_state) {
$style = array(
'name' => $form_state['values']['name'],
'label' => $form_state['values']['label'],
);
$style = image_style_save($style);
drupal_set_message(t('Style %name was created.', array('%name' => $style['label'])));
$form_state['redirect'] = 'admin/config/media/image-styles/edit/' . $style['name'];
}
/**
* Element validate function to ensure unique, URL safe style names.
*
* This function is no longer used in Drupal core since image style names are
* now validated using #machine_name functionality. It is kept for backwards
* compatibility (since non-core modules may be using it) and will be removed
* in Drupal 8.
*/
function image_style_name_validate($element, $form_state) {
// Check for duplicates.
$styles = image_styles();
if (isset($styles[$element['#value']]) && (!isset($form_state['image_style']['isid']) || $styles[$element['#value']]['isid'] != $form_state['image_style']['isid'])) {
form_set_error($element['#name'], t('The image style name %name is already in use.', array('%name' => $element['#value'])));
}
// Check for illegal characters in image style names.
if (preg_match('/[^0-9a-z_\-]/', $element['#value'])) {
form_set_error($element['#name'], t('Please only use lowercase alphanumeric characters, underscores (_), and hyphens (-) for style names.'));
}
}
/**
* Form builder; Form for deleting an image style.
*
* @param $style
* An image style array.
*
* @ingroup forms
* @see image_style_delete_form_submit()
*/
function image_style_delete_form($form, &$form_state, $style) {
$form_state['image_style'] = $style;
$replacement_styles = array_diff_key(image_style_options(TRUE, PASS_THROUGH), array($style['name'] => ''));
$form['replacement'] = array(
'#title' => t('Replacement style'),
'#type' => 'select',
'#options' => $replacement_styles,
'#empty_option' => t('No replacement, just delete'),
);
return confirm_form(
$form,
t('Optionally select a style before deleting %style', array('%style' => $style['label'])),
'admin/config/media/image-styles',
t('If this style is in use on the site, you may select another style to replace it. All images that have been generated for this style will be permanently deleted.'),
t('Delete'), t('Cancel')
);
}
/**
* Submit handler to delete an image style.
*/
function image_style_delete_form_submit($form, &$form_state) {
$style = $form_state['image_style'];
image_style_delete($style, $form_state['values']['replacement']);
drupal_set_message(t('Style %name was deleted.', array('%name' => $style['label'])));
$form_state['redirect'] = 'admin/config/media/image-styles';
}
/**
* Confirmation form to revert a database style to its default.
*/
function image_style_revert_form($form, &$form_state, $style) {
$form_state['image_style'] = $style;
return confirm_form(
$form,
t('Revert the %style style?', array('%style' => $style['label'])),
'admin/config/media/image-styles',
t('Reverting this style will delete the customized settings and restore the defaults provided by the @module module.', array('@module' => $style['module'])),
t('Revert'), t('Cancel')
);
}
/**
* Submit handler to convert an overridden style to its default.
*/
function image_style_revert_form_submit($form, &$form_state) {
drupal_set_message(t('The %style style has been reverted to its defaults.', array('%style' => $form_state['image_style']['label'])));
image_default_style_revert($form_state['image_style']);
$form_state['redirect'] = 'admin/config/media/image-styles';
}
/**
* Form builder; Form for adding and editing image effects.
*
* This form is used universally for editing all image effects. Each effect adds
* its own custom section to the form by calling the form function specified in
* hook_image_effects().
*
* @param $form_state
* An associative array containing the current state of the form.
* @param $style
* An image style array.
* @param $effect
* An image effect array.
*
* @ingroup forms
* @see hook_image_effects()
* @see image_effects()
* @see image_resize_form()
* @see image_scale_form()
* @see image_rotate_form()
* @see image_crop_form()
* @see image_effect_form_submit()
*/
function image_effect_form($form, &$form_state, $style, $effect) {
if (!empty($effect['data'])) {
$title = t('Edit %label effect', array('%label' => $effect['label']));
}
else{
$title = t('Add %label effect', array('%label' => $effect['label']));
}
drupal_set_title($title, PASS_THROUGH);
$form_state['image_style'] = $style;
$form_state['image_effect'] = $effect;
// If no configuration for this image effect, return to the image style page.
if (!isset($effect['form callback'])) {
drupal_goto('admin/config/media/image-styles/edit/' . $style['name']);
}
$form['#tree'] = TRUE;
$form['#attached']['css'][drupal_get_path('module', 'image') . '/image.admin.css'] = array();
if (function_exists($effect['form callback'])) {
$form['data'] = call_user_func($effect['form callback'], $effect['data']);
}
// Check the URL for a weight, then the image effect, otherwise use default.
$form['weight'] = array(
'#type' => 'hidden',
'#value' => isset($_GET['weight']) ? intval($_GET['weight']) : (isset($effect['weight']) ? $effect['weight'] : count($style['effects'])),
);
$form['actions'] = array('#tree' => FALSE, '#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => isset($effect['ieid']) ? t('Update effect') : t('Add effect'),
);
$form['actions']['cancel'] = array(
'#type' => 'link',
'#title' => t('Cancel'),
'#href' => 'admin/config/media/image-styles/edit/' . $style['name'],
);
return $form;
}
/**
* Submit handler for updating an image effect.
*/
function image_effect_form_submit($form, &$form_state) {
$style = $form_state['image_style'];
$effect = array_merge($form_state['image_effect'], $form_state['values']);
$effect['isid'] = $style['isid'];
image_effect_save($effect);
drupal_set_message(t('The image effect was successfully applied.'));
$form_state['redirect'] = 'admin/config/media/image-styles/edit/' . $style['name'];
}
/**
* Form builder; Form for deleting an image effect.
*
* @param $style
* Name of the image style from which the image effect will be removed.
* @param $effect
* Name of the image effect to remove.
* @ingroup forms
* @see image_effect_delete_form_submit()
*/
function image_effect_delete_form($form, &$form_state, $style, $effect) {
$form_state['image_style'] = $style;
$form_state['image_effect'] = $effect;
$question = t('Are you sure you want to delete the @effect effect from the %style style?', array('%style' => $style['label'], '@effect' => $effect['label']));
return confirm_form($form, $question, 'admin/config/media/image-styles/edit/' . $style['name'], '', t('Delete'));
}
/**
* Submit handler to delete an image effect.
*/
function image_effect_delete_form_submit($form, &$form_state) {
$style = $form_state['image_style'];
$effect = $form_state['image_effect'];
image_effect_delete($effect);
drupal_set_message(t('The image effect %name has been deleted.', array('%name' => $effect['label'])));
$form_state['redirect'] = 'admin/config/media/image-styles/edit/' . $style['name'];
}
/**
* Element validate handler to ensure an integer pixel value.
*
* The property #allow_negative = TRUE may be set to allow negative integers.
*/
function image_effect_integer_validate($element, &$form_state) {
$value = empty($element['#allow_negative']) ? $element['#value'] : preg_replace('/^-/', '', $element['#value']);
if ($element['#value'] != '' && (!is_numeric($value) || intval($value) <= 0)) {
if (empty($element['#allow_negative'])) {
form_error($element, t('!name must be an integer.', array('!name' => $element['#title'])));
}
else {
form_error($element, t('!name must be a positive integer.', array('!name' => $element['#title'])));
}
}
}
/**
* Element validate handler to ensure a hexadecimal color value.
*/
function image_effect_color_validate($element, &$form_state) {
if ($element['#value'] != '') {
$hex_value = preg_replace('/^#/', '', $element['#value']);
if (!preg_match('/^#[0-9A-F]{3}([0-9A-F]{3})?$/', $element['#value'])) {
form_error($element, t('!name must be a hexadecimal color value.', array('!name' => $element['#title'])));
}
}
}
/**
* Element validate handler to ensure that either a height or a width is
* specified.
*/
function image_effect_scale_validate($element, &$form_state) {
if (empty($element['width']['#value']) && empty($element['height']['#value'])) {
form_error($element, t('Width and height can not both be blank.'));
}
}
/**
* Form structure for the image resize form.
*
* Note that this is not a complete form, it only contains the portion of the
* form for configuring the resize options. Therefore it does not not need to
* include metadata about the effect, nor a submit button.
*
* @param $data
* The current configuration for this resize effect.
*/
function image_resize_form($data) {
$form['width'] = array(
'#type' => 'textfield',
'#title' => t('Width'),
'#default_value' => isset($data['width']) ? $data['width'] : '',
'#field_suffix' => ' ' . t('pixels'),
'#required' => TRUE,
'#size' => 10,
'#element_validate' => array('image_effect_integer_validate'),
'#allow_negative' => FALSE,
);
$form['height'] = array(
'#type' => 'textfield',
'#title' => t('Height'),
'#default_value' => isset($data['height']) ? $data['height'] : '',
'#field_suffix' => ' ' . t('pixels'),
'#required' => TRUE,
'#size' => 10,
'#element_validate' => array('image_effect_integer_validate'),
'#allow_negative' => FALSE,
);
return $form;
}
/**
* Form structure for the image scale form.
*
* Note that this is not a complete form, it only contains the portion of the
* form for configuring the scale options. Therefore it does not not need to
* include metadata about the effect, nor a submit button.
*
* @param $data
* The current configuration for this scale effect.
*/
function image_scale_form($data) {
$form = image_resize_form($data);
$form['#element_validate'] = array('image_effect_scale_validate');
$form['width']['#required'] = FALSE;
$form['height']['#required'] = FALSE;
$form['upscale'] = array(
'#type' => 'checkbox',
'#default_value' => (isset($data['upscale'])) ? $data['upscale'] : 0,
'#title' => t('Allow Upscaling'),
'#description' => t('Let scale make images larger than their original size'),
);
return $form;
}
/**
* Form structure for the image crop form.
*
* Note that this is not a complete form, it only contains the portion of the
* form for configuring the crop options. Therefore it does not not need to
* include metadata about the effect, nor a submit button.
*
* @param $data
* The current configuration for this crop effect.
*/
function image_crop_form($data) {
$data += array(
'width' => '',
'height' => '',
'anchor' => 'center-center',
);
$form = image_resize_form($data);
$form['anchor'] = array(
'#type' => 'radios',
'#title' => t('Anchor'),
'#options' => array(
'left-top' => t('Top left'),
'center-top' => t('Top center'),
'right-top' => t('Top right'),
'left-center' => t('Center left'),
'center-center' => t('Center'),
'right-center' => t('Center right'),
'left-bottom' => t('Bottom left'),
'center-bottom' => t('Bottom center'),
'right-bottom' => t('Bottom right'),
),
'#theme' => 'image_anchor',
'#default_value' => $data['anchor'],
'#description' => t('The part of the image that will be retained during the crop.'),
);
return $form;
}
/**
* Form structure for the image rotate form.
*
* Note that this is not a complete form, it only contains the portion of the
* form for configuring the rotate options. Therefore it does not not need to
* include metadata about the effect, nor a submit button.
*
* @param $data
* The current configuration for this rotate effect.
*/
function image_rotate_form($data) {
$form['degrees'] = array(
'#type' => 'textfield',
'#default_value' => (isset($data['degrees'])) ? $data['degrees'] : 0,
'#title' => t('Rotation angle'),
'#description' => t('The number of degrees the image should be rotated. Positive numbers are clockwise, negative are counter-clockwise.'),
'#field_suffix' => '°',
'#required' => TRUE,
'#size' => 6,
'#maxlength' => 4,
'#element_validate' => array('image_effect_integer_validate'),
'#allow_negative' => TRUE,
);
$form['bgcolor'] = array(
'#type' => 'textfield',
'#default_value' => (isset($data['bgcolor'])) ? $data['bgcolor'] : '#FFFFFF',
'#title' => t('Background color'),
'#description' => t('The background color to use for exposed areas of the image. Use web-style hex colors (#FFFFFF for white, #000000 for black). Leave blank for transparency on image types that support it.'),
'#size' => 7,
'#maxlength' => 7,
'#element_validate' => array('image_effect_color_validate'),
);
$form['random'] = array(
'#type' => 'checkbox',
'#default_value' => (isset($data['random'])) ? $data['random'] : 0,
'#title' => t('Randomize'),
'#description' => t('Randomize the rotation angle for each image. The angle specified above is used as a maximum.'),
);
return $form;
}
/**
* Returns HTML for the page containing the list of image styles.
*
* @param $variables
* An associative array containing:
* - styles: An array of all the image styles returned by image_get_styles().
*
* @see image_get_styles()
* @ingroup themeable
*/
function theme_image_style_list($variables) {
$styles = $variables['styles'];
$header = array(t('Style name'), t('Settings'), array('data' => t('Operations'), 'colspan' => 3));
$rows = array();
foreach ($styles as $style) {
$row = array();
$row[] = l($style['label'], 'admin/config/media/image-styles/edit/' . $style['name']);
$link_attributes = array(
'attributes' => array(
'class' => array('image-style-link'),
),
);
if ($style['storage'] == IMAGE_STORAGE_NORMAL) {
$row[] = t('Custom');
$row[] = l(t('edit'), 'admin/config/media/image-styles/edit/' . $style['name'], $link_attributes);
$row[] = l(t('delete'), 'admin/config/media/image-styles/delete/' . $style['name'], $link_attributes);
}
elseif ($style['storage'] == IMAGE_STORAGE_OVERRIDE) {
$row[] = t('Overridden');
$row[] = l(t('edit'), 'admin/config/media/image-styles/edit/' . $style['name'], $link_attributes);
$row[] = l(t('revert'), 'admin/config/media/image-styles/revert/' . $style['name'], $link_attributes);
}
else {
$row[] = t('Default');
$row[] = l(t('edit'), 'admin/config/media/image-styles/edit/' . $style['name'], $link_attributes);
$row[] = '';
}
$rows[] = $row;
}
if (empty($rows)) {
$rows[] = array(array(
'colspan' => 4,
'data' => t('There are currently no styles.
Add a new one .', array('!url' => url('admin/config/media/image-styles/add'))),
));
}
return theme('table', array('header' => $header, 'rows' => $rows));
}
/**
* Returns HTML for a listing of the effects within a specific image style.
*
* @param $variables
* An associative array containing:
* - form: A render element representing the form.
*
* @ingroup themeable
*/
function theme_image_style_effects($variables) {
$form = $variables['form'];
$rows = array();
foreach (element_children($form) as $key) {
$row = array();
$form[$key]['weight']['#attributes']['class'] = array('image-effect-order-weight');
if (is_numeric($key)) {
$summary = drupal_render($form[$key]['summary']);
$row[] = drupal_render($form[$key]['label']) . (empty($summary) ? '' : ' ' . $summary);
$row[] = drupal_render($form[$key]['weight']);
$row[] = drupal_render($form[$key]['configure']);
$row[] = drupal_render($form[$key]['remove']);
}
else {
// Add the row for adding a new image effect.
$row[] = '
' . drupal_render($form['new']['new']) . drupal_render($form['new']['add']) . '
';
$row[] = drupal_render($form['new']['weight']);
$row[] = array('data' => '', 'colspan' => 2);
}
if (!isset($form[$key]['#access']) || $form[$key]['#access']) {
$rows[] = array(
'data' => $row,
// Use a strict (===) comparison since $key can be 0.
'class' => !empty($form[$key]['weight']['#access']) || $key === 'new' ? array('draggable') : array(),
);
}
}
$header = array(
t('Effect'),
t('Weight'),
array('data' => t('Operations'), 'colspan' => 2),
);
if (count($rows) == 1 && $form['new']['#access']) {
array_unshift($rows, array(array(
'data' => t('There are currently no effects in this style. Add one by selecting an option below.'),
'colspan' => 4,
)));
}
$output = theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('id' => 'image-style-effects')));
drupal_add_tabledrag('image-style-effects', 'order', 'sibling', 'image-effect-order-weight');
return $output;
}
/**
* Returns HTML for a preview of an image style.
*
* @param $variables
* An associative array containing:
* - style: The image style array being previewed.
*
* @ingroup themeable
*/
function theme_image_style_preview($variables) {
$style = $variables['style'];
$sample_image = variable_get('image_style_preview_image', drupal_get_path('module', 'image') . '/sample.png');
$sample_width = 160;
$sample_height = 160;
// Set up original file information.
$original_path = $sample_image;
$original_image = image_get_info($original_path);
if ($original_image['width'] > $original_image['height']) {
$original_width = min($original_image['width'], $sample_width);
$original_height = round($original_width / $original_image['width'] * $original_image['height']);
}
else {
$original_height = min($original_image['height'], $sample_height);
$original_width = round($original_height / $original_image['height'] * $original_image['width']);
}
$original_attributes = array_intersect_key($original_image, array('width' => '', 'height' => ''));
$original_attributes['style'] = 'width: ' . $original_width . 'px; height: ' . $original_height . 'px;';
// Set up preview file information.
$preview_file = image_style_path($style['name'], $original_path);
if (!file_exists($preview_file)) {
image_style_create_derivative($style, $original_path, $preview_file);
}
$preview_image = image_get_info($preview_file);
if ($preview_image['width'] > $preview_image['height']) {
$preview_width = min($preview_image['width'], $sample_width);
$preview_height = round($preview_width / $preview_image['width'] * $preview_image['height']);
}
else {
$preview_height = min($preview_image['height'], $sample_height);
$preview_width = round($preview_height / $preview_image['height'] * $preview_image['width']);
}
$preview_attributes = array_intersect_key($preview_image, array('width' => '', 'height' => ''));
$preview_attributes['style'] = 'width: ' . $preview_width . 'px; height: ' . $preview_height . 'px;';
// In the previews, timestamps are added to prevent caching of images.
$output = '
';
// Build the preview of the original image.
$original_url = file_create_url($original_path);
$output .= '
';
$output .= t('original') . ' (' . l(t('view actual size'), $original_url) . ')';
$output .= '
'; // End preview-image.
$output .= '
'; // End preview-image-wrapper.
// Build the preview of the image style.
$preview_url = file_create_url($preview_file) . '?cache_bypass=' . REQUEST_TIME;
$output .= '
';
$output .= check_plain($style['label']) . ' (' . l(t('view actual size'), file_create_url($preview_file) . '?' . time()) . ')';
$output .= '
'; // End preview-image.
$output .= '
'; // End preview-image-wrapper.
$output .= '
'; // End image-style-preview.
return $output;
}
/**
* Returns HTML for a 3x3 grid of checkboxes for image anchors.
*
* @param $variables
* An associative array containing:
* - element: A render element containing radio buttons.
*
* @ingroup themeable
*/
function theme_image_anchor($variables) {
$element = $variables['element'];
$rows = array();
$row = array();
foreach (element_children($element) as $n => $key) {
$element[$key]['#attributes']['title'] = $element[$key]['#title'];
unset($element[$key]['#title']);
$row[] = drupal_render($element[$key]);
if ($n % 3 == 3 - 1) {
$rows[] = $row;
$row = array();
}
}
return theme('table', array('header' => array(), 'rows' => $rows, 'attributes' => array('class' => array('image-anchor'))));
}
/**
* Returns HTML for a summary of an image resize effect.
*
* @param $variables
* An associative array containing:
* - data: The current configuration for this resize effect.
*
* @ingroup themeable
*/
function theme_image_resize_summary($variables) {
$data = $variables['data'];
if ($data['width'] && $data['height']) {
return check_plain($data['width']) . 'x' . check_plain($data['height']);
}
else {
return ($data['width']) ? t('width @width', array('@width' => $data['width'])) : t('height @height', array('@height' => $data['height']));
}
}
/**
* Returns HTML for a summary of an image scale effect.
*
* @param $variables
* An associative array containing:
* - data: The current configuration for this scale effect.
*
* @ingroup themeable
*/
function theme_image_scale_summary($variables) {
$data = $variables['data'];
return theme('image_resize_summary', array('data' => $data)) . ' ' . ($data['upscale'] ? '(' . t('upscaling allowed') . ')' : '');
}
/**
* Returns HTML for a summary of an image crop effect.
*
* @param $variables
* An associative array containing:
* - data: The current configuration for this crop effect.
*
* @ingroup themeable
*/
function theme_image_crop_summary($variables) {
return theme('image_resize_summary', $variables);
}
/**
* Returns HTML for a summary of an image rotate effect.
*
* @param $variables
* An associative array containing:
* - data: The current configuration for this rotate effect.
*
* @ingroup themeable
*/
function theme_image_rotate_summary($variables) {
$data = $variables['data'];
return ($data['random']) ? t('random between -@degrees° and @degrees°', array('@degrees' => str_replace('-', '', $data['degrees']))) : t('@degrees°', array('@degrees' => $data['degrees']));
}
t('Resize'),
'help' => t('Resize an image to an exact set of dimensions, ignoring aspect ratio.'),
'effect callback' => 'mymodule_resize_effect',
'dimensions callback' => 'mymodule_resize_dimensions',
'form callback' => 'mymodule_resize_form',
'summary theme' => 'mymodule_resize_summary',
);
return $effects;
}
/**
* Alter the information provided in hook_image_effect_info().
*
* @param $effects
* The array of image effects, keyed on the machine-readable effect name.
*
* @see hook_image_effect_info()
*/
function hook_image_effect_info_alter(&$effects) {
// Override the Image module's crop effect with more options.
$effects['image_crop']['effect callback'] = 'mymodule_crop_effect';
$effects['image_crop']['dimensions callback'] = 'mymodule_crop_dimensions';
$effects['image_crop']['form callback'] = 'mymodule_crop_form';
}
/**
* Respond to image style updating.
*
* This hook enables modules to update settings that might be affected by
* changes to an image. For example, updating a module specific variable to
* reflect a change in the image style's name.
*
* @param $style
* The image style array that is being updated.
*/
function hook_image_style_save($style) {
// If a module defines an image style and that style is renamed by the user
// the module should update any references to that style.
if (isset($style['old_name']) && $style['old_name'] == variable_get('mymodule_image_style', '')) {
variable_set('mymodule_image_style', $style['name']);
}
}
/**
* Respond to image style deletion.
*
* This hook enables modules to update settings when a image style is being
* deleted. If a style is deleted, a replacement name may be specified in
* $style['name'] and the style being deleted will be specified in
* $style['old_name'].
*
* @param $style
* The image style array that being deleted.
*/
function hook_image_style_delete($style) {
// Administrators can choose an optional replacement style when deleting.
// Update the modules style variable accordingly.
if (isset($style['old_name']) && $style['old_name'] == variable_get('mymodule_image_style', '')) {
variable_set('mymodule_image_style', $style['name']);
}
}
/**
* Respond to image style flushing.
*
* This hook enables modules to take effect when a style is being flushed (all
* images are being deleted from the server and regenerated). Any
* module-specific caches that contain information related to the style should
* be cleared using this hook. This hook is called whenever a style is updated,
* deleted, or any effect associated with the style is update or deleted.
*
* @param $style
* The image style array that is being flushed.
*/
function hook_image_style_flush($style) {
// Empty cached data that contains information about the style.
cache_clear_all('*', 'cache_mymodule', TRUE);
}
/**
* Modify any image styles provided by other modules or the user.
*
* This hook allows modules to modify, add, or remove image styles. This may
* be useful to modify default styles provided by other modules or enforce
* that a specific effect is always enabled on a style. Note that modifications
* to these styles may negatively affect the user experience, such as if an
* effect is added to a style through this hook, the user may attempt to remove
* the effect but it will be immediately be re-added.
*
* The best use of this hook is usually to modify default styles, which are not
* editable by the user until they are overridden, so such interface
* contradictions will not occur. This hook can target default (or user) styles
* by checking the $style['storage'] property.
*
* If your module needs to provide a new style (rather than modify an existing
* one) use hook_image_default_styles() instead.
*
* @see hook_image_default_styles()
*/
function hook_image_styles_alter(&$styles) {
// Check that we only affect a default style.
if ($styles['thumbnail']['storage'] == IMAGE_STORAGE_DEFAULT) {
// Add an additional effect to the thumbnail style.
$styles['thumbnail']['effects'][] = array(
'name' => 'image_desaturate',
'data' => array(),
'weight' => 1,
'effect callback' => 'image_desaturate_effect',
);
}
}
/**
* Provide module-based image styles for reuse throughout Drupal.
*
* This hook allows your module to provide image styles. This may be useful if
* you require images to fit within exact dimensions. Note that you should
* attempt to re-use the default styles provided by Image module whenever
* possible, rather than creating image styles that are specific to your module.
* Image provides the styles "thumbnail", "medium", and "large".
*
* You may use this hook to more easily manage your site's changes by moving
* existing image styles from the database to a custom module. Note however that
* moving image styles to code instead storing them in the database has a
* negligible effect on performance, since custom image styles are loaded
* from the database all at once. Even if all styles are pulled from modules,
* Image module will still perform the same queries to check the database for
* any custom styles.
*
* @return
* An array of image styles, keyed by the style name.
* @see image_image_default_styles()
*/
function hook_image_default_styles() {
$styles = array();
$styles['mymodule_preview'] = array(
'label' => 'My module preview',
'effects' => array(
array(
'name' => 'image_scale',
'data' => array('width' => 400, 'height' => 400, 'upscale' => 1),
'weight' => 0,
),
array(
'name' => 'image_desaturate',
'data' => array(),
'weight' => 1,
),
),
);
return $styles;
}
/**
* @} End of "addtogroup hooks".
*/
/**
* Image upload widget.
*/
div.image-preview {
float: left; /* LTR */
padding: 0 10px 10px 0; /* LTR */
}
div.image-widget-data {
float: left; /* LTR */
}
div.image-widget-data input.text-field {
width: auto;
}
array(
'label' => t('Resize'),
'help' => t('Resizing will make images an exact set of dimensions. This may cause images to be stretched or shrunk disproportionately.'),
'effect callback' => 'image_resize_effect',
'dimensions callback' => 'image_resize_dimensions',
'form callback' => 'image_resize_form',
'summary theme' => 'image_resize_summary',
),
'image_scale' => array(
'label' => t('Scale'),
'help' => t('Scaling will maintain the aspect-ratio of the original image. If only a single dimension is specified, the other dimension will be calculated.'),
'effect callback' => 'image_scale_effect',
'dimensions callback' => 'image_scale_dimensions',
'form callback' => 'image_scale_form',
'summary theme' => 'image_scale_summary',
),
'image_scale_and_crop' => array(
'label' => t('Scale and crop'),
'help' => t('Scale and crop will maintain the aspect-ratio of the original image, then crop the larger dimension. This is most useful for creating perfectly square thumbnails without stretching the image.'),
'effect callback' => 'image_scale_and_crop_effect',
'dimensions callback' => 'image_resize_dimensions',
'form callback' => 'image_resize_form',
'summary theme' => 'image_resize_summary',
),
'image_crop' => array(
'label' => t('Crop'),
'help' => t('Cropping will remove portions of an image to make it the specified dimensions.'),
'effect callback' => 'image_crop_effect',
'dimensions callback' => 'image_resize_dimensions',
'form callback' => 'image_crop_form',
'summary theme' => 'image_crop_summary',
),
'image_desaturate' => array(
'label' => t('Desaturate'),
'help' => t('Desaturate converts an image to grayscale.'),
'effect callback' => 'image_desaturate_effect',
'dimensions passthrough' => TRUE,
),
'image_rotate' => array(
'label' => t('Rotate'),
'help' => t('Rotating an image may cause the dimensions of an image to increase to fit the diagonal.'),
'effect callback' => 'image_rotate_effect',
'dimensions callback' => 'image_rotate_dimensions',
'form callback' => 'image_rotate_form',
'summary theme' => 'image_rotate_summary',
),
);
return $effects;
}
/**
* Image effect callback; Resize an image resource.
*
* @param $image
* An image object returned by image_load().
* @param $data
* An array of attributes to use when performing the resize effect with the
* following items:
* - "width": An integer representing the desired width in pixels.
* - "height": An integer representing the desired height in pixels.
*
* @return
* TRUE on success. FALSE on failure to resize image.
*
* @see image_resize()
*/
function image_resize_effect(&$image, $data) {
if (!image_resize($image, $data['width'], $data['height'])) {
watchdog('image', 'Image resize failed using the %toolkit toolkit on %path (%mimetype, %dimensions)', array('%toolkit' => $image->toolkit, '%path' => $image->source, '%mimetype' => $image->info['mime_type'], '%dimensions' => $image->info['width'] . 'x' . $image->info['height']), WATCHDOG_ERROR);
return FALSE;
}
return TRUE;
}
/**
* Image dimensions callback; Resize.
*
* @param $dimensions
* Dimensions to be modified - an array with components width and height, in
* pixels.
* @param $data
* An array of attributes to use when performing the resize effect with the
* following items:
* - "width": An integer representing the desired width in pixels.
* - "height": An integer representing the desired height in pixels.
*/
function image_resize_dimensions(array &$dimensions, array $data) {
// The new image will have the exact dimensions defined for the effect.
$dimensions['width'] = $data['width'];
$dimensions['height'] = $data['height'];
}
/**
* Image effect callback; Scale an image resource.
*
* @param $image
* An image object returned by image_load().
* @param $data
* An array of attributes to use when performing the scale effect with the
* following items:
* - "width": An integer representing the desired width in pixels.
* - "height": An integer representing the desired height in pixels.
* - "upscale": A boolean indicating that the image should be upscaled if the
* dimensions are larger than the original image.
*
* @return
* TRUE on success. FALSE on failure to scale image.
*
* @see image_scale()
*/
function image_scale_effect(&$image, $data) {
// Set sane default values.
$data += array(
'width' => NULL,
'height' => NULL,
'upscale' => FALSE,
);
if (!image_scale($image, $data['width'], $data['height'], $data['upscale'])) {
watchdog('image', 'Image scale failed using the %toolkit toolkit on %path (%mimetype, %dimensions)', array('%toolkit' => $image->toolkit, '%path' => $image->source, '%mimetype' => $image->info['mime_type'], '%dimensions' => $image->info['width'] . 'x' . $image->info['height']), WATCHDOG_ERROR);
return FALSE;
}
return TRUE;
}
/**
* Image dimensions callback; Scale.
*
* @param $dimensions
* Dimensions to be modified - an array with components width and height, in
* pixels.
* @param $data
* An array of attributes to use when performing the scale effect with the
* following items:
* - "width": An integer representing the desired width in pixels.
* - "height": An integer representing the desired height in pixels.
* - "upscale": A boolean indicating that the image should be upscaled if the
* dimensions are larger than the original image.
*/
function image_scale_dimensions(array &$dimensions, array $data) {
if ($dimensions['width'] && $dimensions['height']) {
image_dimensions_scale($dimensions, $data['width'], $data['height'], $data['upscale']);
}
}
/**
* Image effect callback; Crop an image resource.
*
* @param $image
* An image object returned by image_load().
* @param $data
* An array of attributes to use when performing the crop effect with the
* following items:
* - "width": An integer representing the desired width in pixels.
* - "height": An integer representing the desired height in pixels.
* - "anchor": A string describing where the crop should originate in the form
* of "XOFFSET-YOFFSET". XOFFSET is either a number of pixels or
* "left", "center", "right" and YOFFSET is either a number of pixels or
* "top", "center", "bottom".
* @return
* TRUE on success. FALSE on failure to crop image.
* @see image_crop()
*/
function image_crop_effect(&$image, $data) {
// Set sane default values.
$data += array(
'anchor' => 'center-center',
);
list($x, $y) = explode('-', $data['anchor']);
$x = image_filter_keyword($x, $image->info['width'], $data['width']);
$y = image_filter_keyword($y, $image->info['height'], $data['height']);
if (!image_crop($image, $x, $y, $data['width'], $data['height'])) {
watchdog('image', 'Image crop failed using the %toolkit toolkit on %path (%mimetype, %dimensions)', array('%toolkit' => $image->toolkit, '%path' => $image->source, '%mimetype' => $image->info['mime_type'], '%dimensions' => $image->info['width'] . 'x' . $image->info['height']), WATCHDOG_ERROR);
return FALSE;
}
return TRUE;
}
/**
* Image effect callback; Scale and crop an image resource.
*
* @param $image
* An image object returned by image_load().
* @param $data
* An array of attributes to use when performing the scale and crop effect
* with the following items:
* - "width": An integer representing the desired width in pixels.
* - "height": An integer representing the desired height in pixels.
* @return
* TRUE on success. FALSE on failure to scale and crop image.
* @see image_scale_and_crop()
*/
function image_scale_and_crop_effect(&$image, $data) {
if (!image_scale_and_crop($image, $data['width'], $data['height'])) {
watchdog('image', 'Image scale and crop failed using the %toolkit toolkit on %path (%mimetype, %dimensions)', array('%toolkit' => $image->toolkit, '%path' => $image->source, '%mimetype' => $image->info['mime_type'], '%dimensions' => $image->info['width'] . 'x' . $image->info['height']), WATCHDOG_ERROR);
return FALSE;
}
return TRUE;
}
/**
* Image effect callback; Desaturate (grayscale) an image resource.
*
* @param $image
* An image object returned by image_load().
* @param $data
* An array of attributes to use when performing the desaturate effect.
* @return
* TRUE on success. FALSE on failure to desaturate image.
* @see image_desaturate()
*/
function image_desaturate_effect(&$image, $data) {
if (!image_desaturate($image)) {
watchdog('image', 'Image desaturate failed using the %toolkit toolkit on %path (%mimetype, %dimensions)', array('%toolkit' => $image->toolkit, '%path' => $image->source, '%mimetype' => $image->info['mime_type'], '%dimensions' => $image->info['width'] . 'x' . $image->info['height']), WATCHDOG_ERROR);
return FALSE;
}
return TRUE;
}
/**
* Image effect callback; Rotate an image resource.
*
* @param $image
* An image object returned by image_load().
* @param $data
* An array of attributes to use when performing the rotate effect containing
* the following items:
* - "degrees": The number of (clockwise) degrees to rotate the image.
* - "random": A boolean indicating that a random rotation angle should be
* used for this image. The angle specified in "degrees" is used as a
* positive and negative maximum.
* - "bgcolor": The background color to use for exposed areas of the image.
* Use web-style hex colors (#FFFFFF for white, #000000 for black). Leave
* blank for transparency on image types that support it.
* @return
* TRUE on success. FALSE on failure to rotate image.
* @see image_rotate().
*/
function image_rotate_effect(&$image, $data) {
// Set sane default values.
$data += array(
'degrees' => 0,
'bgcolor' => NULL,
'random' => FALSE,
);
// Convert short #FFF syntax to full #FFFFFF syntax.
if (strlen((string) $data['bgcolor']) == 4) {
$c = $data['bgcolor'];
$data['bgcolor'] = $c[0] . $c[1] . $c[1] . $c[2] . $c[2] . $c[3] . $c[3];
}
// Convert #FFFFFF syntax to hexadecimal colors.
if ($data['bgcolor'] != '') {
$data['bgcolor'] = hexdec(str_replace('#', '0x', $data['bgcolor']));
}
else {
$data['bgcolor'] = NULL;
}
if (!empty($data['random'])) {
$degrees = abs((float) $data['degrees']);
$data['degrees'] = rand(-1 * $degrees, $degrees);
}
if (!image_rotate($image, $data['degrees'], $data['bgcolor'])) {
watchdog('image', 'Image rotate failed using the %toolkit toolkit on %path (%mimetype, %dimensions)', array('%toolkit' => $image->toolkit, '%path' => $image->source, '%mimetype' => $image->info['mime_type'], '%dimensions' => $image->info['width'] . 'x' . $image->info['height']), WATCHDOG_ERROR);
return FALSE;
}
return TRUE;
}
/**
* Image dimensions callback; Rotate.
*
* @param $dimensions
* Dimensions to be modified - an array with components width and height, in
* pixels.
* @param $data
* An array of attributes to use when performing the rotate effect containing
* the following items:
* - "degrees": The number of (clockwise) degrees to rotate the image.
* - "random": A boolean indicating that a random rotation angle should be
* used for this image. The angle specified in "degrees" is used as a
* positive and negative maximum.
*/
function image_rotate_dimensions(array &$dimensions, array $data) {
// If the rotate is not random and the angle is a multiple of 90 degrees,
// then the new dimensions can be determined.
if (!$data['random'] && ((int) ($data['degrees']) == $data['degrees']) && ($data['degrees'] % 90 == 0)) {
if ($data['degrees'] % 180 != 0) {
$temp = $dimensions['width'];
$dimensions['width'] = $dimensions['height'];
$dimensions['height'] = $temp;
}
}
else {
$dimensions['width'] = $dimensions['height'] = NULL;
}
}
array(
'label' => t('Image'),
'description' => t('This field stores the ID of an image file as an integer value.'),
'settings' => array(
'uri_scheme' => variable_get('file_default_scheme', 'public'),
'default_image' => 0,
),
'instance_settings' => array(
'file_extensions' => 'png gif jpg jpeg',
'file_directory' => '[date:custom:Y]-[date:custom:m]',
'max_filesize' => '',
'alt_field' => 0,
'title_field' => 0,
'max_resolution' => '',
'min_resolution' => '',
'default_image' => 0,
),
'default_widget' => 'image_image',
'default_formatter' => 'image',
),
);
}
/**
* Implements hook_field_settings_form().
*/
function image_field_settings_form($field, $instance) {
$defaults = field_info_field_settings($field['type']);
$settings = array_merge($defaults, $field['settings']);
$scheme_options = array();
foreach (file_get_stream_wrappers(STREAM_WRAPPERS_WRITE_VISIBLE) as $scheme => $stream_wrapper) {
$scheme_options[$scheme] = $stream_wrapper['name'];
}
$form['uri_scheme'] = array(
'#type' => 'radios',
'#title' => t('Upload destination'),
'#options' => $scheme_options,
'#default_value' => $settings['uri_scheme'],
'#description' => t('Select where the final files should be stored. Private file storage has significantly more overhead than public files, but allows restricted access to files within this field.'),
);
// When the user sets the scheme on the UI, even for the first time, it's
// updating a field because fields are created on the "Manage fields"
// page. So image_field_update_field() can handle this change.
$form['default_image'] = array(
'#title' => t('Default image'),
'#type' => 'managed_file',
'#description' => t('If no image is uploaded, this image will be shown on display.'),
'#default_value' => $field['settings']['default_image'],
'#upload_location' => $settings['uri_scheme'] . '://default_images/',
);
return $form;
}
/**
* Implements hook_field_instance_settings_form().
*/
function image_field_instance_settings_form($field, $instance) {
$settings = $instance['settings'];
// Use the file field instance settings form as a basis.
$form = file_field_instance_settings_form($field, $instance);
// Add maximum and minimum resolution settings.
$max_resolution = explode('x', $settings['max_resolution']) + array('', '');
$form['max_resolution'] = array(
'#type' => 'item',
'#title' => t('Maximum image resolution'),
'#element_validate' => array('_image_field_resolution_validate'),
'#weight' => 4.1,
'#field_prefix' => '
',
'#field_suffix' => '
',
'#description' => t('The maximum allowed image size expressed as WIDTHxHEIGHT (e.g. 640x480). Leave blank for no restriction. If a larger image is uploaded, it will be resized to reflect the given width and height. Resizing images on upload will cause the loss of
EXIF data in the image.'),
);
$form['max_resolution']['x'] = array(
'#type' => 'textfield',
'#title' => t('Maximum width'),
'#title_display' => 'invisible',
'#default_value' => $max_resolution[0],
'#size' => 5,
'#maxlength' => 5,
'#field_suffix' => ' x ',
);
$form['max_resolution']['y'] = array(
'#type' => 'textfield',
'#title' => t('Maximum height'),
'#title_display' => 'invisible',
'#default_value' => $max_resolution[1],
'#size' => 5,
'#maxlength' => 5,
'#field_suffix' => ' ' . t('pixels'),
);
$min_resolution = explode('x', $settings['min_resolution']) + array('', '');
$form['min_resolution'] = array(
'#type' => 'item',
'#title' => t('Minimum image resolution'),
'#element_validate' => array('_image_field_resolution_validate'),
'#weight' => 4.2,
'#field_prefix' => '
',
'#field_suffix' => '
',
'#description' => t('The minimum allowed image size expressed as WIDTHxHEIGHT (e.g. 640x480). Leave blank for no restriction. If a smaller image is uploaded, it will be rejected.'),
);
$form['min_resolution']['x'] = array(
'#type' => 'textfield',
'#title' => t('Minimum width'),
'#title_display' => 'invisible',
'#default_value' => $min_resolution[0],
'#size' => 5,
'#maxlength' => 5,
'#field_suffix' => ' x ',
);
$form['min_resolution']['y'] = array(
'#type' => 'textfield',
'#title' => t('Minimum height'),
'#title_display' => 'invisible',
'#default_value' => $min_resolution[1],
'#size' => 5,
'#maxlength' => 5,
'#field_suffix' => ' ' . t('pixels'),
);
// Remove the description option.
unset($form['description_field']);
// Add title and alt configuration options.
$form['alt_field'] = array(
'#type' => 'checkbox',
'#title' => t('Enable
Alt field'),
'#default_value' => $settings['alt_field'],
'#description' => t('The alt attribute may be used by search engines, screen readers, and when the image cannot be loaded.'),
'#weight' => 10,
);
$form['title_field'] = array(
'#type' => 'checkbox',
'#title' => t('Enable
Title field'),
'#default_value' => $settings['title_field'],
'#description' => t('The title attribute is used as a tooltip when the mouse hovers over the image.'),
'#weight' => 11,
);
// Add the default image to the instance.
$form['default_image'] = array(
'#title' => t('Default image'),
'#type' => 'managed_file',
'#description' => t("If no image is uploaded, this image will be shown on display and will override the field's default image."),
'#default_value' => $settings['default_image'],
'#upload_location' => $field['settings']['uri_scheme'] . '://default_images/',
);
return $form;
}
/**
* Element validate function for resolution fields.
*/
function _image_field_resolution_validate($element, &$form_state) {
if (!empty($element['x']['#value']) || !empty($element['y']['#value'])) {
foreach (array('x', 'y') as $dimension) {
$value = $element[$dimension]['#value'];
if (!is_numeric($value)) {
form_error($element[$dimension], t('Height and width values must be numeric.'));
return;
}
if (intval($value) < 0) {
form_error($element[$dimension], t('Height and width values must be positive numbers.'));
return;
}
if (intval($value) == 0) {
form_error($element[$dimension], t('Both a height and width value must be specified in the !name field.', array('!name' => $element['#title'])));
return;
}
}
form_set_value($element, intval($element['x']['#value']) . 'x' . intval($element['y']['#value']), $form_state);
}
else {
form_set_value($element, '', $form_state);
}
}
/**
* Implements hook_field_load().
*/
function image_field_load($entity_type, $entities, $field, $instances, $langcode, &$items, $age) {
file_field_load($entity_type, $entities, $field, $instances, $langcode, $items, $age);
}
/**
* Implements hook_field_prepare_view().
*/
function image_field_prepare_view($entity_type, $entities, $field, $instances, $langcode, &$items) {
// If there are no files specified at all, use the default.
foreach ($entities as $id => $entity) {
if (empty($items[$id])) {
$fid = 0;
// Use the default for the instance if one is available.
if (!empty($instances[$id]['settings']['default_image'])) {
$fid = $instances[$id]['settings']['default_image'];
}
// Otherwise, use the default for the field.
elseif (!empty($field['settings']['default_image'])) {
$fid = $field['settings']['default_image'];
}
// Add the default image if one is found.
if ($fid && ($file = file_load($fid))) {
$items[$id][0] = (array) $file + array(
'is_default' => TRUE,
'alt' => '',
'title' => '',
);
}
}
}
}
/**
* Implements hook_field_presave().
*/
function image_field_presave($entity_type, $entity, $field, $instance, $langcode, &$items) {
file_field_presave($entity_type, $entity, $field, $instance, $langcode, $items);
// Determine the dimensions if necessary.
foreach ($items as &$item) {
if (!isset($item['width']) || !isset($item['height'])) {
$info = image_get_info(file_load($item['fid'])->uri);
if (is_array($info)) {
$item['width'] = $info['width'];
$item['height'] = $info['height'];
}
}
}
}
/**
* Implements hook_field_insert().
*/
function image_field_insert($entity_type, $entity, $field, $instance, $langcode, &$items) {
file_field_insert($entity_type, $entity, $field, $instance, $langcode, $items);
}
/**
* Implements hook_field_update().
*/
function image_field_update($entity_type, $entity, $field, $instance, $langcode, &$items) {
file_field_update($entity_type, $entity, $field, $instance, $langcode, $items);
}
/**
* Implements hook_field_delete().
*/
function image_field_delete($entity_type, $entity, $field, $instance, $langcode, &$items) {
file_field_delete($entity_type, $entity, $field, $instance, $langcode, $items);
}
/**
* Implements hook_field_delete_revision().
*/
function image_field_delete_revision($entity_type, $entity, $field, $instance, $langcode, &$items) {
file_field_delete_revision($entity_type, $entity, $field, $instance, $langcode, $items);
}
/**
* Implements hook_field_is_empty().
*/
function image_field_is_empty($item, $field) {
return file_field_is_empty($item, $field);
}
/**
* Implements hook_field_widget_info().
*/
function image_field_widget_info() {
return array(
'image_image' => array(
'label' => t('Image'),
'field types' => array('image'),
'settings' => array(
'progress_indicator' => 'throbber',
'preview_image_style' => 'thumbnail',
),
'behaviors' => array(
'multiple values' => FIELD_BEHAVIOR_CUSTOM,
'default value' => FIELD_BEHAVIOR_NONE,
),
),
);
}
/**
* Implements hook_field_widget_settings_form().
*/
function image_field_widget_settings_form($field, $instance) {
$widget = $instance['widget'];
$settings = $widget['settings'];
// Use the file widget settings form.
$form = file_field_widget_settings_form($field, $instance);
$form['preview_image_style'] = array(
'#title' => t('Preview image style'),
'#type' => 'select',
'#options' => image_style_options(FALSE, PASS_THROUGH),
'#empty_option' => '<' . t('no preview') . '>',
'#default_value' => $settings['preview_image_style'],
'#description' => t('The preview image will be shown while editing the content.'),
'#weight' => 15,
);
return $form;
}
/**
* Implements hook_field_widget_form().
*/
function image_field_widget_form(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) {
// Add display_field setting to field because file_field_widget_form() assumes it is set.
$field['settings']['display_field'] = 0;
$elements = file_field_widget_form($form, $form_state, $field, $instance, $langcode, $items, $delta, $element);
$settings = $instance['settings'];
foreach (element_children($elements) as $delta) {
// Add upload resolution validation.
if ($settings['max_resolution'] || $settings['min_resolution']) {
$elements[$delta]['#upload_validators']['file_validate_image_resolution'] = array($settings['max_resolution'], $settings['min_resolution']);
}
// If not using custom extension validation, ensure this is an image.
$supported_extensions = array('png', 'gif', 'jpg', 'jpeg');
$extensions = isset($elements[$delta]['#upload_validators']['file_validate_extensions'][0]) ? $elements[$delta]['#upload_validators']['file_validate_extensions'][0] : implode(' ', $supported_extensions);
$extensions = array_intersect(explode(' ', $extensions), $supported_extensions);
$elements[$delta]['#upload_validators']['file_validate_extensions'][0] = implode(' ', $extensions);
// Add all extra functionality provided by the image widget.
$elements[$delta]['#process'][] = 'image_field_widget_process';
}
if ($field['cardinality'] == 1) {
// If there's only one field, return it as delta 0.
if (empty($elements[0]['#default_value']['fid'])) {
$elements[0]['#description'] = theme('file_upload_help', array('description' => field_filter_xss($instance['description']), 'upload_validators' => $elements[0]['#upload_validators']));
}
}
else {
$elements['#file_upload_description'] = theme('file_upload_help', array('upload_validators' => $elements[0]['#upload_validators']));
}
return $elements;
}
/**
* An element #process callback for the image_image field type.
*
* Expands the image_image type to include the alt and title fields.
*/
function image_field_widget_process($element, &$form_state, $form) {
$item = $element['#value'];
$item['fid'] = $element['fid']['#value'];
$instance = field_widget_instance($element, $form_state);
$settings = $instance['settings'];
$widget_settings = $instance['widget']['settings'];
$element['#theme'] = 'image_widget';
$element['#attached']['css'][] = drupal_get_path('module', 'image') . '/image.css';
// Add the image preview.
if ($element['#file'] && $widget_settings['preview_image_style']) {
$variables = array(
'style_name' => $widget_settings['preview_image_style'],
'path' => $element['#file']->uri,
);
// Determine image dimensions.
if (isset($element['#value']['width']) && isset($element['#value']['height'])) {
$variables['width'] = $element['#value']['width'];
$variables['height'] = $element['#value']['height'];
}
else {
$info = image_get_info($element['#file']->uri);
if (is_array($info)) {
$variables['width'] = $info['width'];
$variables['height'] = $info['height'];
}
else {
$variables['width'] = $variables['height'] = NULL;
}
}
$element['preview'] = array(
'#type' => 'markup',
'#markup' => theme('image_style', $variables),
);
// Store the dimensions in the form so the file doesn't have to be accessed
// again. This is important for remote files.
$element['width'] = array(
'#type' => 'hidden',
'#value' => $variables['width'],
);
$element['height'] = array(
'#type' => 'hidden',
'#value' => $variables['height'],
);
}
// Add the additional alt and title fields.
$element['alt'] = array(
'#title' => t('Alternate text'),
'#type' => 'textfield',
'#default_value' => isset($item['alt']) ? $item['alt'] : '',
'#description' => t('This text will be used by screen readers, search engines, or when the image cannot be loaded.'),
// @see http://www.gawds.org/show.php?contentid=28
'#maxlength' => 512,
'#weight' => -2,
'#access' => (bool) $item['fid'] && $settings['alt_field'],
);
$element['title'] = array(
'#type' => 'textfield',
'#title' => t('Title'),
'#default_value' => isset($item['title']) ? $item['title'] : '',
'#description' => t('The title is used as a tool tip when the user hovers the mouse over the image.'),
'#maxlength' => 1024,
'#weight' => -1,
'#access' => (bool) $item['fid'] && $settings['title_field'],
);
return $element;
}
/**
* Returns HTML for an image field widget.
*
* @param $variables
* An associative array containing:
* - element: A render element representing the image field widget.
*
* @ingroup themeable
*/
function theme_image_widget($variables) {
$element = $variables['element'];
$output = '';
$output .= '
';
return $output;
}
/**
* Implements hook_field_formatter_info().
*/
function image_field_formatter_info() {
$formatters = array(
'image' => array(
'label' => t('Image'),
'field types' => array('image'),
'settings' => array('image_style' => '', 'image_link' => ''),
),
);
return $formatters;
}
/**
* Implements hook_field_formatter_settings_form().
*/
function image_field_formatter_settings_form($field, $instance, $view_mode, $form, &$form_state) {
$display = $instance['display'][$view_mode];
$settings = $display['settings'];
$image_styles = image_style_options(FALSE, PASS_THROUGH);
$element['image_style'] = array(
'#title' => t('Image style'),
'#type' => 'select',
'#default_value' => $settings['image_style'],
'#empty_option' => t('None (original image)'),
'#options' => $image_styles,
);
$link_types = array(
'content' => t('Content'),
'file' => t('File'),
);
$element['image_link'] = array(
'#title' => t('Link image to'),
'#type' => 'select',
'#default_value' => $settings['image_link'],
'#empty_option' => t('Nothing'),
'#options' => $link_types,
);
return $element;
}
/**
* Implements hook_field_formatter_settings_summary().
*/
function image_field_formatter_settings_summary($field, $instance, $view_mode) {
$display = $instance['display'][$view_mode];
$settings = $display['settings'];
$summary = array();
$image_styles = image_style_options(FALSE, PASS_THROUGH);
// Unset possible 'No defined styles' option.
unset($image_styles['']);
// Styles could be lost because of enabled/disabled modules that defines
// their styles in code.
if (isset($image_styles[$settings['image_style']])) {
$summary[] = t('Image style: @style', array('@style' => $image_styles[$settings['image_style']]));
}
else {
$summary[] = t('Original image');
}
$link_types = array(
'content' => t('Linked to content'),
'file' => t('Linked to file'),
);
// Display this setting only if image is linked.
if (isset($link_types[$settings['image_link']])) {
$summary[] = $link_types[$settings['image_link']];
}
return implode('
', $summary);
}
/**
* Implements hook_field_formatter_view().
*/
function image_field_formatter_view($entity_type, $entity, $field, $instance, $langcode, $items, $display) {
$element = array();
// Check if the formatter involves a link.
if ($display['settings']['image_link'] == 'content') {
$uri = entity_uri($entity_type, $entity);
}
elseif ($display['settings']['image_link'] == 'file') {
$link_file = TRUE;
}
foreach ($items as $delta => $item) {
if (isset($link_file)) {
$uri = array(
'path' => file_create_url($item['uri']),
'options' => array(),
);
}
$element[$delta] = array(
'#theme' => 'image_formatter',
'#item' => $item,
'#image_style' => $display['settings']['image_style'],
'#path' => isset($uri) ? $uri : '',
);
}
return $element;
}
/**
* Returns HTML for an image field formatter.
*
* @param $variables
* An associative array containing:
* - item: Associative array of image data, which may include "uri", "alt",
* "width", "height", "title" and "attributes".
* - image_style: An optional image style.
* - path: An array containing the link 'path' and link 'options'.
*
* @ingroup themeable
*/
function theme_image_formatter($variables) {
$item = $variables['item'];
$image = array(
'path' => $item['uri'],
);
if (array_key_exists('alt', $item)) {
$image['alt'] = $item['alt'];
}
if (isset($item['attributes'])) {
$image['attributes'] = $item['attributes'];
}
if (isset($item['width']) && isset($item['height'])) {
$image['width'] = $item['width'];
$image['height'] = $item['height'];
}
// Do not output an empty 'title' attribute.
if (isset($item['title']) && drupal_strlen($item['title']) > 0) {
$image['title'] = $item['title'];
}
if ($variables['image_style']) {
$image['style_name'] = $variables['image_style'];
$output = theme('image_style', $image);
}
else {
$output = theme('image', $image);
}
// The link path and link options are both optional, but for the options to be
// processed, the link path must at least be an empty string.
if (isset($variables['path']['path'])) {
$path = $variables['path']['path'];
$options = isset($variables['path']['options']) ? $variables['path']['options'] : array();
// When displaying an image inside a link, the html option must be TRUE.
$options['html'] = TRUE;
$output = l($output, $path, $options);
}
return $output;
}
name = Image
description = Provides image manipulation tools.
package = Core
version = VERSION
core = 7.x
dependencies[] = file
files[] = image.test
configure = admin/config/media/image-styles
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
'Stores configuration options for image styles.',
'fields' => array(
'isid' => array(
'description' => 'The primary identifier for an image style.',
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
),
'name' => array(
'description' => 'The style machine name.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
),
'label' => array(
'description' => 'The style administrative name.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
),
'primary key' => array('isid'),
'unique keys' => array(
'name' => array('name'),
),
);
$schema['image_effects'] = array(
'description' => 'Stores configuration options for image effects.',
'fields' => array(
'ieid' => array(
'description' => 'The primary identifier for an image effect.',
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
),
'isid' => array(
'description' => 'The {image_styles}.isid for an image style.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
),
'weight' => array(
'description' => 'The weight of the effect in the style.',
'type' => 'int',
'unsigned' => FALSE,
'not null' => TRUE,
'default' => 0,
),
'name' => array(
'description' => 'The unique name of the effect to be executed.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
),
'data' => array(
'description' => 'The configuration data for the effect.',
'type' => 'blob',
'not null' => TRUE,
'size' => 'big',
'serialize' => TRUE,
),
),
'primary key' => array('ieid'),
'indexes' => array(
'isid' => array('isid'),
'weight' => array('weight'),
),
'foreign keys' => array(
'image_style' => array(
'table' => 'image_styles',
'columns' => array('isid' => 'isid'),
),
),
);
return $schema;
}
/**
* Implements hook_field_schema().
*/
function image_field_schema($field) {
return array(
'columns' => array(
'fid' => array(
'description' => 'The {file_managed}.fid being referenced in this field.',
'type' => 'int',
'not null' => FALSE,
'unsigned' => TRUE,
),
'alt' => array(
'description' => "Alternative image text, for the image's 'alt' attribute.",
'type' => 'varchar',
'length' => 512,
'not null' => FALSE,
),
'title' => array(
'description' => "Image title text, for the image's 'title' attribute.",
'type' => 'varchar',
'length' => 1024,
'not null' => FALSE,
),
'width' => array(
'description' => 'The width of the image in pixels.',
'type' => 'int',
'unsigned' => TRUE,
),
'height' => array(
'description' => 'The height of the image in pixels.',
'type' => 'int',
'unsigned' => TRUE,
),
),
'indexes' => array(
'fid' => array('fid'),
),
'foreign keys' => array(
'fid' => array(
'table' => 'file_managed',
'columns' => array('fid' => 'fid'),
),
),
);
}
/**
* Implements hook_update_dependencies().
*/
function image_update_dependencies() {
$dependencies['image'][7002] = array(
// Image update 7002 uses field API functions, so must run after
// Field API has been enabled.
'system' => 7020,
);
return $dependencies;
}
/**
* Install the schema for users upgrading from the contributed module.
*/
function image_update_7000() {
if (!db_table_exists('image_styles')) {
$schema = array();
$schema['cache_image'] = system_schema_cache_7054();
$schema['cache_image']['description'] = 'Cache table used to store information about image manipulations that are in-progress.';
$schema['image_styles'] = array(
'description' => 'Stores configuration options for image styles.',
'fields' => array(
'isid' => array(
'description' => 'The primary identifier for an image style.',
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
),
'name' => array(
'description' => 'The style name.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
),
),
'primary key' => array('isid'),
'unique keys' => array(
'name' => array('name'),
),
);
$schema['image_effects'] = array(
'description' => 'Stores configuration options for image effects.',
'fields' => array(
'ieid' => array(
'description' => 'The primary identifier for an image effect.',
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
),
'isid' => array(
'description' => 'The {image_styles}.isid for an image style.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
),
'weight' => array(
'description' => 'The weight of the effect in the style.',
'type' => 'int',
'unsigned' => FALSE,
'not null' => TRUE,
'default' => 0,
),
'name' => array(
'description' => 'The unique name of the effect to be executed.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
),
'data' => array(
'description' => 'The configuration data for the effect.',
'type' => 'blob',
'not null' => TRUE,
'size' => 'big',
'serialize' => TRUE,
),
),
'primary key' => array('ieid'),
'indexes' => array(
'isid' => array('isid'),
'weight' => array('weight'),
),
'foreign keys' => array(
'image_style' => array(
'table' => 'image_styles',
'columns' => array('isid' => 'isid'),
),
),
);
db_create_table('cache_image', $schema['cache_image']);
db_create_table('image_styles', $schema['image_styles']);
db_create_table('image_effects', $schema['image_effects']);
}
}
/**
* @addtogroup updates-7.x-extra
* @{
*/
/**
* Rename possibly misnamed {image_effect} table to {image_effects}.
*/
function image_update_7001() {
// Due to a bug in earlier versions of image_update_7000() it is possible
// to end up with an {image_effect} table where there should be an
// {image_effects} table.
if (!db_table_exists('image_effects') && db_table_exists('image_effect')) {
db_rename_table('image_effect', 'image_effects');
}
}
/**
* Add width and height columns to a specific table.
*
* @param $table
* The name of the database table to be updated.
* @param $columns
* Keyed array of columns this table is supposed to have.
*/
function _image_update_7002_add_columns($table, $field_name) {
$spec = array(
'type' => 'int',
'unsigned' => TRUE,
);
$spec['description'] = 'The width of the image in pixels.';
db_add_field($table, $field_name . '_width', $spec);
$spec['description'] = 'The height of the image in pixels.';
db_add_field($table, $field_name . '_height', $spec);
}
/**
* Populate image dimensions in a specific table.
*
* @param $table
* The name of the database table to be updated.
* @param $columns
* Keyed array of columns this table is supposed to have.
* @param $last_fid
* The fid of the last image to have been processed.
*
* @return
* The number of images that were processed.
*/
function _image_update_7002_populate_dimensions($table, $field_name, &$last_fid) {
// Define how many images to process per pass.
$images_per_pass = 100;
// Query the database for fid / URI pairs.
$query = db_select($table, NULL, array('fetch' => PDO::FETCH_ASSOC));
$query->join('file_managed', NULL, $table . '.' . $field_name . '_fid = file_managed.fid');
if ($last_fid) {
$query->condition('file_managed.fid', $last_fid, '>');
}
$result = $query->fields('file_managed', array('fid', 'uri'))
->orderBy('file_managed.fid')
->range(0, $images_per_pass)
->execute();
$count = 0;
foreach ($result as $file) {
$count++;
$info = image_get_info($file['uri']);
if (is_array($info)) {
db_update($table)
->fields(array(
$field_name . '_width' => $info['width'],
$field_name . '_height' => $info['height'],
))
->condition($field_name . '_fid', $file['fid'])
->execute();
}
}
// If less than the requested number of rows were returned then this table
// has been fully processed.
$last_fid = ($count < $images_per_pass) ? NULL : $file['fid'];
return $count;
}
/**
* Add width and height columns to image field schema and populate.
*/
function image_update_7002(array &$sandbox) {
if (empty($sandbox)) {
// Setup the sandbox.
$sandbox = array(
'tables' => array(),
'total' => 0,
'processed' => 0,
'last_fid' => NULL,
);
$fields = _update_7000_field_read_fields(array(
'module' => 'image',
'storage_type' => 'field_sql_storage',
'deleted' => 0,
));
foreach ($fields as $field) {
$tables = array(
_field_sql_storage_tablename($field),
_field_sql_storage_revision_tablename($field),
);
foreach ($tables as $table) {
// Add the width and height columns to the table.
_image_update_7002_add_columns($table, $field['field_name']);
// How many rows need dimensions populated?
$count = db_select($table)->countQuery()->execute()->fetchField();
if (!$count) {
continue;
}
$sandbox['total'] += $count;
$sandbox['tables'][$table] = $field['field_name'];
}
}
// If no tables need rows populated with dimensions then we are done.
if (empty($sandbox['tables'])) {
$sandbox = array();
return;
}
}
// Process the table at the top of the list.
$keys = array_keys($sandbox['tables']);
$table = reset($keys);
$sandbox['processed'] += _image_update_7002_populate_dimensions($table, $sandbox['tables'][$table], $sandbox['last_fid']);
// Has the table been fully processed?
if (!$sandbox['last_fid']) {
unset($sandbox['tables'][$table]);
}
$sandbox['#finished'] = count($sandbox['tables']) ? ($sandbox['processed'] / $sandbox['total']) : 1;
}
/**
* Remove the variables that set alt and title length since they were not
* used for database column size and could cause PDO exceptions.
*/
function image_update_7003() {
variable_del('image_alt_length');
variable_del('image_title_length');
}
/**
* Use a large setting (512 and 1024 characters) for the length of the image alt
* and title fields.
*/
function image_update_7004() {
$alt_spec = array(
'type' => 'varchar',
'length' => 512,
'not null' => FALSE,
);
$title_spec = array(
'type' => 'varchar',
'length' => 1024,
'not null' => FALSE,
);
$fields = _update_7000_field_read_fields(array(
'module' => 'image',
'storage_type' => 'field_sql_storage',
));
foreach ($fields as $field_name => $field) {
$tables = array(
_field_sql_storage_tablename($field),
_field_sql_storage_revision_tablename($field),
);
$alt_column = $field['field_name'] . '_alt';
$title_column = $field['field_name'] . '_title';
foreach ($tables as $table) {
db_change_field($table, $alt_column, $alt_column, $alt_spec);
db_change_field($table, $title_column, $title_column, $title_spec);
}
}
}
/**
* Add a column to the 'image_style' table to store administrative labels.
*/
function image_update_7005() {
$field = array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
'description' => 'The style administrative name.',
);
db_add_field('image_styles', 'label', $field);
// Do a direct query here, rather than calling image_styles(),
// in case Image module is disabled.
$styles = db_query('SELECT name FROM {image_styles}')->fetchCol();
foreach ($styles as $style) {
db_update('image_styles')
->fields(array('label' => $style))
->condition('name', $style)
->execute();
}
}
/**
* @} End of "addtogroup updates-7.x-extra".
*/
/**
* Implements hook_requirements() to check the PHP GD Library.
*
* @param $phase
*/
function image_requirements($phase) {
$requirements = array();
if ($phase == 'runtime') {
// Check for the PHP GD library.
if (function_exists('imagegd2')) {
$info = gd_info();
$requirements['image_gd'] = array(
'value' => $info['GD Version'],
);
// Check for filter and rotate support.
if (function_exists('imagefilter') && function_exists('imagerotate')) {
$requirements['image_gd']['severity'] = REQUIREMENT_OK;
}
else {
$requirements['image_gd']['severity'] = REQUIREMENT_WARNING;
$requirements['image_gd']['description'] = t('The GD Library for PHP is enabled, but was compiled without support for functions used by the rotate and desaturate effects. It was probably compiled using the official GD libraries from http://www.libgd.org instead of the GD library bundled with PHP. You should recompile PHP --with-gd using the bundled GD library. See
the PHP manual .');
}
}
else {
$requirements['image_gd'] = array(
'value' => t('Not installed'),
'severity' => REQUIREMENT_ERROR,
'description' => t('The GD library for PHP is missing or outdated. Check the
PHP image documentation for information on how to correct this.', array('@url' => 'http://www.php.net/manual/book.image.php')),
);
}
$requirements['image_gd']['title'] = t('GD library rotate and desaturate effects');
}
return $requirements;
}
' . t('About') . '';
$output .= '
' . t('The Image module allows you to manipulate images on your website. It exposes a setting for using the Image toolkit , allows you to configure Image styles that can be used for resizing or adjusting images on display, and provides an Image field for attaching images to content. For more information, see the online handbook entry for Image module .', array('@image' => 'http://drupal.org/documentation/modules/image')) . '
';
$output .= '
' . t('Uses') . ' ';
$output .= '
';
$output .= '' . t('Manipulating images') . ' ';
$output .= '' . t('With the Image module you can scale, crop, resize, rotate and desaturate images without affecting the original image using image styles . When you change an image style, the module automatically refreshes all created images. Every image style must have a name, which will be used in the URL of the generated images. There are two common approaches to naming image styles (which you use will depend on how the image style is being applied):',array('@image' => url('admin/config/media/image-styles')));
$output .= '' . t('Based on where it will be used: eg. profile-picture ') . ' ';
$output .= '' . t('Describing its appearance: eg. square-85x85 ') . ' ';
$output .= ' ' . t('Attaching images to content as fields') . ' ';
$output .= '' . t("Image module also allows you to attach images to content as fields. To add an image field to a content type , go to the content type's manage fields page, and add a new field of type Image . Attaching images to content this way allows image styles to be applied and maintained, and also allows you more flexibility when theming.", array('@content-type' => url('admin/structure/types'))) . ' ';
$output .= ' ';
return $output;
case 'admin/config/media/image-styles':
return '
' . t('Image styles commonly provide thumbnail sizes by scaling and cropping images, but can also add various effects before an image is displayed. When an image is displayed with a style, a new file is created and the original image is left unchanged.') . '
';
case 'admin/config/media/image-styles/edit/%/add/%':
$effect = image_effect_definition_load($arg[7]);
return isset($effect['help']) ? ('
' . $effect['help'] . '
') : NULL;
case 'admin/config/media/image-styles/edit/%/effects/%':
$effect = ($arg[5] == 'add') ? image_effect_definition_load($arg[6]) : image_effect_load($arg[7], $arg[5]);
return isset($effect['help']) ? ('
' . $effect['help'] . '
') : NULL;
}
}
/**
* Implements hook_menu().
*/
function image_menu() {
$items = array();
// Generate image derivatives of publicly available files.
// If clean URLs are disabled, image derivatives will always be served
// through the menu system.
// If clean URLs are enabled and the image derivative already exists,
// PHP will be bypassed.
$directory_path = file_stream_wrapper_get_instance_by_scheme('public')->getDirectoryPath();
$items[$directory_path . '/styles/%image_style'] = array(
'title' => 'Generate image style',
'page callback' => 'image_style_deliver',
'page arguments' => array(count(explode('/', $directory_path)) + 1),
'access callback' => TRUE,
'type' => MENU_CALLBACK,
);
// Generate and deliver image derivatives of private files.
// These image derivatives are always delivered through the menu system.
$items['system/files/styles/%image_style'] = array(
'title' => 'Generate image style',
'page callback' => 'image_style_deliver',
'page arguments' => array(3),
'access callback' => TRUE,
'type' => MENU_CALLBACK,
);
$items['admin/config/media/image-styles'] = array(
'title' => 'Image styles',
'description' => 'Configure styles that can be used for resizing or adjusting images on display.',
'page callback' => 'image_style_list',
'access arguments' => array('administer image styles'),
'file' => 'image.admin.inc',
);
$items['admin/config/media/image-styles/list'] = array(
'title' => 'List',
'description' => 'List the current image styles on the site.',
'page callback' => 'image_style_list',
'access arguments' => array('administer image styles'),
'type' => MENU_DEFAULT_LOCAL_TASK,
'weight' => 1,
'file' => 'image.admin.inc',
);
$items['admin/config/media/image-styles/add'] = array(
'title' => 'Add style',
'description' => 'Add a new image style.',
'page callback' => 'drupal_get_form',
'page arguments' => array('image_style_add_form'),
'access arguments' => array('administer image styles'),
'type' => MENU_LOCAL_ACTION,
'weight' => 2,
'file' => 'image.admin.inc',
);
$items['admin/config/media/image-styles/edit/%image_style'] = array(
'title' => 'Edit style',
'description' => 'Configure an image style.',
'page callback' => 'drupal_get_form',
'page arguments' => array('image_style_form', 5),
'access arguments' => array('administer image styles'),
'file' => 'image.admin.inc',
);
$items['admin/config/media/image-styles/delete/%image_style'] = array(
'title' => 'Delete style',
'description' => 'Delete an image style.',
'load arguments' => array(NULL, (string) IMAGE_STORAGE_NORMAL),
'page callback' => 'drupal_get_form',
'page arguments' => array('image_style_delete_form', 5),
'access arguments' => array('administer image styles'),
'file' => 'image.admin.inc',
);
$items['admin/config/media/image-styles/revert/%image_style'] = array(
'title' => 'Revert style',
'description' => 'Revert an image style.',
'load arguments' => array(NULL, (string) IMAGE_STORAGE_OVERRIDE),
'page callback' => 'drupal_get_form',
'page arguments' => array('image_style_revert_form', 5),
'access arguments' => array('administer image styles'),
'file' => 'image.admin.inc',
);
$items['admin/config/media/image-styles/edit/%image_style/effects/%image_effect'] = array(
'title' => 'Edit image effect',
'description' => 'Edit an existing effect within a style.',
'load arguments' => array(5, (string) IMAGE_STORAGE_EDITABLE),
'page callback' => 'drupal_get_form',
'page arguments' => array('image_effect_form', 5, 7),
'access arguments' => array('administer image styles'),
'file' => 'image.admin.inc',
);
$items['admin/config/media/image-styles/edit/%image_style/effects/%image_effect/delete'] = array(
'title' => 'Delete image effect',
'description' => 'Delete an existing effect from a style.',
'load arguments' => array(5, (string) IMAGE_STORAGE_EDITABLE),
'page callback' => 'drupal_get_form',
'page arguments' => array('image_effect_delete_form', 5, 7),
'access arguments' => array('administer image styles'),
'file' => 'image.admin.inc',
);
$items['admin/config/media/image-styles/edit/%image_style/add/%image_effect_definition'] = array(
'title' => 'Add image effect',
'description' => 'Add a new effect to a style.',
'load arguments' => array(5),
'page callback' => 'drupal_get_form',
'page arguments' => array('image_effect_form', 5, 7),
'access arguments' => array('administer image styles'),
'file' => 'image.admin.inc',
);
return $items;
}
/**
* Implements hook_theme().
*/
function image_theme() {
return array(
// Theme functions in image.module.
'image_style' => array(
'variables' => array(
'style_name' => NULL,
'path' => NULL,
'width' => NULL,
'height' => NULL,
'alt' => '',
'title' => NULL,
'attributes' => array(),
),
),
// Theme functions in image.admin.inc.
'image_style_list' => array(
'variables' => array('styles' => NULL),
),
'image_style_effects' => array(
'render element' => 'form',
),
'image_style_preview' => array(
'variables' => array('style' => NULL),
),
'image_anchor' => array(
'render element' => 'element',
),
'image_resize_summary' => array(
'variables' => array('data' => NULL),
),
'image_scale_summary' => array(
'variables' => array('data' => NULL),
),
'image_crop_summary' => array(
'variables' => array('data' => NULL),
),
'image_rotate_summary' => array(
'variables' => array('data' => NULL),
),
// Theme functions in image.field.inc.
'image_widget' => array(
'render element' => 'element',
),
'image_formatter' => array(
'variables' => array('item' => NULL, 'path' => NULL, 'image_style' => NULL),
),
);
}
/**
* Implements hook_permission().
*/
function image_permission() {
return array(
'administer image styles' => array(
'title' => t('Administer image styles'),
'description' => t('Create and modify styles for generating image modifications such as thumbnails.'),
),
);
}
/**
* Implements hook_form_FORM_ID_alter().
*/
function image_form_system_file_system_settings_alter(&$form, &$form_state) {
$form['#submit'][] = 'image_system_file_system_settings_submit';
}
/**
* Form submission handler for system_file_system_settings().
*
* Adds a menu rebuild after the public file path has been changed, so that the
* menu router item depending on that file path will be regenerated.
*/
function image_system_file_system_settings_submit($form, &$form_state) {
if ($form['file_public_path']['#default_value'] !== $form_state['values']['file_public_path']) {
variable_set('menu_rebuild_needed', TRUE);
}
}
/**
* Implements hook_flush_caches().
*/
function image_flush_caches() {
return array('cache_image');
}
/**
* Implements hook_file_download().
*
* Control the access to files underneath the styles directory.
*/
function image_file_download($uri) {
$path = file_uri_target($uri);
// Private file access for image style derivatives.
if (strpos($path, 'styles/') === 0) {
$args = explode('/', $path);
// Discard the first part of the path (styles).
array_shift($args);
// Get the style name from the second part.
$style_name = array_shift($args);
// Remove the scheme from the path.
array_shift($args);
// Then the remaining parts are the path to the image.
$original_uri = file_uri_scheme($uri) . '://' . implode('/', $args);
// Check that the file exists and is an image.
if ($info = image_get_info($uri)) {
// Check the permissions of the original to grant access to this image.
$headers = module_invoke_all('file_download', $original_uri);
// Confirm there's at least one module granting access and none denying access.
if (!empty($headers) && !in_array(-1, $headers)) {
return array(
// Send headers describing the image's size, and MIME-type...
'Content-Type' => $info['mime_type'],
'Content-Length' => $info['file_size'],
// By not explicitly setting them here, this uses normal Drupal
// Expires, Cache-Control and ETag headers to prevent proxy or
// browser caching of private images.
);
}
}
return -1;
}
// Private file access for the original files. Note that we only check access
// for non-temporary images, since file.module will grant access for all
// temporary files.
$files = file_load_multiple(array(), array('uri' => $uri));
if (count($files)) {
$file = reset($files);
if ($file->status) {
return file_file_download($uri, 'image');
}
}
}
/**
* Implements hook_file_move().
*/
function image_file_move($file, $source) {
// Delete any image derivatives at the original image path.
image_path_flush($source->uri);
}
/**
* Implements hook_file_delete().
*/
function image_file_delete($file) {
// Delete any image derivatives of this image.
image_path_flush($file->uri);
}
/**
* Implements hook_image_default_styles().
*/
function image_image_default_styles() {
$styles = array();
$styles['thumbnail'] = array(
'label' => 'Thumbnail (100x100)',
'effects' => array(
array(
'name' => 'image_scale',
'data' => array('width' => 100, 'height' => 100, 'upscale' => 1),
'weight' => 0,
),
)
);
$styles['medium'] = array(
'label' => 'Medium (220x220)',
'effects' => array(
array(
'name' => 'image_scale',
'data' => array('width' => 220, 'height' => 220, 'upscale' => 1),
'weight' => 0,
),
)
);
$styles['large'] = array(
'label' => 'Large (480x480)',
'effects' => array(
array(
'name' => 'image_scale',
'data' => array('width' => 480, 'height' => 480, 'upscale' => 0),
'weight' => 0,
),
)
);
return $styles;
}
/**
* Implements hook_image_style_save().
*/
function image_image_style_save($style) {
if (isset($style['old_name']) && $style['old_name'] != $style['name']) {
$instances = field_read_instances();
// Loop through all fields searching for image fields.
foreach ($instances as $instance) {
if ($instance['widget']['module'] == 'image') {
$instance_changed = FALSE;
foreach ($instance['display'] as $view_mode => $display) {
// Check if the formatter involves an image style.
if ($display['type'] == 'image' && $display['settings']['image_style'] == $style['old_name']) {
// Update display information for any instance using the image
// style that was just deleted.
$instance['display'][$view_mode]['settings']['image_style'] = $style['name'];
$instance_changed = TRUE;
}
}
if ($instance['widget']['settings']['preview_image_style'] == $style['old_name']) {
$instance['widget']['settings']['preview_image_style'] = $style['name'];
$instance_changed = TRUE;
}
if ($instance_changed) {
field_update_instance($instance);
}
}
}
}
}
/**
* Implements hook_image_style_delete().
*/
function image_image_style_delete($style) {
image_image_style_save($style);
}
/**
* Implements hook_field_delete_field().
*/
function image_field_delete_field($field) {
if ($field['type'] != 'image') {
return;
}
// The value of a managed_file element can be an array if #extended == TRUE.
$fid = (is_array($field['settings']['default_image']) ? $field['settings']['default_image']['fid'] : $field['settings']['default_image']);
if ($fid && ($file = file_load($fid))) {
file_usage_delete($file, 'image', 'default_image', $field['id']);
}
}
/**
* Implements hook_field_update_field().
*/
function image_field_update_field($field, $prior_field, $has_data) {
if ($field['type'] != 'image') {
return;
}
// The value of a managed_file element can be an array if #extended == TRUE.
$fid_new = (is_array($field['settings']['default_image']) ? $field['settings']['default_image']['fid'] : $field['settings']['default_image']);
$fid_old = (is_array($prior_field['settings']['default_image']) ? $prior_field['settings']['default_image']['fid'] : $prior_field['settings']['default_image']);
$file_new = $fid_new ? file_load($fid_new) : FALSE;
if ($fid_new != $fid_old) {
// Is there a new file?
if ($file_new) {
$file_new->status = FILE_STATUS_PERMANENT;
file_save($file_new);
file_usage_add($file_new, 'image', 'default_image', $field['id']);
}
// Is there an old file?
if ($fid_old && ($file_old = file_load($fid_old))) {
file_usage_delete($file_old, 'image', 'default_image', $field['id']);
}
}
// If the upload destination changed, then move the file.
if ($file_new && (file_uri_scheme($file_new->uri) != $field['settings']['uri_scheme'])) {
$directory = $field['settings']['uri_scheme'] . '://default_images/';
file_prepare_directory($directory, FILE_CREATE_DIRECTORY);
file_move($file_new, $directory . $file_new->filename);
}
}
/**
* Implements hook_field_delete_instance().
*/
function image_field_delete_instance($instance) {
// Only act on image fields.
$field = field_read_field($instance['field_name']);
if ($field['type'] != 'image') {
return;
}
// The value of a managed_file element can be an array if the #extended
// property is set to TRUE.
$fid = $instance['settings']['default_image'];
if (is_array($fid)) {
$fid = $fid['fid'];
}
// Remove the default image when the instance is deleted.
if ($fid && ($file = file_load($fid))) {
file_usage_delete($file, 'image', 'default_image', $instance['id']);
}
}
/**
* Implements hook_field_update_instance().
*/
function image_field_update_instance($instance, $prior_instance) {
// Only act on image fields.
$field = field_read_field($instance['field_name']);
if ($field['type'] != 'image') {
return;
}
// The value of a managed_file element can be an array if the #extended
// property is set to TRUE.
$fid_new = $instance['settings']['default_image'];
if (is_array($fid_new)) {
$fid_new = $fid_new['fid'];
}
$fid_old = $prior_instance['settings']['default_image'];
if (is_array($fid_old)) {
$fid_old = $fid_old['fid'];
}
// If the old and new files do not match, update the default accordingly.
$file_new = $fid_new ? file_load($fid_new) : FALSE;
if ($fid_new != $fid_old) {
// Save the new file, if present.
if ($file_new) {
$file_new->status = FILE_STATUS_PERMANENT;
file_save($file_new);
file_usage_add($file_new, 'image', 'default_image', $instance['id']);
}
// Delete the old file, if present.
if ($fid_old && ($file_old = file_load($fid_old))) {
file_usage_delete($file_old, 'image', 'default_image', $instance['id']);
}
}
// If the upload destination changed, then move the file.
if ($file_new && (file_uri_scheme($file_new->uri) != $field['settings']['uri_scheme'])) {
$directory = $field['settings']['uri_scheme'] . '://default_images/';
file_prepare_directory($directory, FILE_CREATE_DIRECTORY);
file_move($file_new, $directory . $file_new->filename);
}
}
/**
* Clears cached versions of a specific file in all styles.
*
* @param $path
* The Drupal file path to the original image.
*/
function image_path_flush($path) {
$styles = image_styles();
foreach ($styles as $style) {
$image_path = image_style_path($style['name'], $path);
if (file_exists($image_path)) {
file_unmanaged_delete($image_path);
}
}
}
/**
* Gets an array of all styles and their settings.
*
* @return
* An array of styles keyed by the image style ID (isid).
* @see image_style_load()
*/
function image_styles() {
$styles = &drupal_static(__FUNCTION__);
// Grab from cache or build the array.
if (!isset($styles)) {
if ($cache = cache_get('image_styles', 'cache')) {
$styles = $cache->data;
}
else {
$styles = array();
// Select the module-defined styles.
foreach (module_implements('image_default_styles') as $module) {
$module_styles = module_invoke($module, 'image_default_styles');
foreach ($module_styles as $style_name => $style) {
$style['name'] = $style_name;
$style['label'] = empty($style['label']) ? $style_name : $style['label'];
$style['module'] = $module;
$style['storage'] = IMAGE_STORAGE_DEFAULT;
foreach ($style['effects'] as $key => $effect) {
$definition = image_effect_definition_load($effect['name']);
if ($definition) {
$effect = array_merge($definition, $effect);
$style['effects'][$key] = $effect;
}
else {
watchdog('image', 'Image style %style_name has an effect %effect_name with no definition.',
array(
'%style_name' => $style_name,
'%effect_name' => $effect['name'],
),
WATCHDOG_ERROR);
}
}
$styles[$style_name] = $style;
}
}
// Select all the user-defined styles.
$user_styles = db_select('image_styles', NULL, array('fetch' => PDO::FETCH_ASSOC))
->fields('image_styles')
->orderBy('name')
->execute()
->fetchAllAssoc('name', PDO::FETCH_ASSOC);
// Allow the user styles to override the module styles.
foreach ($user_styles as $style_name => $style) {
$style['module'] = NULL;
$style['storage'] = IMAGE_STORAGE_NORMAL;
$style['effects'] = image_style_effects($style);
if (isset($styles[$style_name]['module'])) {
$style['module'] = $styles[$style_name]['module'];
$style['storage'] = IMAGE_STORAGE_OVERRIDE;
}
$styles[$style_name] = $style;
}
drupal_alter('image_styles', $styles);
cache_set('image_styles', $styles);
}
}
return $styles;
}
/**
* Loads a style by style name or ID.
*
* May be used as a loader for menu items.
*
* @param $name
* The name of the style.
* @param $isid
* Optional. The numeric id of a style if the name is not known.
* @param $include
* If set, this loader will restrict to a specific type of image style, may be
* one of the defined Image style storage constants.
*
* @return
* An image style array containing the following keys:
* - "isid": The unique image style ID.
* - "name": The unique image style name.
* - "effects": An array of image effects within this image style.
* If the image style name or ID is not valid, an empty array is returned.
* @see image_effect_load()
*/
function image_style_load($name = NULL, $isid = NULL, $include = NULL) {
$styles = image_styles();
// If retrieving by name.
if (isset($name) && isset($styles[$name])) {
$style = $styles[$name];
}
// If retrieving by image style id.
if (!isset($name) && isset($isid)) {
foreach ($styles as $name => $database_style) {
if (isset($database_style['isid']) && $database_style['isid'] == $isid) {
$style = $database_style;
break;
}
}
}
// Restrict to the specific type of flag. This bitwise operation basically
// states "if the storage is X, then allow".
if (isset($style) && (!isset($include) || ($style['storage'] & (int) $include))) {
return $style;
}
// Otherwise the style was not found.
return FALSE;
}
/**
* Saves an image style.
*
* @param array $style
* An image style array containing:
* - name: A unique name for the style.
* - isid: (optional) An image style ID.
*
* @return array
* An image style array containing:
* - name: An unique name for the style.
* - old_name: The original name for the style.
* - isid: An image style ID.
* - is_new: TRUE if this is a new style, and FALSE if it is an existing
* style.
*/
function image_style_save($style) {
if (isset($style['isid']) && is_numeric($style['isid'])) {
// Load the existing style to make sure we account for renamed styles.
$old_style = image_style_load(NULL, $style['isid']);
image_style_flush($old_style);
drupal_write_record('image_styles', $style, 'isid');
if ($old_style['name'] != $style['name']) {
$style['old_name'] = $old_style['name'];
}
}
else {
// Add a default label when not given.
if (empty($style['label'])) {
$style['label'] = $style['name'];
}
drupal_write_record('image_styles', $style);
$style['is_new'] = TRUE;
}
// Let other modules update as necessary on save.
module_invoke_all('image_style_save', $style);
// Clear all caches and flush.
image_style_flush($style);
return $style;
}
/**
* Deletes an image style.
*
* @param $style
* An image style array.
* @param $replacement_style_name
* (optional) When deleting a style, specify a replacement style name so
* that existing settings (if any) may be converted to a new style.
*
* @return
* TRUE on success.
*/
function image_style_delete($style, $replacement_style_name = '') {
image_style_flush($style);
db_delete('image_effects')->condition('isid', $style['isid'])->execute();
db_delete('image_styles')->condition('isid', $style['isid'])->execute();
// Let other modules update as necessary on save.
$style['old_name'] = $style['name'];
$style['name'] = $replacement_style_name;
module_invoke_all('image_style_delete', $style);
return TRUE;
}
/**
* Loads all the effects for an image style.
*
* @param array $style
* An image style array containing:
* - isid: The unique image style ID that contains this image effect.
*
* @return array
* An array of image effects associated with specified image style in the
* format array('isid' => array()), or an empty array if the specified style
* has no effects.
* @see image_effects()
*/
function image_style_effects($style) {
$effects = image_effects();
$style_effects = array();
foreach ($effects as $effect) {
if ($style['isid'] == $effect['isid']) {
$style_effects[$effect['ieid']] = $effect;
}
}
return $style_effects;
}
/**
* Gets an array of image styles suitable for using as select list options.
*
* @param $include_empty
* If TRUE a
option will be inserted in the options array.
* @param $output
* Optional flag determining how the options will be sanitized on output.
* Leave this at the default (CHECK_PLAIN) if you are using the output of
* this function directly in an HTML context, such as for checkbox or radio
* button labels, and do not plan to sanitize it on your own. If using the
* output of this function as select list options (its primary use case), you
* should instead set this flag to PASS_THROUGH to avoid double-escaping of
* the output (the form API sanitizes select list options by default).
*
* @return
* Array of image styles with the machine name as key and the label as value.
*/
function image_style_options($include_empty = TRUE, $output = CHECK_PLAIN) {
$styles = image_styles();
$options = array();
if ($include_empty && !empty($styles)) {
$options[''] = t('');
}
foreach ($styles as $name => $style) {
$options[$name] = ($output == PASS_THROUGH) ? $style['label'] : check_plain($style['label']);
}
if (empty($options)) {
$options[''] = t('No defined styles');
}
return $options;
}
/**
* Page callback: Generates a derivative, given a style and image path.
*
* After generating an image, transfer it to the requesting agent.
*
* @param $style
* The image style
* @param $scheme
* The file scheme, for example 'public' for public files.
*/
function image_style_deliver($style, $scheme = NULL) {
$args = func_get_args();
array_shift($args);
array_shift($args);
$target = implode('/', $args);
// Check that the style is defined, the scheme is valid.
$valid = !empty($style) && !empty($scheme) && file_stream_wrapper_valid_scheme($scheme);
// Also validate the derivative token. Sites which require image derivatives
// to be generated without a token can set the 'image_allow_insecure_derivatives'
// variable to TRUE to bypass the latter check, but this will increase the
// site's vulnerability to denial-of-service attacks. To prevent this
// variable from leaving the site vulnerable to the most serious attacks, a
// token is always required when a derivative of a derivative is requested.)
$token = isset($_GET[IMAGE_DERIVATIVE_TOKEN]) ? $_GET[IMAGE_DERIVATIVE_TOKEN] : '';
$token_is_valid = $token === image_style_path_token($style['name'], $scheme . '://' . $target);
if (!variable_get('image_allow_insecure_derivatives', FALSE) || strpos(ltrim($target, '\/'), 'styles/') === 0) {
$valid = $valid && $token_is_valid;
}
if (!$valid) {
return MENU_ACCESS_DENIED;
}
$image_uri = $scheme . '://' . $target;
$derivative_uri = image_style_path($style['name'], $image_uri);
$derivative_scheme = file_uri_scheme($derivative_uri);
if ($token_is_valid) {
$is_public = ($scheme !== 'private');
}
else {
$core_schemes = array('public', 'private', 'temporary');
$additional_public_schemes = array_diff(variable_get('file_additional_public_schemes', array()), $core_schemes);
$public_schemes = array_merge(array('public'), $additional_public_schemes);
$is_public = in_array($derivative_scheme, $public_schemes, TRUE);
}
if ($scheme == 'private' && file_exists($derivative_uri)) {
file_download($scheme, file_uri_target($derivative_uri));
}
$headers = array();
if (!$is_public) {
$headers = file_download_headers($image_uri);
if (empty($headers)) {
return MENU_ACCESS_DENIED;
}
}
// Confirm that the original source image exists before trying to process it.
if (!_image_source_image_exists($image_uri, $token_is_valid)) {
watchdog('image', 'Source image at %source_image_path not found while trying to generate derivative image at %derivative_path.', array('%source_image_path' => $image_uri, '%derivative_path' => $derivative_uri));
return MENU_NOT_FOUND;
}
// Don't start generating the image if the derivative already exists or if
// generation is in progress in another thread.
$lock_name = 'image_style_deliver:' . $style['name'] . ':' . drupal_hash_base64($image_uri);
if (!file_exists($derivative_uri)) {
$lock_acquired = lock_acquire($lock_name);
if (!$lock_acquired) {
// Tell client to retry again in 3 seconds. Currently no browsers are known
// to support Retry-After.
drupal_add_http_header('Status', '503 Service Unavailable');
drupal_add_http_header('Content-Type', 'text/html; charset=utf-8');
drupal_add_http_header('Retry-After', 3);
print t('Image generation in progress. Try again shortly.');
drupal_exit();
}
}
// Try to generate the image, unless another thread just did it while we were
// acquiring the lock.
$success = file_exists($derivative_uri) || image_style_create_derivative($style, $image_uri, $derivative_uri);
if (!empty($lock_acquired)) {
lock_release($lock_name);
}
if ($success) {
$image = image_load($derivative_uri);
$headers['Content-Type'] = $image->info['mime_type'];
$headers['Content-Length'] = $image->info['file_size'];
file_transfer($image->source, $headers);
}
else {
watchdog('image', 'Unable to generate the derived image located at %path.', array('%path' => $derivative_uri));
drupal_add_http_header('Status', '500 Internal Server Error');
drupal_add_http_header('Content-Type', 'text/html; charset=utf-8');
print t('Error generating image.');
drupal_exit();
}
}
/**
* Checks whether the provided source image exists.
*
* When a valid token is provided for the image URI, this function is
* equivalent to calling file_exists($image_uri).
*
* @param string $image_uri
* The URI for the source image.
* @param bool $token_is_valid
* Whether a valid image token was supplied.
*
* @return bool
* Whether the source image exists.
*/
function _image_source_image_exists($image_uri, $token_is_valid) {
$exists = file_exists($image_uri);
// If the file doesn't exist, we can stop here.
if (!$exists) {
return FALSE;
}
if ($token_is_valid) {
return TRUE;
}
if (file_uri_scheme($image_uri) !== 'public') {
return TRUE;
}
$image_path = drupal_realpath($image_uri);
$private_path = variable_get('file_private_path', FALSE);
if ($private_path) {
$private_path = realpath($private_path);
if ($private_path && strpos($image_path, $private_path) === 0) {
return FALSE;
}
}
return TRUE;
}
/**
* Creates a new image derivative based on an image style.
*
* Generates an image derivative by creating the destination folder (if it does
* not already exist), applying all image effects defined in $style['effects'],
* and saving a cached version of the resulting image.
*
* @param $style
* An image style array.
* @param $source
* Path of the source file.
* @param $destination
* Path or URI of the destination file.
*
* @return
* TRUE if an image derivative was generated, or FALSE if the image derivative
* could not be generated.
*
* @see image_style_load()
*/
function image_style_create_derivative($style, $source, $destination) {
// If the source file doesn't exist, return FALSE without creating folders.
if (!$image = image_load($source)) {
return FALSE;
}
// Get the folder for the final location of this style.
$directory = drupal_dirname($destination);
// Build the destination folder tree if it doesn't already exist.
if (!file_prepare_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS)) {
watchdog('image', 'Failed to create style directory: %directory', array('%directory' => $directory), WATCHDOG_ERROR);
return FALSE;
}
foreach ($style['effects'] as $effect) {
image_effect_apply($image, $effect);
}
if (!image_save($image, $destination)) {
if (file_exists($destination)) {
watchdog('image', 'Cached image file %destination already exists. There may be an issue with your rewrite configuration.', array('%destination' => $destination), WATCHDOG_ERROR);
}
return FALSE;
}
return TRUE;
}
/**
* Determines the dimensions of the styled image.
*
* Applies all of an image style's effects to $dimensions.
*
* @param $style_name
* The name of the style to be applied.
* @param $dimensions
* Dimensions to be modified - an array with components width and height, in
* pixels.
*/
function image_style_transform_dimensions($style_name, array &$dimensions) {
module_load_include('inc', 'image', 'image.effects');
$style = image_style_load($style_name);
if (!is_array($style)) {
return;
}
foreach ($style['effects'] as $effect) {
if (isset($effect['dimensions passthrough'])) {
continue;
}
if (isset($effect['dimensions callback'])) {
$effect['dimensions callback']($dimensions, $effect['data']);
}
else {
$dimensions['width'] = $dimensions['height'] = NULL;
}
}
}
/**
* Flushes cached media for a style.
*
* @param $style
* An image style array.
*/
function image_style_flush($style) {
// Delete the style directory in each registered wrapper.
$wrappers = file_get_stream_wrappers(STREAM_WRAPPERS_WRITE_VISIBLE);
foreach ($wrappers as $wrapper => $wrapper_data) {
if (file_exists($directory = $wrapper . '://styles/' . $style['name'])) {
file_unmanaged_delete_recursive($directory);
}
}
// Let other modules update as necessary on flush.
module_invoke_all('image_style_flush', $style);
// Clear image style and effect caches.
cache_clear_all('image_styles', 'cache');
cache_clear_all('image_effects:', 'cache', TRUE);
drupal_static_reset('image_styles');
drupal_static_reset('image_effects');
// Clear field caches so that formatters may be added for this style.
field_info_cache_clear();
drupal_theme_rebuild();
// Clear page caches when flushing.
if (module_exists('block')) {
cache_clear_all('*', 'cache_block', TRUE);
}
cache_clear_all('*', 'cache_page', TRUE);
}
/**
* Returns the URL for an image derivative given a style and image path.
*
* @param $style_name
* The name of the style to be used with this image.
* @param $path
* The path to the image.
*
* @return
* The absolute URL where a style image can be downloaded, suitable for use
* in an ', 'No image displayed when no image is attached and no default image specified.');
// Add a default image to the public imagefield instance.
$images = $this->drupalGetTestFiles('image');
$edit = array(
'files[field_settings_default_image]' => drupal_realpath($images[0]->uri),
);
$this->drupalPost('admin/structure/types/manage/article/fields/' . $field_name, $edit, t('Save settings'));
// Clear field info cache so the new default image is detected.
field_info_cache_clear();
$field = field_info_field($field_name);
$image = file_load($field['settings']['default_image']);
$this->assertTrue($image->status == FILE_STATUS_PERMANENT, 'The default image status is permanent.');
$default_output = theme('image', array('path' => $image->uri));
$this->drupalGet('node/' . $node->nid);
$this->assertRaw($default_output, 'Default image displayed when no user supplied image is present.');
// Create a node with an image attached and ensure that the default image
// is not displayed.
$nid = $this->uploadNodeImage($images[1], $field_name, 'article');
$node = node_load($nid, NULL, TRUE);
$image_info = array(
'path' => $node->{$field_name}[LANGUAGE_NONE][0]['uri'],
'width' => 40,
'height' => 20,
);
$image_output = theme('image', $image_info);
$this->drupalGet('node/' . $nid);
$this->assertNoRaw($default_output, 'Default image is not displayed when user supplied image is present.');
$this->assertRaw($image_output, 'User supplied image is displayed.');
// Remove default image from the field and make sure it is no longer used.
$edit = array(
'field[settings][default_image][fid]' => 0,
);
$this->drupalPost('admin/structure/types/manage/article/fields/' . $field_name, $edit, t('Save settings'));
// Clear field info cache so the new default image is detected.
field_info_cache_clear();
$field = field_info_field($field_name);
$this->assertFalse($field['settings']['default_image'], 'Default image removed from field.');
// Create an image field that uses the private:// scheme and test that the
// default image works as expected.
$private_field_name = strtolower($this->randomName());
$this->createImageField($private_field_name, 'article', array('uri_scheme' => 'private'));
// Add a default image to the new field.
$edit = array(
'files[field_settings_default_image]' => drupal_realpath($images[1]->uri),
);
$this->drupalPost('admin/structure/types/manage/article/fields/' . $private_field_name, $edit, t('Save settings'));
$private_field = field_info_field($private_field_name);
$image = file_load($private_field['settings']['default_image']);
$this->assertEqual('private', file_uri_scheme($image->uri), 'Default image uses private:// scheme.');
$this->assertTrue($image->status == FILE_STATUS_PERMANENT, 'The default image status is permanent.');
// Create a new node with no image attached and ensure that default private
// image is displayed.
$node = $this->drupalCreateNode(array('type' => 'article'));
$default_output = theme('image', array('path' => $image->uri));
$this->drupalGet('node/' . $node->nid);
$this->assertRaw($default_output, 'Default private image displayed when no user supplied image is present.');
}
/**
* Tests the display of image field with the missing FID.
*/
function testMissingImageFieldDisplay() {
$field_name = strtolower($this->randomName());
$type_name = 'article';
$field_settings = array(
'display_field' => '1',
'display_default' => '1',
);
$instance_settings = array(
'description_field' => '1',
);
$widget_settings = array();
$this->createImageField($field_name, $type_name, $field_settings, $instance_settings, $widget_settings);
$images = $this->drupalGetTestFiles('image');
// Create a new node with the uploaded file.
$nid = $this->uploadNodeImage($images[1], $field_name, 'article');
// Delete uploaded file from file_managed table.
$max_fid_after = db_query('SELECT MAX(fid) AS fid FROM {file_managed}')->fetchField();
$uploaded_file = file_load($max_fid_after);
file_delete($uploaded_file, TRUE);
// Clear field cache.
field_cache_clear();
// Check the node detail if the file is loaded.
$this->drupalGet('node/' . $nid);
$this->assertResponse(200);
}
}
/**
* Test class to check for various validations.
*/
class ImageFieldValidateTestCase extends ImageFieldTestCase {
public static function getInfo() {
return array(
'name' => 'Image field validation tests',
'description' => 'Tests validation functions such as min/max resolution.',
'group' => 'Image',
);
}
/**
* Test min/max resolution settings.
*/
function testResolution() {
$field_name = strtolower($this->randomName());
$min_resolution = 50;
$max_resolution = 100;
$instance_settings = array(
'max_resolution' => $max_resolution . 'x' . $max_resolution,
'min_resolution' => $min_resolution . 'x' . $min_resolution,
);
$this->createImageField($field_name, 'article', array(), $instance_settings);
// We want a test image that is too small, and a test image that is too
// big, so cycle through test image files until we have what we need.
$image_that_is_too_big = FALSE;
$image_that_is_too_small = FALSE;
foreach ($this->drupalGetTestFiles('image') as $image) {
$info = image_get_info($image->uri);
if ($info['width'] > $max_resolution) {
$image_that_is_too_big = $image;
}
if ($info['width'] < $min_resolution) {
$image_that_is_too_small = $image;
}
if ($image_that_is_too_small && $image_that_is_too_big) {
break;
}
}
$nid = $this->uploadNodeImage($image_that_is_too_small, $field_name, 'article');
$this->assertText(t('The specified file ' . $image_that_is_too_small->filename . ' could not be uploaded. The image is too small; the minimum dimensions are 50x50 pixels.'), 'Node save failed when minimum image resolution was not met.');
$nid = $this->uploadNodeImage($image_that_is_too_big, $field_name, 'article');
$this->assertText(t('The image was resized to fit within the maximum allowed dimensions of 100x100 pixels.'), 'Image exceeding max resolution was properly resized.');
// Verify that image resolution can contain only positive numbers.
$edit = array(
'instance[settings][max_resolution][x]' => -10,
'instance[settings][max_resolution][y]' => -10,
);
$this->drupalPost('admin/structure/types/manage/article/fields/' . $field_name, $edit, t('Save settings'));
$this->assertRaw(t('Height and width values must be positive numbers.'));
$edit = array(
'instance[settings][max_resolution][x]' => 'x',
'instance[settings][max_resolution][y]' => 'x',
);
$this->drupalPost('admin/structure/types/manage/article/fields/' . $field_name, $edit, t('Save settings'));
$this->assertRaw(t('Height and width values must be numeric.'));
}
}
/**
* Tests that images have correct dimensions when styled.
*/
class ImageDimensionsTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Image dimensions',
'description' => 'Tests that images have correct dimensions when styled.',
'group' => 'Image',
);
}
function setUp() {
parent::setUp('image_module_test');
}
/**
* Test styled image dimensions cumulatively.
*/
function testImageDimensions() {
// Create a working copy of the file.
$files = $this->drupalGetTestFiles('image');
$file = reset($files);
$original_uri = file_unmanaged_copy($file->uri, 'public://', FILE_EXISTS_RENAME);
// Create a style.
$style = image_style_save(array('name' => 'test', 'label' => 'Test'));
$generated_uri = 'public://styles/test/public/'. drupal_basename($original_uri);
$url = image_style_url('test', $original_uri);
$variables = array(
'style_name' => 'test',
'path' => $original_uri,
'width' => 40,
'height' => 20,
);
// Scale an image that is wider than it is high.
$effect = array(
'name' => 'image_scale',
'data' => array(
'width' => 120,
'height' => 90,
'upscale' => TRUE,
),
'isid' => $style['isid'],
);
image_effect_save($effect);
$img_tag = theme_image_style($variables);
$this->assertEqual($img_tag, '
', 'Expected img tag was found.');
$this->assertFalse(file_exists($generated_uri), 'Generated file does not exist.');
$this->drupalGet($url);
$this->assertResponse(200, 'Image was generated at the URL.');
$this->assertTrue(file_exists($generated_uri), 'Generated file does exist after we accessed it.');
$image_info = image_get_info($generated_uri);
$this->assertEqual($image_info['width'], 120, 'Expected width was found.');
$this->assertEqual($image_info['height'], 60, 'Expected height was found.');
// Rotate 90 degrees anticlockwise.
$effect = array(
'name' => 'image_rotate',
'data' => array(
'degrees' => -90,
'random' => FALSE,
),
'isid' => $style['isid'],
);
image_effect_save($effect);
$img_tag = theme_image_style($variables);
$this->assertEqual($img_tag, '
', 'Expected img tag was found.');
$this->assertFalse(file_exists($generated_uri), 'Generated file does not exist.');
$this->drupalGet($url);
$this->assertResponse(200, 'Image was generated at the URL.');
$this->assertTrue(file_exists($generated_uri), 'Generated file does exist after we accessed it.');
$image_info = image_get_info($generated_uri);
$this->assertEqual($image_info['width'], 60, 'Expected width was found.');
$this->assertEqual($image_info['height'], 120, 'Expected height was found.');
// Scale an image that is higher than it is wide (rotated by previous effect).
$effect = array(
'name' => 'image_scale',
'data' => array(
'width' => 120,
'height' => 90,
'upscale' => TRUE,
),
'isid' => $style['isid'],
);
image_effect_save($effect);
$img_tag = theme_image_style($variables);
$this->assertEqual($img_tag, '
', 'Expected img tag was found.');
$this->assertFalse(file_exists($generated_uri), 'Generated file does not exist.');
$this->drupalGet($url);
$this->assertResponse(200, 'Image was generated at the URL.');
$this->assertTrue(file_exists($generated_uri), 'Generated file does exist after we accessed it.');
$image_info = image_get_info($generated_uri);
$this->assertEqual($image_info['width'], 45, 'Expected width was found.');
$this->assertEqual($image_info['height'], 90, 'Expected height was found.');
// Test upscale disabled.
$effect = array(
'name' => 'image_scale',
'data' => array(
'width' => 400,
'height' => 200,
'upscale' => FALSE,
),
'isid' => $style['isid'],
);
image_effect_save($effect);
$img_tag = theme_image_style($variables);
$this->assertEqual($img_tag, '
', 'Expected img tag was found.');
$this->assertFalse(file_exists($generated_uri), 'Generated file does not exist.');
$this->drupalGet($url);
$this->assertResponse(200, 'Image was generated at the URL.');
$this->assertTrue(file_exists($generated_uri), 'Generated file does exist after we accessed it.');
$image_info = image_get_info($generated_uri);
$this->assertEqual($image_info['width'], 45, 'Expected width was found.');
$this->assertEqual($image_info['height'], 90, 'Expected height was found.');
// Add a desaturate effect.
$effect = array(
'name' => 'image_desaturate',
'data' => array(),
'isid' => $style['isid'],
);
image_effect_save($effect);
$img_tag = theme_image_style($variables);
$this->assertEqual($img_tag, '
', 'Expected img tag was found.');
$this->assertFalse(file_exists($generated_uri), 'Generated file does not exist.');
$this->drupalGet($url);
$this->assertResponse(200, 'Image was generated at the URL.');
$this->assertTrue(file_exists($generated_uri), 'Generated file does exist after we accessed it.');
$image_info = image_get_info($generated_uri);
$this->assertEqual($image_info['width'], 45, 'Expected width was found.');
$this->assertEqual($image_info['height'], 90, 'Expected height was found.');
// Add a random rotate effect.
$effect = array(
'name' => 'image_rotate',
'data' => array(
'degrees' => 180,
'random' => TRUE,
),
'isid' => $style['isid'],
);
image_effect_save($effect);
$img_tag = theme_image_style($variables);
$this->assertEqual($img_tag, '
', 'Expected img tag was found.');
$this->assertFalse(file_exists($generated_uri), 'Generated file does not exist.');
$this->drupalGet($url);
$this->assertResponse(200, 'Image was generated at the URL.');
$this->assertTrue(file_exists($generated_uri), 'Generated file does exist after we accessed it.');
// Add a crop effect.
$effect = array(
'name' => 'image_crop',
'data' => array(
'width' => 30,
'height' => 30,
'anchor' => 'center-center',
),
'isid' => $style['isid'],
);
image_effect_save($effect);
$img_tag = theme_image_style($variables);
$this->assertEqual($img_tag, '
', 'Expected img tag was found.');
$this->assertFalse(file_exists($generated_uri), 'Generated file does not exist.');
$this->drupalGet($url);
$this->assertResponse(200, 'Image was generated at the URL.');
$this->assertTrue(file_exists($generated_uri), 'Generated file does exist after we accessed it.');
$image_info = image_get_info($generated_uri);
$this->assertEqual($image_info['width'], 30, 'Expected width was found.');
$this->assertEqual($image_info['height'], 30, 'Expected height was found.');
// Rotate to a non-multiple of 90 degrees.
$effect = array(
'name' => 'image_rotate',
'data' => array(
'degrees' => 57,
'random' => FALSE,
),
'isid' => $style['isid'],
);
$effect = image_effect_save($effect);
$img_tag = theme_image_style($variables);
$this->assertEqual($img_tag, '
', 'Expected img tag was found.');
$this->assertFalse(file_exists($generated_uri), 'Generated file does not exist.');
$this->drupalGet($url);
$this->assertResponse(200, 'Image was generated at the URL.');
$this->assertTrue(file_exists($generated_uri), 'Generated file does exist after we accessed it.');
image_effect_delete($effect);
// Ensure that an effect with no dimensions callback unsets the dimensions.
// This ensures compatibility with 7.0 contrib modules.
$effect = array(
'name' => 'image_module_test_null',
'data' => array(),
'isid' => $style['isid'],
);
image_effect_save($effect);
$img_tag = theme_image_style($variables);
$this->assertEqual($img_tag, '
', 'Expected img tag was found.');
}
}
/**
* Tests image_dimensions_scale().
*/
class ImageDimensionsScaleTestCase extends DrupalUnitTestCase {
public static function getInfo() {
return array(
'name' => 'image_dimensions_scale()',
'description' => 'Tests all control flow branches in image_dimensions_scale().',
'group' => 'Image',
);
}
/**
* Tests all control flow branches in image_dimensions_scale().
*/
function testImageDimensionsScale() {
// Define input / output datasets to test different branch conditions.
$test = array();
// Test branch conditions:
// - No height.
// - Upscale, don't need to upscale.
$tests[] = array(
'input' => array(
'dimensions' => array(
'width' => 1000,
'height' => 2000,
),
'width' => 200,
'height' => NULL,
'upscale' => TRUE,
),
'output' => array(
'dimensions' => array(
'width' => 200,
'height' => 400,
),
'return_value' => TRUE,
),
);
// Test branch conditions:
// - No width.
// - Don't upscale, don't need to upscale.
$tests[] = array(
'input' => array(
'dimensions' => array(
'width' => 1000,
'height' => 800,
),
'width' => NULL,
'height' => 140,
'upscale' => FALSE,
),
'output' => array(
'dimensions' => array(
'width' => 175,
'height' => 140,
),
'return_value' => TRUE,
),
);
// Test branch conditions:
// - Source aspect ratio greater than target.
// - Upscale, need to upscale.
$tests[] = array(
'input' => array(
'dimensions' => array(
'width' => 8,
'height' => 20,
),
'width' => 200,
'height' => 140,
'upscale' => TRUE,
),
'output' => array(
'dimensions' => array(
'width' => 56,
'height' => 140,
),
'return_value' => TRUE,
),
);
// Test branch condition: target aspect ratio greater than source.
$tests[] = array(
'input' => array(
'dimensions' => array(
'width' => 2000,
'height' => 800,
),
'width' => 200,
'height' => 140,
'upscale' => FALSE,
),
'output' => array(
'dimensions' => array(
'width' => 200,
'height' => 80,
),
'return_value' => TRUE,
),
);
// Test branch condition: don't upscale, need to upscale.
$tests[] = array(
'input' => array(
'dimensions' => array(
'width' => 100,
'height' => 50,
),
'width' => 200,
'height' => 140,
'upscale' => FALSE,
),
'output' => array(
'dimensions' => array(
'width' => 100,
'height' => 50,
),
'return_value' => FALSE,
),
);
foreach ($tests as $test) {
// Process the test dataset.
$return_value = image_dimensions_scale($test['input']['dimensions'], $test['input']['width'], $test['input']['height'], $test['input']['upscale']);
// Check the width.
$this->assertEqual($test['output']['dimensions']['width'], $test['input']['dimensions']['width'], format_string('Computed width (@computed_width) equals expected width (@expected_width)', array('@computed_width' => $test['output']['dimensions']['width'], '@expected_width' => $test['input']['dimensions']['width'])));
// Check the height.
$this->assertEqual($test['output']['dimensions']['height'], $test['input']['dimensions']['height'], format_string('Computed height (@computed_height) equals expected height (@expected_height)', array('@computed_height' => $test['output']['dimensions']['height'], '@expected_height' => $test['input']['dimensions']['height'])));
// Check the return value.
$this->assertEqual($test['output']['return_value'], $return_value, 'Correct return value.');
}
}
}
/**
* Tests default image settings.
*/
class ImageFieldDefaultImagesTestCase extends ImageFieldTestCase {
public static function getInfo() {
return array(
'name' => 'Image field default images tests',
'description' => 'Tests setting up default images both to the field and field instance.',
'group' => 'Image',
);
}
function setUp() {
parent::setUp(array('field_ui'));
}
/**
* Tests CRUD for fields and fields instances with default images.
*/
function testDefaultImages() {
// Create files to use as the default images.
$files = $this->drupalGetTestFiles('image');
$default_images = array();
foreach (array('field', 'instance', 'instance2', 'field_new', 'instance_new') as $image_target) {
$file = array_pop($files);
$file = file_save($file);
$default_images[$image_target] = $file;
}
// Create an image field and add an instance to the article content type.
$field_name = strtolower($this->randomName());
$field_settings = array(
'default_image' => $default_images['field']->fid,
);
$instance_settings = array(
'default_image' => $default_images['instance']->fid,
);
$widget_settings = array(
'preview_image_style' => 'medium',
);
$this->createImageField($field_name, 'article', $field_settings, $instance_settings, $widget_settings);
$field = field_info_field($field_name);
$instance = field_info_instance('node', $field_name, 'article');
// Add another instance with another default image to the page content type.
$instance2 = array_merge($instance, array(
'bundle' => 'page',
'settings' => array(
'default_image' => $default_images['instance2']->fid,
),
));
field_create_instance($instance2);
$instance2 = field_info_instance('node', $field_name, 'page');
// Confirm the defaults are present on the article field admin form.
$this->drupalGet("admin/structure/types/manage/article/fields/$field_name");
$this->assertFieldByXpath(
'//input[@name="field[settings][default_image][fid]"]',
$default_images['field']->fid,
format_string(
'Article image field default equals expected file ID of @fid.',
array('@fid' => $default_images['field']->fid)
)
);
$this->assertFieldByXpath(
'//input[@name="instance[settings][default_image][fid]"]',
$default_images['instance']->fid,
format_string(
'Article image field instance default equals expected file ID of @fid.',
array('@fid' => $default_images['instance']->fid)
)
);
// Confirm the defaults are present on the page field admin form.
$this->drupalGet("admin/structure/types/manage/page/fields/$field_name");
$this->assertFieldByXpath(
'//input[@name="field[settings][default_image][fid]"]',
$default_images['field']->fid,
format_string(
'Page image field default equals expected file ID of @fid.',
array('@fid' => $default_images['field']->fid)
)
);
$this->assertFieldByXpath(
'//input[@name="instance[settings][default_image][fid]"]',
$default_images['instance2']->fid,
format_string(
'Page image field instance default equals expected file ID of @fid.',
array('@fid' => $default_images['instance2']->fid)
)
);
// Confirm that the image default is shown for a new article node.
$article = $this->drupalCreateNode(array('type' => 'article'));
$article_built = node_view($article);
$this->assertEqual(
$article_built[$field_name]['#items'][0]['fid'],
$default_images['instance']->fid,
format_string(
'A new article node without an image has the expected default image file ID of @fid.',
array('@fid' => $default_images['instance']->fid)
)
);
// Confirm that the image default is shown for a new page node.
$page = $this->drupalCreateNode(array('type' => 'page'));
$page_built = node_view($page);
$this->assertEqual(
$page_built[$field_name]['#items'][0]['fid'],
$default_images['instance2']->fid,
format_string(
'A new page node without an image has the expected default image file ID of @fid.',
array('@fid' => $default_images['instance2']->fid)
)
);
// Upload a new default for the field.
$field['settings']['default_image'] = $default_images['field_new']->fid;
field_update_field($field);
// Confirm that the new field default is used on the article admin form.
$this->drupalGet("admin/structure/types/manage/article/fields/$field_name");
$this->assertFieldByXpath(
'//input[@name="field[settings][default_image][fid]"]',
$default_images['field_new']->fid,
format_string(
'Updated image field default equals expected file ID of @fid.',
array('@fid' => $default_images['field_new']->fid)
)
);
// Reload the nodes and confirm the field instance defaults are used.
$article_built = node_view($article = node_load($article->nid, NULL, $reset = TRUE));
$page_built = node_view($page = node_load($page->nid, NULL, $reset = TRUE));
$this->assertEqual(
$article_built[$field_name]['#items'][0]['fid'],
$default_images['instance']->fid,
format_string(
'An existing article node without an image has the expected default image file ID of @fid.',
array('@fid' => $default_images['instance']->fid)
)
);
$this->assertEqual(
$page_built[$field_name]['#items'][0]['fid'],
$default_images['instance2']->fid,
format_string(
'An existing page node without an image has the expected default image file ID of @fid.',
array('@fid' => $default_images['instance2']->fid)
)
);
// Upload a new default for the article's field instance.
$instance['settings']['default_image'] = $default_images['instance_new']->fid;
field_update_instance($instance);
// Confirm the new field instance default is used on the article field
// admin form.
$this->drupalGet("admin/structure/types/manage/article/fields/$field_name");
$this->assertFieldByXpath(
'//input[@name="instance[settings][default_image][fid]"]',
$default_images['instance_new']->fid,
format_string(
'Updated article image field instance default equals expected file ID of @fid.',
array('@fid' => $default_images['instance_new']->fid)
)
);
// Reload the nodes.
$article_built = node_view($article = node_load($article->nid, NULL, $reset = TRUE));
$page_built = node_view($page = node_load($page->nid, NULL, $reset = TRUE));
// Confirm the article uses the new default.
$this->assertEqual(
$article_built[$field_name]['#items'][0]['fid'],
$default_images['instance_new']->fid,
format_string(
'An existing article node without an image has the expected default image file ID of @fid.',
array('@fid' => $default_images['instance_new']->fid)
)
);
// Confirm the page remains unchanged.
$this->assertEqual(
$page_built[$field_name]['#items'][0]['fid'],
$default_images['instance2']->fid,
format_string(
'An existing page node without an image has the expected default image file ID of @fid.',
array('@fid' => $default_images['instance2']->fid)
)
);
// Remove the instance default from articles.
$instance['settings']['default_image'] = NULL;
field_update_instance($instance);
// Confirm the article field instance default has been removed.
$this->drupalGet("admin/structure/types/manage/article/fields/$field_name");
$this->assertFieldByXpath(
'//input[@name="instance[settings][default_image][fid]"]',
'',
'Updated article image field instance default has been successfully removed.'
);
// Reload the nodes.
$article_built = node_view($article = node_load($article->nid, NULL, $reset = TRUE));
$page_built = node_view($page = node_load($page->nid, NULL, $reset = TRUE));
// Confirm the article uses the new field (not instance) default.
$this->assertEqual(
$article_built[$field_name]['#items'][0]['fid'],
$default_images['field_new']->fid,
format_string(
'An existing article node without an image has the expected default image file ID of @fid.',
array('@fid' => $default_images['field_new']->fid)
)
);
// Confirm the page remains unchanged.
$this->assertEqual(
$page_built[$field_name]['#items'][0]['fid'],
$default_images['instance2']->fid,
format_string(
'An existing page node without an image has the expected default image file ID of @fid.',
array('@fid' => $default_images['instance2']->fid)
)
);
}
}
/**
* Tests image theme functions.
*/
class ImageThemeFunctionWebTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Image theme functions',
'description' => 'Test that the image theme functions work correctly.',
'group' => 'Image',
);
}
function setUp() {
parent::setUp(array('image'));
}
/**
* Tests usage of the image field formatters.
*/
function testImageFormatterTheme() {
// Create an image.
$files = $this->drupalGetTestFiles('image');
$file = reset($files);
$original_uri = file_unmanaged_copy($file->uri, 'public://', FILE_EXISTS_RENAME);
// Create a style.
image_style_save(array('name' => 'test', 'label' => 'Test'));
$url = image_style_url('test', $original_uri);
// Test using theme_image_formatter() without an image title, alt text, or
// link options.
$path = $this->randomName();
$element = array(
'#theme' => 'image_formatter',
'#image_style' => 'test',
'#item' => array(
'uri' => $original_uri,
),
'#path' => array(
'path' => $path,
),
);
$rendered_element = render($element);
$expected_result = '
';
$this->assertEqual($expected_result, $rendered_element, 'theme_image_formatter() correctly renders without title, alt, or path options.');
// Link the image to a fragment on the page, and not a full URL.
$fragment = $this->randomName();
$element['#path']['path'] = '';
$element['#path']['options'] = array(
'external' => TRUE,
'fragment' => $fragment,
);
$rendered_element = render($element);
$expected_result = '
';
$this->assertEqual($expected_result, $rendered_element, 'theme_image_formatter() correctly renders a link fragment.');
}
}
/**
* Tests flushing of image styles.
*/
class ImageStyleFlushTest extends ImageFieldTestCase {
public static function getInfo() {
return array(
'name' => 'Image style flushing',
'description' => 'Tests flushing of image styles.',
'group' => 'Image',
);
}
/**
* Given an image style and a wrapper, generate an image.
*/
function createSampleImage($style, $wrapper) {
static $file;
if (!isset($file)) {
$files = $this->drupalGetTestFiles('image');
$file = reset($files);
}
// Make sure we have an image in our wrapper testing file directory.
$source_uri = file_unmanaged_copy($file->uri, $wrapper . '://');
// Build the derivative image.
$derivative_uri = image_style_path($style['name'], $source_uri);
$derivative = image_style_create_derivative($style, $source_uri, $derivative_uri);
return $derivative ? $derivative_uri : FALSE;
}
/**
* Count the number of images currently created for a style in a wrapper.
*/
function getImageCount($style, $wrapper) {
return count(file_scan_directory($wrapper . '://styles/' . $style['name'], '/.*/'));
}
/**
* General test to flush a style.
*/
function testFlush() {
// Setup a style to be created and effects to add to it.
$style_name = strtolower($this->randomName(10));
$style_label = $this->randomString();
$style_path = 'admin/config/media/image-styles/edit/' . $style_name;
$effect_edits = array(
'image_resize' => array(
'data[width]' => 100,
'data[height]' => 101,
),
'image_scale' => array(
'data[width]' => 110,
'data[height]' => 111,
'data[upscale]' => 1,
),
);
// Add style form.
$edit = array(
'name' => $style_name,
'label' => $style_label,
);
$this->drupalPost('admin/config/media/image-styles/add', $edit, t('Create new style'));
// Add each sample effect to the style.
foreach ($effect_edits as $effect => $edit) {
// Add the effect.
$this->drupalPost($style_path, array('new' => $effect), t('Add'));
if (!empty($edit)) {
$this->drupalPost(NULL, $edit, t('Add effect'));
}
}
// Load the saved image style.
$style = image_style_load($style_name);
// Create an image for the 'public' wrapper.
$image_path = $this->createSampleImage($style, 'public');
// Expecting to find 2 images, one is the sample.png image shown in
// image style preview.
$this->assertEqual($this->getImageCount($style, 'public'), 2, format_string('Image style %style image %file successfully generated.', array('%style' => $style['name'], '%file' => $image_path)));
// Create an image for the 'private' wrapper.
$image_path = $this->createSampleImage($style, 'private');
$this->assertEqual($this->getImageCount($style, 'private'), 1, format_string('Image style %style image %file successfully generated.', array('%style' => $style['name'], '%file' => $image_path)));
// Remove the 'image_scale' effect and updates the style, which in turn
// forces an image style flush.
$effect = array_pop($style['effects']);
$this->drupalPost($style_path . '/effects/' . $effect['ieid'] . '/delete', array(), t('Delete'));
$this->assertResponse(200);
$this->drupalPost($style_path, array(), t('Update style'));
$this->assertResponse(200);
// Post flush, expected 1 image in the 'public' wrapper (sample.png).
$this->assertEqual($this->getImageCount($style, 'public'), 1, format_string('Image style %style flushed correctly for %wrapper wrapper.', array('%style' => $style['name'], '%wrapper' => 'public')));
// Post flush, expected no image in the 'private' wrapper.
$this->assertEqual($this->getImageCount($style, 'private'), 0, format_string('Image style %style flushed correctly for %wrapper wrapper.', array('%style' => $style['name'], '%wrapper' => 'private')));
}
}
/**
* Tests for correct file size, dimensions and HTTP headers after scaling.
*/
class ImageStylesHTTPHeadersTestCase extends ImageFieldTestCase {
/**
* Generated style name.
*
* @var string
*/
protected $styleName;
/**
* ID of generated style.
*
* @var int
*/
protected $styleId;
/**
* {@inheritdoc}
*/
public static function getInfo() {
return array(
'name' => 'Image styles HTTP headers tests',
'description' => 'Tests file size, dimensions and HTTP headers of image styles generated with scaling.',
'group' => 'Image',
);
}
/**
* {@inheritdoc}
*/
public function setUp() {
parent::setUp('image_module_test');
$this->styleName = 'style_foo_scale';
$style = image_style_save(array(
'name' => $this->styleName,
'label' => $this->randomString(),
));
$this->styleId = $style['isid'];
}
/**
* Test image_style_url() with a file with public scheme and upscaling.
*/
public function testImageStyleUrlAndPathPublicAndUpscale() {
$width = 3600;
$height = 2400;
$this->_imagestyleUpscale($width, $height);
$this->_testImageStyleUrlAndPath('public', $width, $height);
}
/**
* Test image_style_url() with a file with private scheme and upscaling.
*/
public function testImageStyleUrlAndPathPrivateAndUpscale() {
$width = 3600;
$height = 2400;
$this->_imagestyleUpscale($width, $height);
$this->_testImageStyleUrlAndPath('private', $width, $height);
}
/**
* Test image_style_url() with a file with public scheme and downscaling.
*/
public function testImageStyleUrlAndPathPublicAndDownscale() {
$width = 180;
$height = 120;
$this->_imagestyleUpscale($width, $height);
$this->_testImageStyleUrlAndPath('public', $width, $height);
}
/**
* Test image_style_url() with a file with private scheme and downscaling.
*/
public function testImageStyleUrlAndPathPrivateAndDownscale() {
$width = 180;
$height = 120;
$this->_imagestyleUpscale($width, $height);
$this->_testImageStyleUrlAndPath('private', $width, $height);
}
/**
* Adding upscale effect to imagestyle.
*/
private function _imagestyleUpscale($width, $height) {
// Scale an image that is wider than it is high.
$effect = array(
'name' => 'image_scale',
'data' => array(
'width' => $width,
'height' => $height,
'upscale' => TRUE,
),
'isid' => $this->styleId,
);
image_effect_save($effect);
}
/**
* Function to scale and test.
*/
private function _testImageStyleUrlAndPath($scheme, $width, $height) {
$directory = $scheme . '://styles/' . $this->styleName;
$status = file_prepare_directory($directory, FILE_CREATE_DIRECTORY);
$this->assertNotIdentical(FALSE, $status, 'Created the directory for the generated images for the test style.');
// Create an image field that uses the new style.
$field_name = strtolower($this->randomName(10));
$this->createImageField($field_name, 'article', array('uri_scheme' => $scheme));
$instance = field_info_instance('node', $field_name, 'article');
$instance['display']['default']['type'] = 'image';
$instance['display']['default']['settings']['image_style'] = $this->styleName;
field_update_instance($instance);
// Create a new node with an image attached.
$images = $this->drupalGetTestFiles('image');
// Taking image no. 6 because Apache sets own
// Content-Length if response is smaller than 8000 bytes.
$test_image = $images[6];
$nid = $this->uploadNodeImage($test_image, $field_name, 'article');
$node = node_load($nid);
// Get image file from created node.
$field_items = field_get_items('node', $node, $field_name);
$file = file_load($field_items[0]['fid']);
$original_uri = $file->uri;
// Let the image_module_test module know about this file, so it can claim
// ownership in hook_file_download().
variable_set('image_module_test_file_download', $original_uri);
// Get the URL of a file that has not been generated and try to create it.
$generated_uri = image_style_path($this->styleName, $original_uri);
$this->assertFalse(file_exists($generated_uri), 'Generated file does not exist.');
$generate_url = image_style_url($this->styleName, $original_uri);
// Fetch the URL that generates the file.
$this->drupalGet($generate_url);
$this->assertResponse(200, 'Image was generated at the URL.');
$this->assertTrue(file_exists($generated_uri), 'Generated file does exist after we accessed it: ' . $generated_uri);
// Store generated image info.
$generated_image_info = image_get_info($generated_uri);
// Compare result.
$this->assertEqual($this->drupalGetHeader('Content-Type'), $generated_image_info['mime_type'], 'Expected Content-Type was reported.');
$this->assertEqual($this->drupalGetHeader('Content-Length'), $generated_image_info['file_size'], 'Expected Content-Length was reported: ' . $generated_image_info['file_size'] . ' vs. ' . $this->drupalGetHeader('Content-Length'));
$this->assertEqual($width, $generated_image_info['width'], 'Expected width was reported.');
$this->assertEqual($height, $generated_image_info['height'], 'Expected height was reported.');
}
}
PNG
IHDR X ' uIDATx^Ah\UsoI6iFVZiNJUl RB.\ .Ep'+JT*"hciN3I;L&d2UBiSxL~gBr{p>=K4?~߇}ѯ[$}p*k]h r;V_KJrJ$c06O*fM)iA1ZfL13c3ai? 0fLgfJ2m)>6fL 3q
҄xR fb 3a&̴``ĒL 3a& 7"- ,fL 3AXfL 3a&"h?3AXK f"n 3a&-0#MlYLD4aH 3a&DDfb&1M
`&4fYQ"L
`&1fJa? lG
`&0fL X̄hL 3ahрUQ0c 31C ,01h 3a&"8L XQ̄0f"n 3ѧ4f&̄-VfLlD47hLi0S l{
`&"L 3DQFq&̄0fV̄0f<3a&eY8fL`&ˡfVE70g٩i?UTj3:78s)
L*:2B ذfbo3a&r0hfb)XYʎdcTUƨޚj|V=WϊgŦuSDDAm? oELͅ-Yk
O:v٦DՈ͎;YI>;:#hR[{WLD4a&̄0fD4YVdzXޜatf+v{_Q#w_ [gl _<'䑪uniҬ79:j5Ә2=0S 0H^m`&"'տ]U
@:Lm M (.>V⍴pby!i=9ҳO(Ued; TP.3)fL)9LD4a5]f"n2wMh$"9yjkB
iЭj]o-{co- ʕL '7eoQ t1ܔR!=y%;WL 3AD fVסdf$%2Ήs/yqWf sYg*ڏòjgzWz #AoK r/;Ԫvr|-AK0M 37Lֲ.zmWy"K?1֓jwtRgv5Cګ ~) !=w) U"VǧE^-`j',), Qhiڿ# E< E*:z;sZLtog r&r&h"g"1Pptb-iL9{0Щçk0V}eV p|zO1ɶ ٹ֕7Ο {V*Sv $`g~Ӂ3^L7@qL$LiF8b- |s?{!# r]ީoּS6<˪i~ Ar I&ϿͿ\DܥV 7g8}8{ șșșƅ38,KC_cY{r
^`=j1Ç)#ؕi/1[g(fDS,zD/WM-~A8@vB_鑽{NrQ)9
3
qL}^_=߿N%9Ek
Ę<뙻{N`WX#A-> Tkۍ%i!Q
;~F_ރumnr&33er&r&<*9v_Ѹb'v! kv}jW|VFa &9Tpy/
ԝEػݘ 27X^ST{9Jə(nVƺªLv}IW-/^ut Bίa9ܮj W|r5s:KP=K%{y3ʉ|_vg8X{Ot/=ߝGMLL7@MLc,T$gʺw_\ۑs|I7,vҧr( u]E2%i*?wܵsT7A" [_.|.{sn軟}kCZ'g&rMLt*`^OҬ-(8
AтavT!#ݯ\(UR^_wA2{бŭVexg4zV_86 bșșșFqD {i#ZkGnqMWp2#9뾜:"0Et R%zS 6_S70 F\0sr=_*,ӫf^LDqLLLc
T dzf7tgh{}v ?rʱ 9/Gr^n{Jǿrr= @or~~PBvP8RH [g ?bV.ÉG[I^o[nYU߿gvs"h
i JCY梽o^u
Ç01ߞdx! S 0{wi`Ui.ΎGgFōÎg#:7z .xtՁ~`T&r&[or&ϑ3`VFixl?w[(koH:Yߊ9sA Su
mhyi2wV '=0R}D#?v}ąP }[7 ꍃ 33 h"g"g"g63gHp͛?{~~m\߉3V3 ȭsz><|H7=ՇN^8k=$C) h|.< `dzۥNuəڟܴ7衸r& g"gHߥ1*}Ls .}ǭOeqջ
| dW,i"w!MQT[?2MC2+};E+`$NE#?vis*5žo/7-&g&r&r&j3E5-(Ņes}_ysWuus81-UG>d'^6dF:H 2m_sW nBDqLLj"g=b"3Iሆ{r։]W.4h5- 90=xQuw@ ygWK~
$b9킩H 1rƗnk7 KM7@$E4x)mL2xh?@<\Ϟ]!oYOLvBt#i|0;2KO5_?sVH
/.$8eÈ ~CgVX&;!g"g5p
ITA/ ^; VWΛ(8i̗= ٰ, tgnN;L)B Go#%mɚ|3N?mC5pr&ϑ333*ig% spCrs|# @\k0 ߑsNoFy9HZAsĈ)hR>n}ɍwD
) LLLL ;B(1k#Z4WĜqCߌ>Jʖ6.
D%BdvԽw,ijx=kVrq天G:UW[r'FqLCDqLh
3%[O_(a8 ɜtI!_>Sʻ\|X5Bx7 O;z,e]GU~Xm__mZ5 LDDDDdqHΔLQ4l^<@~谶82I)EtP2a:,"rm`nUA VV*C̨h-o꽻JqLLDqLWFI}hcɫ/8 ەMKnN`L(\?8{xFqǾ~8> >Xr~aEDDDMLLY u8|I6 ! _~'*}M1HC3ŀ}ΎBڮ1i[jUZ ,/urj;Vox>eq5Ԡr&h"g"gG>h'W
j F O~ sk~& ,ygPRvGp]] v?Y=فd߽pko g"g8ș(nib~Kф x+ ˞/^PkC|
B#ٜƏE3QP;$ !9u3S=_+)˹qޒ=P@ g"g"g"ge bnW j k{dKuɮgv ,
M4qHZdCh@ ~[q_vܿlC);W%g8A)ϽXA7oX6e
ʏ3T73$ë~ocgx| _|r&r&r&V9f^UqL\yW3/2 \9+z$1Uln[NgfU=` Ħ]/
^Z:xW~ú333 DDΔxu&?}N5 ؾ:V_ɏde>qC SNး{o~
S]qq79Jəhș2} *N$gB{
@\ 2q~Skώ UoZnZJbRq/`pDwcU
M?zg m"g"șșș2?O/ ] OX+}Ov[? 0c#BdسhJT.y`= \}K7vNs)"șșFsT($8jKfó= D+<, d c<'AGBck!`[՚`yp9s3t?>s4(nI>hT v?趹~`{9 Bvh.hw;$3 |p39{-9S!g"gLSǓ3ɓmoc jox zӼW
40nxZ}5ayw yy 6-zLǴ@99
3338Rin+T
[\R0;^JQyjAy,YSL
|U V;0gGP\WP]/7~3Q 9
89&
LxjޱZ@ Vr@|P9&.x[3T&7%χ!%~>XT!\k 9t~>9
33Q܀<^6:2ܐZb>V C"nCLܮ%`eX4p/HHÝQOawoA>\ڰThr&m3Ѩ4WUCiwh Pq1P{YCD`1īK43
y뽧 |)(; _EMLLL70~PGeiwj3
EWDS*$)Xz
,
zMϹhdssn.sk\xh
|9999lC $^ra $.Hp G6N ss@FMy4!Oy˥ow33Q 999S;Ъd?}sND5'y`K Vcu2$X2P^ CBCnȇ5cS+r&r& gg7@';V}WwCb ,,Fi
;k{{+
3o; "g&r&r&j3 u8SWDpb,$[dFX=0TkYCD}s' )QDș()-Wm,,ۿ^1
8.Cz惈r+"0}酮FcF'`$Z+_w.h"g"g&r&r\T4W \۰_o :Z_WD
wGǹwjyJe=Aŵ{7 DpJ9899MW%$
O: ,ԕ)5흨ؒa F Zxa힝Vcg"g9E43ɗ A Fm!joK8 {@TmdV҃{jHK + 09ђbmO_9qg"g"g"gr&V O0+< "M 8VG
~ !'g`M .qi ǵ brQN욆c-ə(F7@$Yu:(e;xCs- ^UĊ
F@ ,9999h3ُ+kj5v
8w gktG>tS"۳A`l.(V8>m"g"g 9D$j3ٯWL@ف ,`. g
k
CkVՑMCa9
Ыsי˦=ggΉ] %
ׅ@C͕ cl4 txayT %8lEXp9VL>tRr&r&r&rQm;7ХVu*Ղ )һh!?
a5"lNi~{c,r& g&r&rn'Ri>Y!pьKeV^3
mE#}Hq7LNDe* /,XVh1 ue l@t&@.øSy^r&rԠ&r&r&Z/SǼQW-9x|$e,
Y¹` `%5w/`*&r&r&RXնaԹL,`Jm , G,$q 0lH Q?=\]7@DD4:*@4 ^QLV vkg~fyæ~șh)cʙЌW8"DBfyDj-"0 Hq4#g 9Sz ǁ3a#B yLe ;8WjecXi \*P4șșGd\Ӡc% PA VbE8 ,Js$8ց2@r&r&r&r&49xWXHr ޢ$Lle. ,#,X `ULLDDDΔ*NhoQeRH3H ,\iz bk 㕲;PLCCqL 9SJ7:}t$G,wwd*>/# |zp>pDHDMLLLLF QqEPH&:XG[ ,Cɀ`,SX4ajP!NԈ&ϑ3Q 9HΔ*%g*w^H{˧K
#Bd&
aq
"А33Q 9SZLc1eElC}
f/ AÐ
!9MDM7@qL){:Z=wG +9rl=ꀱK LYp'g"g&r&Zi"gJmp&{@Lz}~\\tց "^P}'rh1j_Rəș[^*vFa VF*
9q!f$Õp ,0ݑmSəșșșșșR
8vIi rKHA 56xD=,
0GaaR̈\f b'o醳_HM^FDq7@4"TꮘRLO3LR_p
L(eÈn&\0Mc
qiM\&r&r&r&r&XN,1LN9$Xk)N ϫB
| CTZY`o2@}NqL7@D$SNg:eւo照'ud* c uPDCv Z{ꐜ"(n 'teGhCi썄kak@ zcW? mPl
i4" nڜi2ur&h"g"g:IPN~oqeMlP
}jYRUlT a(RT {_5\LDDq7 k*AgmLA*7/Z~Rn:XY aHK9XV惵HdGoPE@gG# 33㠶j3_)3g bG;ι T)3guKpO+Y[i"g5p 8 0}θΘԎECEƤ*߬Pr&*@$ 44g0"{dB*zI
KS^3B#g"gP9pA-8Ю
S0p{&={*SL'jVHu#(=\ 8 pG #tFdMbhBn^kZug<̊mwܹl"m";3N$3IydAӂ)L۽,ZEqzU\eǝ {bgEsw| d{: #.ْd 콬H T!&^zMd*G{? l6h ¢V W ?:FEg7Ғk2ge3CL$3
h~Lp^7uo<#G!]%{uV#X8<#X:@M|)eYD()ɲĐ2z4O>2!DASv[f
}2Nz jU%#P7
2g欋'|bO.y5F5!GU*!$I2SB)#ɎT<1cqQtkmYLσ%,5>"1+;c N ved&Ѫ!PIŧcSW c
.{T!'v62dǎBr Qg ,B0"chP";#pg7/]v ]YyDfrmLoEoHN`lRmHf&)/
WqlM]0+9mA_\!x T;fN `aX2T"cePw4OEL2 t Z=vRI;]A /q ]LKgM =+0 EGn%ϗX/zdz@Ԫ('~ënj CmoU۵2i*骃:lERŗ \:#Jfk.̲i%
͝d2 o.yyN.!]DJ i M v%fx @ہEgz M_^
) `koyo,hPm(K4Pd9 e0Svt80^_$ ! qՄT Kd̲6,pLCm ɩfL SkS˞w!~pz56 }?-ousO(ʪ1y([OL$bG|W]8 hjvONGnO\DYI2dBL[M,.i+K`kە|
ˏn z04<f C6ޗ0GgF+]W[.AcO+ ,O s`ol^qiw d&L[2JZ[ _{4/;a]4`MlL` J`
Ȍca?<pD26[Pw\I d>i19oT_;}E(Bº` 1#XM`Dk v!.ͯtw?s6T BU~};e/?}dW>/KKf4zi SpU
7ڎ_jֻ/X7sN&ȱ
I &. .`9 Fp8lXU <44U OvH
]vԮ {mO bʎUόV@ = ^#~$q7% ";/1FV1oA헿,cǗv[_T 믽mjxA1,$) fJݎ-\;sAB
j$k
RlY @QG!3I
Cuw.%?! hC?i|:T|OO8zDeg: k/T)RP̰"b]} G8{J>7wVut1d&Lÿ(^[sdစ Y n/vV}G*MnPBJ?Tg۫,ZSvGj#yaJfe5[`aIE
3S3 _$n }m:9qD[(;b F@APǣPmGP֛MV5!M[M9G@ij$N}_
dmd%
4l ؒh|0: ,&d$3O-OJLJ*yGOGl8 .vXc.'=6 `1h(g8Nbp
Kqt\2ΌߡpYD '$f[{ogF vy'4sNo q [
Tn̘O}vOJY՝gl#`هwx~4f$ߥRF3J1ہnZ? tmw\ʿ.ѣEIƠ1,');'~~IȰf2s˷M/N;Nt:WW!
* }Q y˝0&M btXt̵{㌅p.-Ď-Sa >mBO a8Ox;G,7 5
dLX=o?jXVa d Ӭ6;Z kpKA]d
SiNO`,V.we
i_ G>3IyٔI+
8 tqۉ#HN3qHBhe_8L
dawHfdr[h;w~x_3sOLq([C$瞳j `2
v04!J {U]tG _ ;uQ?[2~3}
ڠ2 f% Av~ɳ-ܠxbR&=r
=>" Dx=1U77nwׄ2@}[vyxYgPש>r{LC^$6F ,53ws:^n W V~:_áv$1A)=\yYn;WdR/g 1FOD/
xL,|ܠϵ8zeI2w
4/^M\̔Nl4 } b);CC ´ w @XWg`|<}$3)tQś
! |4uͶw*ZPIɰ"XD @`\1|%Yy-; (CH.er < L$3Y}bQپk sdgf'?:I^_7GKTs #u m6ďgEr!adԿ$ͳhʋvޟ!uo{u PPiw֖nf_ґ w0"R=_ &JO ttpAoҳ>o QG@T2`eWj3뎮N s-|^ѮO "#
f]v:#;GSZ2LIsS l 7?7+!q nOIʐNBJRX-4
.._sRÈyvL}8 --3Ud&*M_,Wd)Ř#,\]sCnQ4 <-|vKq[I;/my4)´KkՔ ľ3y9's"=V"x1hC"<9hsOK.j^& XA 5a%-";K { [^A,܋k
<avD㰓gkNur 1:'i_VdM؆ϭy4 / {IXGsۮ] yǴזX8Pq(fp+XQ Yc!3IfJ):I2|KD5 xd}vIWm m`QY
7*o ,?̑PɝQ $h
[2U
@sS̐4ߥa͊½YuШ@<Imt+2$ %4J Ϳe 1Ig,ټiVo^|?ǵG `g PU=>bSBNss՚[ޙ$BE&(F,2 (K`*R[
&Mi9zhlYa/=h[08w]mc}a͍ĕaLde RF3>= ?9uǝ 1*_R!ji~*VӚ\os1<"XgYD;ݨ;!q7]W,CMI
3k QW "7i;ܠv=DJmL `2= 'v 5=XUR% y?*;k憶h d˫mW .$I2^hT2Νw|~[1ZԺXޅ̮m S'քCl_]*Sm _rpWLR73T {:,W m=q@Aԁ]:A-:cb\o{kVD`%y ĹZ}gJd4 l6\mSqS\s v2&l\4'+?KxLXRC[!A{[w/~t{$8Jfyw)?D~F BIY4i'DXDx_ h i3 q#D灀}BMnXĺ
)j+8[{mY|g$B&i`M2p*U7 Wpttu} X {qtz 6O0V Kܬ- n @ \)42jq4ycT(щVH1lf aD ZӺ!w& ͡eX!MqW.:GVoEsPdۆ12LiKfJPDALIۿti5ؿTk2ßc 35=Sq;3+XgCw{E*u9 tB'wLͨ/ʪFDzp$`|bq V/~j)LH*}˃ c4qrM FT)am
Kߋ B Xs?%3]&L+;km_Zoۭ_v-Cdu `1.b(CSNpkzF y*" \Kpb|3cj =D" }QvSl!y &\*9=xL% 2M'Mn; (?h[Կ?`p #MR.k(()ۧέZ}7 {s 8qBSLPg# &/L,?xp %Zj;ѯuw͢OH
5gD8(bT~2uݢ {ʪ@8WD`h"X 1#BS7 :PJ1bZQnV"RjZymȝ9JJ4IfYwV ̩9!Ct+B/ɪ`
q=aA i^H6)wI|w dY DF*/|3_Ն֡)&hA{` 8 NDC^RL%7M~BX?-.` Λ&;o%kc0$3it&X/::[-T# Ο{w+
¦*XJX W cFךZ`Fl]ʘ
_6 ^Ù$3܃"tL ,_n&1(&>/|z2A#%LĄu;32]Q| u"X .v0d&L)ǩ@3sv|-W|h>=9O =q*S4`;es*`Ek謼~𪐡$3
d0Ү `m?%^XHHS kL5,5C1#Y3 )d1 ɋ zV:y+Ld!N̔yo.zh|oKK"Mgme ٳ0L6W.p3~ncuz S$3acs"Vm0=E 0%.j3 $Lt"1)(ę3FSg4~o,zx^c^oDaY3@Q)0&I2SfHfwNs{&,AbMuv4 p.$CMRTAL6g[ӘoDE
sZG" ~!i:.9x{~ ,WVzPQ۳2|Ak0 j|Kʠ_XN (n*&@)B7Y4(HMfrS5e[BqR FYCcK_H̔)cn97jo'qlx~sf}JmIJ{/ z0uhK wdgw-u?l2@ȁ Ae#Rv ꠟ(½6 qk eҺ a`1c;
>n~T3DfաS^G\4IfJY(P2L\OXtOFtA~S?|rB`iy=|fvhzkPAY ^ QOe+=xBLa6"Sdv^ P0ȒQ@i EMz '5-Ӈ($x֜ ?"Z{2@
z&d& 4Ct?f:3v:Ua}k}_nRX{&@j8XcC^n닳w )Wfgcj/fSO1MKUs M |&ׇ^ FI|J>@]j qOxjnO"d$3P$3
,ޗf4TGtX`nY)+/vͷ K`+PZMHAeyS^mFd
gR}^=yJfA
vY}B~+kx ehR\'!>1@Jlrr=dq1Q
E<-wcgܤ.fd1ݝW3*#:ܨ?Yزp9쭟}q&MR Cu1 !T +/vnp(2
)^f$䦎@~΅[")S;y6 PWC
4%M2Hf<
7\{xY}8ҷ/ 5i%uyߍ_~,mQ++{* ͟oufaOB)j d,{SQS`NDI0Pk( \>Ǝ`% g jIEYپ`j6PKZ@ w $]I2L*qõ߾уUu0U^(ܱgj^æɧ6WP/N{ό^q
r&UZrSd|)~'D cDY:$S BA Cm"f3ijmɲ?`/l]mHp$h$e
plJ`t89?zѽwm_V{]A[ p} xJmp|D~1Gjxr*w y
%o YB.̘`3m166zL, He% v @VFCDMHrr}DV >O S e2U:r@!;߾;>+uN(l{g JEmmE^gCDA8kY -$3
OlA
,4Dl*"X ʴ.Dd7S }%{&58z1Âl]<$i24$K)
U;ߙ-z7B] Y~
{-u }Z Xi.>y쌖[h M ސ˕3|\R|A(iH
lD,Ia")@d4Xz-[(ÂC:
X ɴR?iD6Of& \HQUϸIOM'?H}/7VqQl|:U=Yd& c]~33M~v;
w l̔~E[7Zv@ A2z` ydbrZ3(joHe&)i`ȭR'lⴟ/p)7!Pױ^*
WGΧ胤̙ Ucܧ@x4]**^=P ̔Zm>#52$pݢhM wz FD +c-W^ $I"fKwO[םU+skBE|Jw[s$n5tGbv%:c^F ̼ &>:Dk) f̔A! [@!Pl)I.HR$kJB00gtWņI2`d#RO0x7~67?nC!lb7;7C$&zy'yYo bW> s1#oͮ桋Ovf ̔AFdIXHnceG\<$W>H a <
c?TBCwʨ(?8 ^>-08 %iS2j -=6ߕM VQ@-PeݜqR9x+k k{ %3
Y8tBô 'r#]f,Գp)C[c-`״i$I2S>0[#_mȭq';Jo92o!lǥg 6|?/"ȭkfk*~{2`>0 cwGcO~}vK/? ޑ,K Ε^-\x3ZzG \2S_"`
!xN%q<@5Y<-i a)BuN֦nj6Dt3Kf'5FNMұor0QVW}Q*ۘ~͕tVz Y 4LRiX,2B&VAL@?
pQ=brBhi#@$`fJL*a:\wc|pa myw: ۶ ^= #C-5NU+~\Q'>])k ]
<5&l#d4X,p1xP+Qڸx (h IIco'_4CDÕ qD3d "@Y1 G^& L |0ݓzM{yWoxqⳐawI6r! ǒJ
}mJL0v@v >8̔(N|z.Zψ!Um n@Ġ@!LfNLAb`tB@C ( @k,щKhv#3%3IfJ6
Ió8ٴ}sŕc~8kf ȃ/6x_'Ztq_7£ΣD234 U]o.䋀[QXXPPTTU(gAΙIDeL 0d£b懱,Tgl9YN☏| Cz6`!NT*bӝK8 bܓpv 51$QdEȂ( Ù$37
Jfƥ哫rđ ܳ3$~R /δ1яn>97u 1iǴL2EME`3y1DOt6#I=v ?]e.:6h_),I2IrTC|[Lv)@ɥi Z*X㈙1 Qs+DDyuN3¦ީ2BO&L? ?vV *y}o'=U0 it?g}z6dl|nU/ A+_ R*) * sn̤AjzA``Dsʙit-Vl ]^,Ɖ _ .zf&L?EG3l{ߩ,&Ǻ_x˳[z7^u0֪?&JKJŋs3c2/G˘K59fr43]庥Z/gpbsA( 8.OETk
E~͇n٘t#Fiw Tz@ mt]
6f Lm'?_ >~{[w3+71B! ,iƚ[ShIg6әI9[~%l! ̎/0<@!mqh_u5"]VGVyopR]t7jfB3
U7mgۗ=}s[]Ayʃ⇳Nlf[#=[k |rn,%#ZZJgX1-) ņ$MLڼ^'si#ݾ(hvOJ Is$ 2CA
hfZy-ў(h+p -_x%YBA20|i }0Z pK&L tqsܞo'ypٖF;Q2*E'j#tu1H8@>8{6+)D8 \CivE̤I3S!) n49<{~ XW(az!4 a-ii?CW
(n&UK)>6h?QfXF+?fâҸAj gbd'eԒș6Vq] sG89xf*61pt3if Ċ4B[^4&g =84i43-Q.ReM͍x!XJ].w$ {L`u!)BUFU0 (+*O& h_QZLK3S [m8fVݽ&8C ] M?j
[nIyIeg3%Y8Y8#ULYX#I~L.\I5vIep`52fUW&VFqZ6Iy?Xh3(|֘E lgfLvK zU)җ2X d\ ``AFEIlLNR`w3VFehMVL2#J3{DS)p\jf̴3-` hv?ۉrBufD0&e0 N$qLdPs bkZs
w @
f` CFw9roJ ~)%B-̴hb.wܔgsw$ߩ$0=1V1RȄoΜE&Z6f*hc=)+2s\7MMӔ պKWx\szT+VÀ[3St6"C54 s{C~YJT؈X43ifZ*̓Wsy]qGg%vL@| <Sv$\&e
h@mTj2ƉAXL@JxX%Xhi7 1&# M9NxGx#1O!]F5qB6`rq^[ַk# {k31+۔ K d?e=aI3Q,kn32`X̤-
BR;ʹx AI3S##]k/6~H4B vfsfI5`MŎV $c*IHb.tS}937 " lOnFsDdgK_rl::uΝ Ldr ]ߝ0qF묩5 -E6{n h',F9m7 /iٱ&W63M+.7 )] y3[vHʼn"-݃mЇDJeCp֘bJ_ښkdi$_r2S!43`y#raa &+S[dtD|TO`B }ciQoM^a6kق DxmgA+\ѽ煝{l/gfbHDžijP`m Hj3b(d?{s 0UL|Z
k F`
|@jk_lhQW
b%Wlpgo &tMF̴C92qpyP=}gfa[%1UȚcZwj9#wQ#*;9Ej|ҷ
hzA0g8b%X4)928>`_wmT_zܧPqP(V]ט+ Ux¼U"@`h ãȀ
D.i92;[q4aF ${;5Ƙw
Âsbʱ5%L!GmCf Jn2c'j@OMrj1P=6 .iƮBf27KJj
1
깾Λ+|0 "JHľM9 kcDT]PO*5ȪA`އ1}sdYA::NOR{/?;;qΩH.Lô0iq4ax&k0 .L.j#D2 A!` nHbf vڵ-N~^3fu'9:o}ϏXtϟK7wvp/m`%ZL;ޗLA! ,PcS.T7-6>y"):?/
y=5[ 'R-][*VCho_y^:Wj/LƷw W3f%xtFǹɃr/3x*J`- E3=1zf5 ' 5;Yp%Xl{y[ sӟDc@hd {R5?dl\K0@7bP/w:scJ&!K>O[^6T 6T>n;_L.OVeP*b!
/S¤`s8*aF536Gr[nԽnȻhfRI3'go(W{g źg*tZlsE N&pb];
VҨu7lp] rnX)F@u
7mcbso\2O B" 8?a
DY~JE&
DŊSuf&u BP38qd}bnhײnf2g]2Owúo$,UBց̭3v&FޫEczejs
RD(A_ԤM s6j8GOvMvJgs*j\u(10P`ITc2y ^IZg'+0euktfMTqb8
c)O'Ή43]C{ bxi'tWק$ɛҥt[t -^ R '`IW7J@rZ?9fZ>e}6֓jdy
@݇zxkL#iŵF<>}lϏ33y>}b6wf'ykp3ygDa)ц)XJV`- rW6 nt\K6l(`&S b>P|ƻ3y $0ЇE;BX.e(FE[do32nbI,m7iyVUHSM| p潩ާf \-M(1g8OC}E}r G+U/4:ݬbGiu\#n]6uC:f
XCB|؏\kҦwrMEL +e K@pn@ݕ: YuܹJ]:V|C6fMsv)qTm7zK|=_ ʥN(~>\1_!*9NMfJ:v&Οʼn
D=BLVGj6I |fy;⾃FY
)ӊ&LO
)^ ͩ4
lE
M? P ,nlavLkbݑQED ,"fM8hf̴C^Rb};qAq`'}V%'{ x|˖z숟{nf71cELH;"]wQ%1|m `٬_):7
sa<
x> ȏT}4|IJ6 m(30$#T H"r4GZs5[
D53O' LR) Ɖ]}1 ]?.THz`#} smņjgZ!XpZ
dǏs{4漲ҭ at\_m#/TB B 'OF+FhZ(0c*"՝+f}R^}ζ}8-T?V^]Z #\^fja
jB-hVw*DXpt)#k T6u'ɷgk+RMїꒁkWSi
,: 6LTl 8H&=By(%ŤW>շP(rGbp70]FBujF0 ?V@Q,T{_,@= w_ݼ8 )j]LbOEK݃?XcRD(p/Dh@cqOoũБ` V3i&Ǖ'Dڼ
0hL{^"䁁|n[kXz;;M\cs{Sw'G~Vܺ(2,Í> E* |~ *O] 2IL/YGڂ;^Qȏ$
Q =),B0gD ʇ%],V ` V3i&ץ3$ hf z]i M&9=btӽ78mY0 O~cnwOu ,\P$8Z5;_p_ `Ϩ!f> b+sqYM-R"N`z|x
L
&P
5 %s6$ I
mѤ43]K ӥn ̾!=o3O=3qnIkkBxe 2f\]4.40,i`2-9rxhl4)o7{Wi17G}?̈́~ \!)Hfr(;@0Dꉔ":І#J`ބ"@E;(TF*S`SO|V(U!f&m743]gzŬ)$?85S ?7tJ#ԉյ1\]\Ș^DWBm 4qCB;EQ ɏA
sx u. 0
5 cAP ?T#$_#ErrPolRudgD'4̴o`3Sā:5v'
qK]k|jD*WԍCc''i6xGm`\FAU H " 3plc¹{wWn>@謢0Лb&^ "0Rl8[+jA_ f L0jAm^c͕ngN*C`It Mf&jZ>fޠpl\xm04v BiZIZO}4N^oOZg pcK[ uj+jjuxVG!%@f{kҲ:葎h
`C И0A
('Fc<)m;3Uee` V \[4A[4-t}\JéhҞnj ;VU$gsg ?s4ޖ>5cH0kӪV=j| 5$DK?溜ú? raZ/жw@OҲW;
s
EB ?H!< tCdѥ``2.l-&x4>Z[͕5j b3hR' \3>NٳQ4 f' Lzm~~\(gdX2a m-E`^֨%sQ<ܮR
{A9 䌄( v[egmd<:ɴI`Q% )ݰB~7C0_60$,1# 9TSX]̤-vs_s=437ᱻhp 5/Wf]xޞOenp^szrffjgv.R4{_s?_)Eed|u8.C#R%D#e @`,5O
"K#O0eOwBHI/Օ֒ژI
o}Ϗ ;T
᫂7ff43-?3 _ZSTU%iyϝ|3ĺ-u\ _FXJ{;yh3l sOdSl ;[FwBۦStFP" 䈅O^?"
J
"$#>( ~@WLcbLkK *hv>Վ3sW9ѤxQdZQs>3(*5}{3\Y ((kV9µ[#
; γFq+ `Jq7yw\H._ D8** AZf% 4G S jŒ#eR}X6` -݀f&L+%^CO2h7~%Omn^x!bY0v õ07;g6KJ ν՝P[1VpE^_yL LG䙸hp7 ,FaUPP0hY)GBޫUZ)@ 1j;ILM-5LESg43E |]C/p*VK5_:t^tu2{Kԡ[ڬz e;E-ZpSWw;uisɭ{#W
e gm@wL9],6b QgJ$:N`h_[t;+A I
W,H2#iI@ e7I43if>g[벯b0ܗ9Z)ZJO>恿 n`0u{] U
6`'j Xr]ts\y\ڕҲg?M(lє.N!>*xFb[ #0L`!AmA@`
b =eHZB #IڢI3fuI)ES.ǺNNzw{r7> {÷4\(kuݟy8ԝ
m&vϼYV4aUS!G
LFfQ_+
Vyr<{_e W,NJ yRn3#0ٵ>H! -B(P[|TY
Z݀w63Eo]s9唂k'jd _;p߁' {T79Gֹ2
Hn7kwj)CWH~+Ζ OQ %ƠpPm'Ps
X7[#V'GG[6z u@P E4t*3ifҩ&Lg҆}bf53p^̚-oO Fړ ^kG6bW3KFo٪\ ' 1v9O~wjɄed ZAHjUj{h_NV6~V-ↄ UwёBhhf̤}[K2& CxC6ng.է 5F=>
yG1Chîw!ЎLFi>d@C}g, q g,ozLs9)z2`Rn`JPz]E`T~8}nPDF%B<%̰]c 1E34if̤)z|i cX}˨2,`]Hevīɋ
H/SeW4%չ)X;Y`wf<]D =rsb%.|cM,9{GD潷֥VZ;Y$ a@^]_d,eghPѩgo͙kJsa.'-O/.̻^w
!.~W1mf4RDdш"S R>TPd9QH 4ʦMe`)M 4 h٭ %rrf.۰1Enw{3AG:{P!#+oC
x:T{ v>
;NV/5l\f~~jv) Iن̔`̹
,i%%*>iQd BGȨ\JV!0Xmk `"̙)grfH?zV>pG
NyEK
Dz]zү}u .ftxO2!+zg7`~
إ%OD u7/; ̿T=z|]ZVG΅m5P$?1iH0 ٦E.l#Xbd1=#P` sfrfZtljf֔zzz
g~the zMD e~0o =C7IYOye;|uA!##m]sC&fy7/SW>Zw
})"ҟ2D,Y2 {9"i`3QL)Ҩ0$! c $c8fʙ)g<)giԼgw_~ٳk6s KO^߲fh}Ֆ Wqvi3SI*D9 !H7t3 d~ɽ
qV̔}PE'0(kT#%E1!R9" H[oPV7# ` _ fʙ)hʙ)gn?t|pI'0Ћ]jF|
nٳH,{|u +|0F,⌇&,+JjUs}ŦV+Ι`il.u[hOf~DB7/YeK7Y38sO) Â2ltL93ewVVl5/ @ z{sľcΏ86 ECWmzx<Ƅ=* T]Tb<,ثo~{`J]¿O'?h)%Lg Ime,̃Ș:>Ȓ& ڲy/8u[2>,d.73SL93-6uX@G X{ʊJ# 麽w11ݧhPxʩ- _
>wEhT<$5]]߾zMauёuu̔c^BX粈$ &sp-H 2 :f5E=.J ,
1NZ(Aw\n O̔3SdmYKb?U;
y[Ϻ>0wz 1=
[ ꑗsC)ż*g^IHۡ5 ރ|p/ ƹEk :ȸy{F`{UkWc"@#e_s >/ iLH. 9 G+8Rr{ThT!Qp! F_Cu\>.;䬗 @%g /x9-p[o1ա^_=9f˟>t'>.)h`>ʕSM&ŰPj , 9#eY~|\n m̔3SLռҎg;zkj;N[>?.Դu? 8T')\ X 8C]y:'5+, z]w7
E~ug]B,ZE+s%e TB>y?8ew[Gz(a d٢6$6Q./D@(X93r93[rfb GN7nM{& :[N9xO6]~q϶^.#SǛ,c출 t&luׄJ_e_5*8ɹϿG: Ц̔` IyM ` nLq,#
,,Ab19XR t` ֗̔3Su)ښU~xî#'Fݷ y㫻οs} ]e0BH & APG`diRࠠem\tѧ ytH' ?t!^{;/fB{SJՅe|md b 0q e2@e^, MӋǴ EجT 3SL93̔ |bC!)ϸg8v˶vs6`+OVL6 o{~mvӊm«$]):02 ޞ8=!k!Mk-ڄ<ގ'9X=H 93̔
vش%^!>?kӓ/4m0
_ʹ$K. mf~Q
h
Bɶu:yְn;v$Re6cUY " o|&08^@I E̔3S.73S{e&b`V_^&|I *#ΠtLB 4B OEVBg}t\]]Ũye#Fq^7/3$O;"AP8"#C:EL ^GHeBAܐ93e93̔3Ӣ$glp )+ V `%P̛VXAxR%
EqKn!ٰ6#+S0Q漘 ő
SMMfJo#}
) X%crdtʾN3Srfrfj[
.s9Rspp%#Oeqn!tQBqJ= 3x"+MH@K|k`4Dff: k\`ǃ4C_d 4o&eleQMB`Zr9+rrfش3ܽQg2SL C]ǬU$ AL_A*1_ۭ8)Π_y^ ur]d4=[
e Zf"cd~y_否r&QrD˝pT_U?Vu'/P u.g݊EĘ2KK'O! G.t8螬
pڞǴ}eÌLBs*1KԺߐ`@K/#Z ,ܰ^2b-ж չ̔3S.7 ޢ rRXE 177ƫxq5:3ynr*cV*3!t8G;s2M}J! Q @
L#/ae@a1D
0 }:B]#%z aS.SE8 Oc?`Pr W͍q,9p qNK &l"jfʙ)b8Ԫ
^i 0ĸ f6^E W< .:02i2Lz)Fв] QL':WtBD8!C>>DG^+ aZń_c+K93rݮvz
J3nYC#ub1Ȇe]%W L!(%#Y~]*
p;c%Fz|rV:!̔K4(nWLa"
̯#bw_rD$bܚDM zjvjw EŦN vw3zɲA0P˭Cݔ k*\veG h4a4AM` M/}Go]0Aӑ;(3NKkS
+EI{A+a Zk!S{\ EH#/;~U4!b]! ң?,Srf:
u; L1}【Чؾa6'DK)qTn"ld뗕*~PT ԑRpYa446sRDJ0u Soo" eM3r50ng
aj1Q }-2b|"NDz04j
%"2 5/"-f-+ %^:Pn%߽c@U[S1 1.)َgCyՠxV̴#VpGD&#~"ˌ5ny6P#aK~3SGJeWã#A+&Ac?1{LS`Խk~\^uOd2f´iYFdxBZ!fu([:;B=hA79FXfFfMH:, %=8,~S e ّrE9hm14 0 h`ً~Aa7;?J;+ɩ]uIG D4SXA bu% ` ꩺ:]et]O
4aA;KɅn;GFu }C =݁9/fo@f^ҭVVV+d@I`ce!L (2_dBÉ@ܾ&))5b)rI4Ղ#w ?{Ċ.\!T |XmkD lV *#q8
;S
({
B),
6&7b"(ySD7MLrjW䘍*^+p!qU}7G80m@ g9'?rdc9C+6Ԗ :I/ WśYGȔ-uDa3(҉ &h
gVpZ wͬҜ=ºDQ-C. 4o
܌EB /]+ %Q9K_
~rhj`vW^o'3=3{[`oR)e I[V7/3Y熺mMiN=IIa\Eb2@.DW8 ɋ VH xD y my/gEzU}.j!1 I`G˞(gP"UF7>on.f7KQ$o7f<${ax(CX,p42{ X1| P6(d
08F1
i
$%ڷTvwOx\;ҭVcy!dJL_YQ շm XE)
E9l |cș)˸(K{ Y9]Hd5̓ `AB D-){@tcI7=Nzp1E _=?{ ,UfJ DaʄA`ɬ Ė٘e"02¡M7X8R._ sфj0s^a,h8$vo}ǡXɝ-i HԽCJf{mjrUzlpE'/~n}+K4)˒ ⚜2 %G .y$!`HbBAYc %bG&3ӉW|e7.[ um{G-;Jp)Ѫ>&1H=)Cl3ւp JH`Ѡ"\N`vF4 5`3閡hjZ:r/= i0s()$\x~}21:6ҫ8cTZ>Q t){zș) ak f3[VCf=Ц)H#ʙ3~Kop\D_\8TEPe122:Ǝ(D37+>2:`,B`S֦eZl9llG;iĔ>mK)8˨kH4xmw5ZMVլ9hM~du \TS(&-a,(|L̴ û [iH Hqڛ#4~@
SP[0}Ԏ7GD~ugw[~GH3#KX=\i"
%q.$ ,AB03a e拘N`V K躍 {ahZ-!
v-!'Cl|5
[52:.DĦ,ȁ R%8S &|?`(BVA*|Y
Ȑ 2䦦ET# ?k ?=
\̑{ouW~ w
`\6!,Pq$hW b\ɹˈ{5`x}=r8Mhu,0k~Rd]8x+Z !IM]% + c6jՑc
ZDF~LUsW rH!}ş/= .:ѫ\>C۽z(Ȱ:,5,ab_q+,f~L e;]̏)T8X: lH"~
L8f!¬`EG]aKBnP^|[.=3'ɹV+ T}="2oi Vx)ڞcN ÁÁS#CdYׄyr xkAW93-D?;` i D Xfʨw=Z=+aH TD
BwJx?n vs0Ǐ]`٪gmf9YS=EEKBioHE9|%g xqǦ P V3)%- fn #"2;@ m}*م3#Zu6}s^u|RŊk|廸K (;<=(dWHB `U/LH#
e~.f $1ۙծYj4=?fI_#@kMDW6^(SWxGƹpZcr9cCpX!ٔӷ2QN&Lh:Si^{~$Bg|MR3cJWg٢"5/c u*"I>AFW8j#D&j&aϟXxȖJr,X-bPOp,- 6ͷ l4.'lhTt`ClD !b]FW'34Y!= t\\,R<^P@(u{mMp؝]ƅ8ڷ\hf:SFbJx0m҆81_4Ze<
cu`#z,7 ƙh/E$W!ZˎS3 {u Ų ^O
X.70Q߽c?tޞ$f{ ٪7w<:/ˎkBst (C(
È1LFl"[X`5kC_$o-Bf\n^ >vh Knz{/N3SGeB>8<9IQ B`%#QDWԀJ 99Ez>
OS]/&D{c
⨖:Ml_X̜*/ZWfRfI$͔}ɰ4Ʉ XdZ $xDWT(g,9ӂ: /xbѲ,FWl SF,9fڬTmvywe 6f(k6ڸIK4=[Oa38]/ZƏ9IJ%2*8?62m9z߇^Y(gGv%+o,t:3e;V
8 "$ɟXu$kFh +Td=8@`[Ѕh n=
XKR{x'P*b3zvŇ"Vg'ombmϜcV8$%LpĭcuՐ?fX'E93<XHXW5Db̶@=c: M0@0D 2-Nj=T
$
KL U!26%ǺV VI4m:Gw&4ko<G}k.b>.nM"aVn\潩ݘ){O{[ #xr10 5##WK4%`[bۯ|rosSӎM'%k
4Cabmc3 !V.V6zLH-ܜj
a
Ku$=5Z@9~LluW i٭g
+&{y TA54sNu'+\
o8kWh+f~ oXED sE\)* v. [?poB3-';0Vۼ<4]5GZSV'B^(`4
±&2d.0k4l&,dJ2)|Nhnkӛy \[qDɕ]s_O +d=s{￨uW ]~}JQSXΏyqpQpCAwБnXtB-I)l2r
O})J1F XdZ"'ੁhb1UVfT?lQbXw+BWo2<ƫځzN̤])"6=Ϡ)a2"-a Vo9Q}0 ud u; kz@I4o ^P%(ͻ^z)>1/.?wuIv# |d1O_S4j 8BH,|:y
i~T 0Y
qc[0V8AU`p
ȺyO93- *P ZB3Sэج9VH&K
8SuGuJ"s7ʊ7cN0Ȃ%A`e2tYu:,Шn"8V
MQi" V{H4-~ݏߵonY;sYɤyl~STDh*5_k GdDf:Ua6 R&/
Ⱦ9bLQLm 093e4PԠъ Ѫ?^
T n&391yRp,Փ܀I'A Cjq(B GEl E~!]gvVt%8!_VgH4w?t-y3?ooyc |↯N1E;7jB c !paM5=fG =DG"?b0wb"l84 ?rB31ʙ&gLD}jrD&IT#vKY$lՂf闛EWbVQDc2-^ Af C]PcF8&q߇_~> 'O֮U;yȦ_#X*t]>n L'3e?F+h 2CiPK T ؤP'U"v剗X<rWi;y<ڬUiMW |E~3+63#N*f0E+.$A YtnQz@G0I?WVnXuɜV}Łʝ\0X/Uz6 { U._o_̔=D TUQ(( 0q4n[y5
F/v8?b1{() Xd,b<ҞM93(|5^Y{a#2G$f
Zt9 XX*DS?W^4&D"4 t#Xh1ګ-mb`hĠ`0ST)`
W% !80 a34o5*u_l姵 uOXX;@SxcQ*<%4{74xHG >uko녞s>l'sͶ]M/Yz^^ 81{dMʐ3֦Yqt ӷ`w"<鲌
Y]CLDl{]P#` c0b$zirsKrfʙ)5_MS
l` ~ނ q8C]8A;,1wWf, ={ۦ(~FiS4J*̔PD{Gj;T n1&hB72 $ CTH pHO'Hc<)g7m=H
Sa #5iU:.Y&}(?˿Ќ qGDU(y^e+>`i 7Q2Xw$[`,4!M 0-˰iShFqE%5/qG
a93̔_SMQ"FlWeMK l%'7ੱBQ~pbaiw r3$aX=ڗck%bS['˺xT `CLpz=B^S"Y"2#2<=2 ޱYSmFKqF{z=@oQ- 93̔3Sv{eW_ˋu3-D"' s&Zi7+ = &xMSdXewW4 FhӦIa(MDP
d 4 wVdlrŚbs:&N`Stf91PYTYpD_rgKEZr?; o<;ŗ̾ҿ뮍r{InXS^^"oGvpGX\>_Yfձm(t9jkTWّ)RMǨ%\l.U!")dAC=g ș)g>Կ$rsNDĉ1#\ILb&iM7e &cuEd1pFӐoͣ 88yYAW 3Su.gv}?G &bý m ɎӃ
/? ިw }Tֵ&jž̖ŒYuΪ+V.8z DShOVj;lA5ɘ 2 (طc>>e`I&3Lhrn?p7,CdǠn f|bpR o=rUգNi户GLǧJsW0̄
L `3LQ#ɀñ"!DĠ8[iQPXgp }tTwxWEI f`&
3L'# Ku큚VI=0y@Ck },YF*Pn; _n f`&o
Ѹ"XIX7pr쮕 \p}Ԙ?e- f`& f@L
x(؊&Q,"c7_s/>({`QEDfJ<`&T4L0"/S+2 '7vz+/m 3n:2UWw fPф f]bi[ _[e9adAoV`D6[fݩ/zØ¡n M0̄&
L!lJFhm5+9CZv&Ze/v^^DfB fP7 3L0SCOmխx?== p't{EΛ 3Li4bW*yϳcS"b[[Aqy.,~gXUbVo9"vwxXiLP3L֬(ؖWahq)#O'$JYϦTʥ'P7 3!3 1~CDR`[ڊmm*woSEF>6oh$1J^erQI
f`& M0z~֥W*/u3'=bKMBX=k&B+K& 1p uL!"K͊"zV? ~YBqVXV} )-#o73#b03L0wTK6DL
Ŷky %ƶ"Ib͔Y&>,dUf-0̄&
L #,̄ "ST[}fx bVD:NMwѽ0̄& f`+FX䧳"I(c[FlHe
6D iPф)v`E$m7k9͘GxlB>0.1 fP3,*Yc[IVP̄8`&a&)vQ`ݣOI ROǶ(R4-& f`&T4L|P$,#JlBI Bld+tua uWtk
1p f4PjH$EMfHì@c`+ZX~W]993Z=tӽ P7)AlLwDŶۊ [<#wJ^Ek~ ﾸmͪs|j`.[[H_Vu53L1 ̄HKBC4ؖ @ϴ*0)`.,2gٛVk{L03L
Sz}) ZM=՛{ݯ%|lKnj!%f#WO_zhQzyw_^[-zUnc&;eҿ'=%an M`&MS"zsD)=*D [j\_'l₭H:V{Z xkKE_ .ö́&N! :U64dT f4/]idџd
ĶGl!M̧ZvgL#
7=x} >9Ϭ-VESPn1>d=izn706,Lh<0̤p-YpIؒUm!l4 Lx#`ГuX |MnڊW78]$J(:,Õ{ :n{
n>fBE̔F
U +жuE/mqHZp1Wqt !dMJp
Soq=?CV |4~NE9?Fn:8v7GuC0SL0"M`{][{t
3 `,rw8P
m[h":&
_MORx{4ѯU -KX8f!`:K;uK.6:ucsVC+Ygjt7NSue' 3 f.a/N
,ˊ4)) eyRy
l! 2r!iI-g>uQ6N5>"YyƜL1O6V{U ;$c >k z mmV xYY1'k/ -?Euʂw*Jpw ITv_emUK1` |wk%ARk/Kp;[|`&D`&MZ/98~Xƴ ycs %Μ03wP<b[X}\DZ6~ =_zm? Gܰԟ&GcUD:4[yX])(M͕on}Бa1sP!G tԵ/T_`RUuq煊=/ϧYp 8̤ yMe>on9j1y{R/Z'g+0oDBl+ 2,j /sgsx'g79F.o+q#
;jKw>yQhmnp =\^fȷr2' e%:]_A *00'LKl`i_G:{u{\ͭ_^rSm y-V[ l֑+mĶ}tvkr9RdQ W+(ֆ?f':L遒 WR`Ig*fgMI]cJ H +s{rFΘ4/ݜ m|4ܿ@зt0gUhnY伐n
8j;ё 2ls6L(ۍU}Q OyF}~TfmϽᎇ]7Q2H3`&)"OufoMRU(0'|o:٪c ]S '1P,3% jO 6Dr?*?
̮Jgϝo
!5e!FŶ[}TZۖ ^O#"L @RU!u(A2$ !bC_5
Os}ŢKW%b[#qXGvQ;k;9L4=0422.L@z e0RN1,EӴlnO&^23S4S4]ێϬ(켉$)I_mS]v ql2RT唃-2%n|Ęxڋa3am;rYy$IB(j[l4i{M^=-Ď%ƞ*E14PX!a{TgR^ )4CQ¦pާ Ii*4ֲSs<{S7Ҽ54Q-ɱ택AH{+ftb҂k9GS?V̈́m-{8z1 ܳiYڶg4Ea(V0E0J,zR7_inXq CzÁC/կh:((nڪCgUS5]MGL否23]`FOn> {q ڳLf4,}RS_<<:8+ A,FC14q tn9Q p e\ܽӭލ͵dg[gU*m!R#1E jy %@bAv>:Z/mmK I1JCs
95ƒ3YM$车[>c4,
#ɪ(CO>7ayɴa{ǡDo۠')MT Z<$ض"H R*'$ ) J70V M M+,*98TY O$l[u9 KWߴsQ^;]Zw /^7}#gwCVf`y ER4ŐpLUEMנHs#0D5ŭٙQ[K=f +<+yu'q\-a3f[9m:W ҇h˧.xbVDxB_p F!EQT5- R9IId% ` OjiyYH@{a-mkڷ"ˊ|,{X6) fl2Ód|2%hc:JL/[4SbH߯xW?۪K{Ǟd)瑺 N ,v, MOdB`tuśi^lr8Vh > f Ny @]
T-a%Gz`{^s4+.?0gh9!O %?w?4* m=
'Lef:!P%87} ۶-6A1( =te"0˂G)纺ɶt$:q=U:3FzZB<;*fID5]23S$rK+IJj>s܀d
5v ڕ/EY%tp}m3i4٘iTBUdQ!鸥q9! ɍ+=
4^]cl-9݆b DR:xVPƻ&7.&5|LQ 9|
s&oݓC5N&|vjjC9(LfE-M~DB0 Pv ~ע=<ǦRr\XS/ߟ ۿfɝ9MJ̧a7 1-C|/?n\Ls+3ͽx7V,X3X8əa0_:(m6R+pt r5G9g ڸ¶a[l ]Q-OV iD@! t#Ԝ xXq1
뚫r] 6TUۊPHwFUθ. d
$ U,j
ލ
ڕ # RmB9y2v6! 7pUfr.IE3ΞwQ
%S9UV&8}b(φ\)Dm`G=3v4>h͝Ĉ |2 FA+@T|lbim lNJ~%bG_In^biY| T_w1eHN++X@'>iV1q9Rfҹfabމ' ]' ZH )qL eUW3
F,=d˄adJg9W
; θa[-F Lm$3IOǤDG8FuON )#|DSoy4̈mQ4],:k]=!7JmW_'Tx}z] [ّgb#q.8a{9mX3
q({OZvY-|Ѕݒ̪? .uTUx< ,y[nSi$)Y1
xN_m bKt,LN݇0_WsVԼj/o{`,b$2)U#U#C A_m )&V Ұ9BZqq+^r =w7 :MґKj 絡*վOaI&xJTSjfC9 H./+3 `EDZ >VVɈӍZ, Blm
Wc"'F`tN8 .4 zmöH
;8uD
!UPhFi j3 B<H6LJ=KJ hZdϰ4Mt \qeѡؕ~VW,7/2H ܆"td~L< O]:Ie:v(, soKMJB \"Udv /Evc#ՁK>ETl ?{#X< gK)jy |p?TO(0 C]5mwg:x
o_mfR'ض{Y濅ST=7ܤѱTߎC $zz,aLKR$',hYӗRzWB]~w1;Iph!]ꂣ]0}~c{w).
Z 1^?wNt Vߧ>/cs EQק Gv4/39o4vݗ?$`X;oo
`m=Oj.\ }ZY 3oye +A(B=ޯB <*sݚϮj&R瞵"?23]t/3Ӆ7=J`(YY-hXjj@ZîC>:?ɽwcm:k)Qھpޛ/0c3+`ǜmMHöfn @0bG,8˒' TA 25i4)s Wݱ $Ee*"_Q#f5 .qDZWSP$^`wخd.59*J IUVڦM#8m
]!jNr8OTH+@6*_mH=F*0Xuf c!4.A߶;&3Z
u*d[A C.[pdc?" HgdCoϿxDԪ vbzAmh\MrI_(z(3S.Fj\ GUwV\MadAO2q5hT v@Ep۶!aDc0 N -)FbY%}ogTgl0\\BXH
=>l#!¶ ]5K Kb*fe .+kBUn`rfςB:NsNTW
$)&,@ʠ'n:$ /5 0 CiQI":%
,< ZW22IfvEIvTUQ,s\t>3Dw揠X,D5I c@9zh[M/'3X$ vwJ!B -iA2)tUVXZBQÐK*?v .qcwb8б\rx>y@l٢(5 <} '0e+ڮۚZ";Cd.JS_;Oh0,%=?p"/oa> D}ċ-E$AQY RN7//) AJ?ٰj]|KDz,E k
-ov~:8"`(3E%pfKW/#0V_~\BY,/ '\N*BA%O 'gJ/ V0˗U3Rt0{~:wؚBٶJmsmȫ`^
Ȭ` 2hh
yW#!Q1qTP sgʶd$S0,. c~ĝx2^u6"Ț(UӶD HFB<XRxRHxc̒QATUIU ZI%
L0!l%3ӛ
yA[VAσ!dn8xؗa"{ٲ㓲,BmsYN2Ƕct6I ,n,h+#h[[}s"E
0I2cGQ Hb,
+=+/;Ȟ7~+?<$ e$(y*d0S0Nmg9Vp#YGL{5&jW& V5 yIܖod,džR|X!ShZ:\(kYQK6$jIG*ۮ jx)/DzQ9b5HWveSK->}>|ȴ5 E ^QNT65e[~RrT#}~
o=)Z 1!Ă2ƈU 6Ran 3 ۹?=ۖ6ٶ0Vqn \4l[()A.gyGaYpс&HgmKden#mH )q
m ]s6~HІt]wl+= 9D"7Ϊ2ET#owހ~Le_8hol <Vz"MV{=GވfA3 O>y|>ߴo*r-dѷp [hwDoaSC!1I}^y3/hqqM^w= \Xs3
qstLefYPq_3#S7]MEU0l-(ڎ
d%Sł ^V ]Xf`ƹ܇mö9-)6l 0P$"e(6& tYɫ`de\9#ENXFfzh߮54&r}/34sxEwImXl;C 9`too?2 E&c{xk^LW,[g)-W+;+>Pz;c}k wlNl8KS4Ei۷5~3䑡&!*lq ŵ-í$$+dqI]5MMMefOAW0t4;e@`$c ]9fe߃FTF,*}x_^sA-gaV9lkζE1:r 3 @6bmcfږ, "cs#B뉏~t|" 3Ueg4ʒ eQ+TðZt~[5 K2cېbm:EPPG` 1*!&|OF@ ;%hfZgU3xSM9yN0Q0pl$ EMPhz -=0 y>>RN zClX94yl6f,}/)xBq쟩.#s L栅Z%o :XD/hWM_w^ K8gX_zQ]GGƷ[..Ӏa:> `23VҧK
AX&$A.BTn
:mXmwҘw]3G ,**Z=a[尭#0yx s]؎~fKbAFTU t3 նT{|wH4# J,2;: L RE <heǎeSe#E '`x
~xݠ8yj2*2XJy^p̩KvTUVUn414d&ljS|**&Ga. MJCwx0hoa'3an9?[q bˮ +,@.yc]+!#%=ʒh u1n
EDe"6aq
v`$Io
P%D;[4!/ie+Tf23^/kX
j> Phw˥+ Qs
'㸣ѷ5|E l8غ¶a[ UP _X[==1OAΖ8 08Ι $X :ۗ E>և#P:VTE"h6 9-Mci(b^/V0KlɉxC0.ZV:JdGQ 5*W4m\M IҽUgq[&2+1% IpP-}h\Yf֎
ت]
j#sUsZ@[l 'AX醉08#ccUDj״ڪeII&i
9;
l (< PrvW/='\V Ψo։Wwߟ,]|VeX[oCIa +A7*7?l!-m,[feY"0UrΑ#^yypȱܵ ր|?0e&EEB]h #ef L)3\N}a[B UymA
Y G_"*2T80 8C#e~Mcv47SRN39n[V3QjtL2bm)un}jL!(v:S^#H!i$LUXfL (f0Py6BztۺvǏ' 2p՟CͳNa*o|)B d Ѹr_LJ]!;pR Ȧ}p "DY$饽tU5+qN/ȿ.w?^nXVΏ',Xv" VOHmhݾHZx`#uAvig* ^g TnJ<0e@QO2 AriRfCWҕG}4_y5 , k-i]24{=攚X5a[-Ђ+jpo *T'` =5KesH@qLHru ap!ߞ d:gF ٖ3=~`0(U$)۲DxϿ`^S"yJ*?2[*a
E![T)T~<7 W6F-UQ7B>R^D-acypciBT11!Sڱ0Z0 8,9l&c*( P`"㖐R5CP QMہQر 6 \sԽS em'VmO?TӤlm,Q?|vE9 Dr!wJnBsLXQ6ā
]Mbaڥ,CEUM-Qce#B% D^%)od`TV |x-(r?SPV U|bXW0+; \i @iℐ[=ClzLy D{c统 MȰ%1537zō 0U J= }Gw >/S+miìO{U-E{wPմ: Pvwx}2 +ȕĚ4UA?j; ~zE͵״
Y%l7c4CT%:wE7{>!۹Ni7'
}# ŦCE ,Uefey
i2琊vo?,)愙_fipf[s UrW MD%d3-=_ P%*i٥Q1pN38!]t!#R\5_z֨TL{{p
K54weHKI,i C[ `T$\:t0b85wWK)s BaP5CE` . rB5h4_v J,TUkmB^yaC[ X0
*$Y$CSt^R@'EAǶ|}&XYTݴ(?iF2)j'bXTP
*ϲLZ5Q(\e.(o2EUŰ8ӓU' bbBC)E7xO(sF:{ѿ->7=*@
S}rJW5?xs{_*CbP=v,RnS_\}eZ{N#w,*PS}/ 鯫 S X\Y5])tsj>1d7~1fEW?< :;غ a[尭 Hd}pD5eMW{3ޯg
p ARGAHDD~)C $Y{vߙ kڛ&/:{{zfv ܫH={B)(%D&,^6/(I5ma)"RIQ\Z l[ "Xi=h\ e{/fE
vr2+UREO `bxa` >>ITd Z?XY[X1;Z'?4]Ĩ+ގ*8@\_ RJ(Mgh0xmVrP>;RLUZ: D(j|G 8H LА:+>H@{7{4J \5꺠 [Yٽ^n6}ش `e|N,,W$XJg& ;˦_5kj:$=0 6ѥh} j
j(t/6|U%92Vkl:: ^api
_^~%nb7~pZ~ٳ 9;B1[' 9jKG$Z>0Du@ZqjT$ +ɕ'*! eVq}҅)NWXn9o ;O :v3 ~7>`!\+N%KhG_x7:&Q7nvb@Z[8
˿q~ȠϧK<( 6矽8+Pi:m7
,ɣǮݶTl+`U / Vn'»ϾZTi > Ii7'[f3l,<
bEpPgo_ ̪EB
V3vE -_^+?MBy\ cU & !x/=Mڙ,5B J !(X
PgDY D9VFP'$VX'2=s?]iCv&"EN]E7ϯz#H8.-۞?>dLfS/
# tJmEcqή3.*yȠniul|ÌeC"B>'WkkKB']8Jޡ Rf/RznjgftBĶ T%=kƂ7.dDNkSGr ?t[V=f~K??W)N`&.N Wbjd ;%y@ gB"o
e] 03d;Ve$zn`K3P^,`-҉Ui])kMv/z%p~ĄveQ@ZV˥RF.lPmbJG AܸC#iԞkM>@%-32z</vǎ뚹%]ͪ XA*w?xS;w{0
Dn7f83]~XJw8H8(LXb 0(M(EU-c'/̮Ew,4?A-V5Kᅶٶ |[SvCv+"Dt\ >.<%ѮVL/q7ޙobH)e n6Zn<$Զm?\^SH@x6a@&lYKjxP0;X5VR7K
vb( 73I١L*K
] 2QJ̢} 9 7ƺQS[B& AJ'U"ô^`L'҅"Ny+l%{FOör<}5b
; Y IG|_m0(UtUG1mKRVYaDEP+]UcLT[Vˊ0&`v2u>YaX>[W: g'a K b)f?
h| )-䡑\ғWxmw7 `ZܚHB*1ҊZkTrޭ5 BzS1v*Yy`}6TV[4ok$B mcYEcr~LչW>
[`%´v%'bH~o}BIeuKP@; :uU0"~+ՋU5@CˣVV R C{Fm8bHOdb hP1Y((3''.BD6aͫlZ*B ~ I *N3ֹ߸*F V 0QHA_Dٷ,Ç!!nWD
˖ÓحVQJsvcSzˮshǩVmBT mBaS)Wm[: VkKz0+>|, }x ua
-¥yC1tv
4d@@̴f&@nyfw( <"#o1uioqD[? ۺ5
c q*tAmI du/
+QhLo k!%Y ve)lL0亦c$z뢀 %wIx较,|}wot^D9J١.><9qiva\ݬRO4@~|RI4ClJy1WRRS\?1c~*I {@@% fAHm 9RV]7 "pVǵc8 yNRDQtk#)4IVr+-\t<3xFc<3qjV+ QXͅg{0r"Zj5Ji!71
1 nAMa4*`!C%]B=`eTE* &-Vζ03(ҹ cj"@$현caף^!a[OQ⸶(oY_llE)ͳ\/ -nD) In"~6C 1E
$BQ@Bw==%<)P"kc$(91WJ Ҽʵ45rb˿e B]NH^Yy7 \SQ`({ceO tMj6[r}?3'SH!U=6
Vi Kc+F0tc 쌯]H
G0<öeZ^tMɫ\)rҀ0zն:|bϿ|'θy^JUK
Vf|/۷aF
A"/zeR* ]DZL5~ف$[.V̨ypLufճlݖDtt4#o9:?
&\-Lael6@P8}iX/B& CP LQW&ҹ ǁ:81<,; ĩу(_=
D繃
88v,-~F "xc %m:E\'tx6] ,'u 4VSZ[WdLxu DgM$쑪Y0.[ϳva0*' V_1"RJhl \'CLPT0sp!FR/M`8x
`Cͱϯ
CO
^١ +@;#' 8:/Qwd֝ g9p+ոL "r@x+`!v(3T,LQ!Qd)`H5%I5 =%w$ 'a=VX413cСĉ)x!rrZH}|7 Wa ./j͙\I DRҠN4Τ2zV=/$gue,vi;뜍f 4
ڑ S8]ѭ G : ȔJ{N
]M0Jiulbɒ̊XφƖ U,*V("NJ'`۳\w#-t-!as#yw[-r bZf;ZҰ/%p8gJcJJMH ty侙0XiNR^
yͦSFButҪ#L]9" !ۗӊ(+wS؇uci:h)(p3M҉(!!~{F a_| ۲Zcp F`/"AO l7ʲox B8 >Rz{ w(!Bԃ$!N܈E( dSW i5(Y 3"$Um.eEZV}a
YWmל]achZ5V ;fU[J vKF阭.ʥ82lWuc ti
J_ *}V.D0|2oa <5X#]$a[@ ڻqPܢ|$U}m[ =',?\V|V04r*%k"@GpDS3r
! ?fy^텘̌Ogَ^mךD 0*ꖝKkHO$%V,
\}zHikK86 RʰE|u-C0y|ld
A2P<XI4[9TeG3'B
(츠IiPUU#|{ Zk͍@ۚ&gI ˤݬ3A L O36_KeC\y[eIeٗ}^aA*`a]+2j$:!TXu_b.GJiwd x z7lȕ2p4U;qt~e}>@q V*-D8q13Z~DA.t͏ X`ᔑN:ͽ~ Y{1
GMVvꀀ*d%ۢxpO|Q5N`x+spm{a#WR $CduEQ^W8fk\W` l۞9Z>LgjNHKbPz7VO..$ ll;~SWT
UR,kV:͜HMaY CG&=}%s_ލz;+u{G-cb A'SG&j5
r Y68M,UĊ <>|d+ B Bo'
̥b?>vmozU`f$cMM
iиV=3L:y<&$Q=ĝ̑a>ac(c 2/9}ǷPpǾ8<n$2ɡ|_JmF q {\& >o}qm pJo߸Ovq ^&RJoJྤeݦF$d3 ~QN`tK_ Jzn]
2B$@|Íc"DCCtޑ\SZf#EAD ./Rl<e51CK5eC{v
Jf3:ݹTG e&]T̃ LY\T Ed5]ϕrZ>܋ ],:ɹ#{ zû5G̺{zPt5n !+ff: P(&⸀ rB2^4-FA)~o99+W_Z־҈{KHmߪ))uu0}XI>]@{ JHqŵHR崦Z`Yd%Vzd<.JФTv64vPUW`8+aZoN6 -3$H5@'; "(5HA !0qԨ6َ휭*tnnɅ+Db |A9\A[3o lnNPRo rFSҔn r#җqH(?9&tR1dCX؊.}B > ¬ԺZiuܦs%, $KwzHްS 67ɹsŴ5TZBj*cPr}2Bo'+ˍM? bt58M??&(%* }' |b|y.
#NNRª|906hblwIb8@߷XxO Ň}lqi
yA"nux a%z æFxX U\4GC;aXDRY%өի bݻ1eC!UcP6Xp 6t*~]p^\2aNCYw~Q{!KqPm7e9 2.q)rWcL\njQ+c˫E3ZA mPJT`duX^J ì.Kr_ 8 R9l2CF k0qQk4#cw}u53]"HRU(0Zi}u7iK}BvWSݵs^bBD؈(7l XF@j&rI@{kםㅘxQznM@XmѴ30r<$T w˔
묑ϲ-3Rw|>s' )"zFGF
4욦yDneK]r5'K$I0h l<
"O@V
E
O vT4Ŵ~ǥGg=Sj.{G)-d5t8'
div \l~
Q@CBQ5ӂ66 uQԤ& ӟ!4\W>?&D ĀB_j(GG[n`HP83?5(4uQ [#/Ԃ(e$8artXzy455>@#L(wMg%kȹ)1c]y=1[?o%D5 YIJ?559~Ç&V̚ ]{( }TM{s\
g?u/>=d2O/kDYC,JG?| {"
L0}1˼V q Z>`q]i^&[^A@x;z[N v:J!6¨ayG~?])n 4QEM{{:MSVP,o RfT* b>779"2 ?/="ng%!e d $m8P*]`:kv'a L L~zh"CA!
8^%BDP _x9`&L$i/HQ.6Һ
Ȳ@ʕ̽eXjUi2j,cb_.~Y4Y$eH.ߛgK,"xNNJSI}~ȩz_"@Y,!s_~?̐bM hD$X
Dؤ tv8]qUpѱbr~_zs7 ӥN=r
fk#y>!Dͨ.qIqZ 7w&'x`NF9B} 2KgA"(и4Fq4__i퀕BןPֈ*j'\ &I-1p̒$\lY ?vش mŬq$cVⱇo,C?\W B}ޝ?|W^}%9%'`>w?ԛ\[p o:**䠦kyHtrOuiYOР
" ,c艘
{AaJW,n֬H| \dT k]]:)(m_fQbB"L2~J_gO>tyM=][4"Ln,9SG>
Q#DQ7= iXkUcUY ,Ƨm|²R VfZbcz.Pw" D!~ٱE_[tFk@%N̒*-܆"& -5?VLaʆF+B7XH@/eT1?/)PwꎺÏDm3+ ҕUFѤFsD@, J+i`uN $//ۮEnTRO [ĬJmO%d\2!r$H.5= mT_Z^t| GJ0Ͷ c""-J[ǡ6)H
i1"lCa+n 1T,xK);cց}%._eәd҇~|7|7>UʕX$T4~_= %
M'D`9U0$E(FϚIwȍ6Zj )L0@%+:f'ΰ:êfj\jl6;44Ķ`}}-;>4JT6Q9lWm5eѾJ341=y$fj*! ˄ :;γ DtŌ_^c8NpqqhB2N>r ; X LQU0[BC LR2 EgJWLH(>,\ե v-R7s8ƘPց%=__Fx۸S# ꙴ| KWW'/QLG'jSꋋ[
4zQG 8 x=#ѓ~jeEWŌ&' F>yVkv" ki4V>70$Ĥ8Q ԙH3i ^1ؒձ%vAbtkUi60F
#2Z!V|
BދP0G tՑxAE
0I;O [S IvĬG /SGG ` h'?o|sum5#= h` LNF(aOIA˳fiV(@ɒO兓GNꕵ*!!ͮ1|̲dwau
+Bn"(7bJ"}74^_9 / Ģs"ȴW{1Xo|Ͻ90QXahkh^ԖeFUfIy
\X"|c{fkVWA̝_RD8VkLjjtI_X&vsZ彷 bܬ{ 22mٶDy$Q
[ACp2 /tR[b]UB
گS`n@N s㏏BH 1 0], (=s9$4) S=T] q6_nOc`]w
~wjE: zch# 9u}=" I%; ծ,A4qC3@O >pua1_Bj N˶Õ }r
h?"LS'rG ]l7Ujv)ą4ɋ@ ݔ_@ /]Xt:.;^GKS$,(7[>Y% QJ8T $ '%#t)p|k !æ
lɨ{¬'xD7,I'&8w>e?feҩ ^}^|92Daǐ&MEI;rm/"I [ 0 Zɡ. _@"?&rzSI:J<]*%J"m \R,Ax'c=_)0?Y*;@uM[yİhoYCp#5Y P%ޞ ɲ o_K{jہG 8vPcC呜B ͮAiC aId &D)0 @\R Q? (ǀ0XmأI; @[!á'hYQ;t+# Js6L@ 6Z.SCuUUQrC!dm5XUvlc7Ȍ~>$v`m()14HAEW44#HFY J1 ZL8$Ҽ|=3jT dP \>c̑JAD]̱Ռ GuZb
p!{`|u܅՚* bf_T/fU1qC5恵 & J'56
aQ4.O?qnQNJ!|g } ,u"/@*-5$x2@h `5F2&1AJy,tw4Is24o)CZ 53f U, E;v3=5gh4āBc8Tu6} &-A/Ow{˴)9z {uZakl
v=DƏENWwzǏ b|Jʁw~ dGk^>0T^enF,@ʡ8WĐ,BɱVU<Ñ'=Q 98 `gT@t4 N%bםHAB T@}sYmeUPR@`fduAZ`Fs*,"Owyg "7 YWԕL|"KP$C*<5SZ+Y7n XB (<1|yUm$MDp|x8Od抝>2* dNvmO'HBF$C@3G'Ls LCjLx#b&8w;D>S``G`Ks>s0:kM'CO|tO]<7 eeBO <7PxdJi/3S 9Ɨf=8:^ ;OQuxi1bOb B◟Z~A,5ַφ\e{f * qDлܼ~vUҚ4\0 u=tZ<{u_Dj.Sig Lf!
IS0 &VmǮ6ZX%*D XLkcL˹v`@_ lqV$\h,TvT
U;t݅9m4оVQ[-m@do./y=z}}xCR]q Vק<^OXrdwӲV5~Ey7DLP)s@;oL/4b5 :292J}m5 UY/FYQd
X< pݏcVҺuh@ubH2>n{ yh.\
`-BY+-r J=7/>{I$ |ɍ@Ev 5,)C cVV U(p4X;4t `[V={vOG2 ̦\=D08`[J X3?;TbUcS6`֩X6 ,IW^GH" eb&ų3^}O# @]JiD : -h9:v ubV9`@-VٲC/($Ew",T.*f1{bYr>7}|q(~H0!YNMIp9 Av6RЫ-' 6 ;Upwb8> ͔3/ Sռ H#K``!T mOu'OjÙ ;83n EDR"`>DJ@°_-ԭn
W>Prr -e8'f2`#{`>&WD]qKR=I%f]bK?x 3?mG8s
IP!A睜0RʕK}pF 9& }$ ൳L ksMqƤr~ O$=pݼ$.`
/;H{RpӊM[t oy[ ȡ 9H뇑:6R`/F =Y*)Ҁ] zi1Z%N#ʼn3naXXVP1tPO N /HTNf.0Sec '?ʝ TU[E =
X$?%rp ||X 94LA]V4%oC $F~nZ2*B57n_l;̦uY
s~ό}kզc-9g߿ *'| n.p#8"_K~&x͙̓>= MP.]_Z- ? t=K$*Ѝ]aú8{Y]e\ ;մ.tV t*.toyR ڑ tŮ a$^mQ¶M"m|&aC_B6 zdB`6S1 3zX2
A\"ՊW;~ . lt Z
H1)ꇰ7Wǖì!SRK=Uw>-~3NlYV< 5zFX.|G~y'gf8-
} wzF
Heztt5u`Q~w~h` ILQp ?_ɩiuOL}> m$tŹnXj=P*dS{P)evˎsdhH<+h[5^Hl;rdvXp*RPtPǏ :+ob+V OWBFM&+~qaJ0qj->Qͽ]wѶYDAD! n0pr$ o73 -)q4U=7#+rz}/ RG&]ٸCL
믘 r A8ꕜ&4SܳVńxUN:aܹaҚ4
hftջ;-u i(Jk; fSjHuRJdgJrcޝ /H"az+#0 MdY_x /k zmYAUlBd O0WBF$P
;vmM5Q2vP! .eT?p 8W%[|
}'
Ep$d "E+zb !I϶PbH)L$|`oN"m;ohM#Xc7JZv%tәf
l6Aԣq+ .f(} _|7d_TD7t&?v=ƿ d7<7 x_fJv,Z¾c 3dz؍;6gFmY}aia<3 $?xϽ3.nKH
]D8K_}`V9wU""Vg|Q'C.Wyۇ M
v ^~pr RL?L1@` iHк9C"RJ(D0jQDd $ްie
ԉdH]˵[YC`R-P`k6fe_d.U(ϳS }<$iS$
Wc|1qsx5{y
T~rm;\ X!`)]+L4& !%
=DvM_ l!nQB.,ÍWLzᕵ?:GY \ڕ ~6.-10TeC.]^NPV?Pٗ?OSF?05ȤjȲkbpvfiuWs ѣ>MDz\OKk Zhղ[s(H݊$NzeEa.tB1>m Ν4MBRztf˿ pC'Y%`~a\Ki6D,8)aWYC0}df vk
6[ C 8-1$o
x%. ɢ}
V5ВT7ZZjVJ"IbIM_y,N dofQB<{>4+O'_W* Ӏفm!5J٤Z7D,
*`1jt*-IGȗ2#TؑJC YfĵtN(,>ه@& w ЕxJj_]{eQ{ έ4kiXK`f5ssIRp߉#Q :^c;kƥT
IɎK ABBASzz W `e4O{+#CAż+H$ EIZ NM56 J`\ 1`]
`T,y/qޒGjF_}j NbZ5)BckPS<^~賭B, c )YNH HO
xHS(| Ke[cd`.`h XP_ߩwHDF ;ȸ|e:_eBN\Qb^_퓣S芙Lp2M̜܀R
(Ks]ө" آa4{}gJ]I"+".?Tp'ujo^3g*E@RZT@7B! J ''NqqbqPe!ْ@ܽ3=l2Ix= 3TISDf+]='DcQYI±* -`mQ բOF<2ɘrf ɢ7'&=0-ClM1wW_;lt]]vYoQcBHy%_?~G?4tL{ E $)ɥ%ئÂ#s{@a-U7
JGy#e{G19Bq($B:+Ʉj"woLE* I1d;Yow'ho1]O ю#:5Z+ b)^H!O2աvmMS>e(lfv>:$ᐜ!.?Yl5zb)]JPݡs^<b5mE\ Rx~ªҎޓ?Zk{H&2K7Mw~"eXі[W,q\OR1
3
{F.% d(Lt(&JYyxh ˛NG*q gtHap_zp<'y( vsW= vru2 `)eR KT;sXgy9Ug
v˲*9> ;=p-;hۋ*
UΟkԉoǀuߓ*ғEIz{/G9U|5]ǚp}F39& לӿAwg@CI]!6~J*ǰD2X.[F.lrJ+%>6kOR,]w?7ϽMdEV֢4+**﵅dcGl[(;=z )^!fQ tZ9 כ aQXRbb-5'=VGt< +@Q1E&G `yt-[ ti>7 l0*ARNVEU< yQzi' 8`łxý`'Jw庠pqqF/% 钪ōږ(V)ڎfX)ò=l:ș,#;qfbawҐ:<'+Zn {q[GȐM0 o=J)mT$`H8x!i5+MG2$ Eu\eUk9M;ȓu4RSDm_QW ?pC'%EH+X2guг䆐Vk\ $һ2JXRJm^?{9zǟ>^^ԎAHDm6[)fbV<\M=C 0%"W
<;f%e>E' t_y&ֺy ^ߦVG D%C60kv9-nh9FJS
]V~ &
? `݊YIsۢ(Ɵ5E
[[
v:rK&'a
JknUfQhE]U-Ud&FZJ#!eo5D }SE/H障c=D!-<;ϫhrQ4$@8H8pt0<
1YZ97 9&,
j)"֏yg9Z%jGΜl6Ζi
3NϦ|thl$ _>(҉#BVVmYWnzw:3̋ܝ$^cI?tX>\ ;3H$SBKjDׄ0tO`') vAbWGÜL`8'bxRdt *AQ@E X 5n F f*VAQ10N0b "yֵ.a5ÌC ʌ*UE:ppZT]dNU*~'?ߜ20>@#E#`
w`;1i~Y首Md 8 ˊP,Ft]SY"M ^/=cȚ~I0Ju1/[ ]^3G|V_apӔI%Em ޝV4W)PL<˶?]1\mȧd@!&PU #P!q|lhhu >k@WP.Cvl9
IFAdR*S"̦ Rt (2〵 dc`q(Q!$a#)MB)dLDPoVK aD=>n(rJUX!
]Surdm[{S p(PH+iC[qR RX0Mn!ݑO
Q2/37{ ZD]-<9͌
+
Ei6M1|F+γ:D>tx4@s 8d%iIT-P(
lo4l^|LՄcEҿpdHۂ- ќ%LX
_dP۲X}U_k%sz *
L/\->"RYseym 8@q3jcf(b BLw[~坸 DXiV-. 8yF`Ƙe>ѫf1 0 k!$W_S^r&2 P;djV7ff?NCQ7hM=<1wtC·ZW*'vg%?Il2>88 k {ӱ[vb5m,JXPŷ;R8__~($oGMʒ:LM _[R:Y
~g)|1 6HOiVW{9(Ţ@2txX;.I*ѱ,ˢ] Wlcu5Č a u? (fUxr2aw!
!/,6=$M|.409s`mn$t8V2/&$1.$s)?[bl0w&z[c?\ Jy&0WZI2;~ 虖 eRɪUN:m잹/nsH5d \WG!V5LplkvqnQFX)Q3],^[!KzոWj ٵeGXc96նkxd őLxԨyC`b .6 8~ aobl$h[ )wx} *l0)ׁu#b-!YQV0p*nX_ 䈎ѪZ UJz ӧ]O8zФ1驉^xW^'rtlL ~Rr9{$_=Bh!?} Y]1Bȵk;AӈYEx˄P1XkQ+-I,jZwM.ŎBX
: 3;
TanvFX(Nd9.pQ UHtlW^֧vL)PCT)w!QumײcB) bGڥ\~ +ّp1H5Դ6ɡ*ŷH4, a)v ?\V|! f%i13[h \m č |5J?xzܻAnר/#a27t_i5V" z}i8x7D)3P˿V}
~4ibB )̚~pf%>!UEPD˶Ҋ8"/wȲnFizEhDBII]UE ɋǰ5d {ͮ
Q̥JHK
AUnK.儥Q#<֓D!a) _zc C ,KaM_[ɪ!7b_#]Jy\y(/ zgD | |#̂Gx1-@j'[x-c\%2 u/^djWJF3Q#f
K?nu\ .QKD' ahV[dD&G2$CJO*՞d-Jo3=1sa~/wjz'N )LO*h*~b6DA( /^RbV_^a H
aV<yG]O0-uBr}DvEh3c%in~*(M vyVB?ڝj+p0m$bՈd{ޙe!"\kH3,LDaw7205uo*#jnY
)2
4: @SD]5YT.f!T_l=Q!qZ ɉs3+qĞ̹zg1 s
Ҷ oCRE˨#C #E顧ԍxKT@VaA
x}Y[a p {ps+*$q,H@@y0P>% (3 + , )y J+0wڸӶ3CһXd,֬S]DϥeVL.g۵۵b[ &3^ZQn%$ 4 Бl@8G ;' I+u]/!9f12+(蟋IDb-qf}>{U ?X3!oY bH) h[f,NNxG}E\N-Em1 ?*{Ƭ\!?K}߷,k=Ƚ? g?iQ]|qL'Yb@wኘ ;s,/BsF#X''?s>%%c 7,zfu-,e%V ,ǟ>{+KZ+i0TXH9!
YoW^'*1HD
Њf[Q;մ<Ǎ0^R5Ś[J2'ms݀'Dibts2XI W/./=9Qqb)H2U}{ Hh 4B`f gu+e("J_k?DE܉DzE vBV ƓA,[z^?2q=G fp!L0PQkKK; {h?}
n#@`ż\⡿KB\)dN vwѷF?~"W
U=?dhձG =VԂ#x pԽWzt
G+yw3/g_Np||V+\BҬ.P "\ U }x~ o]0{:P Ն@7͛lYbt$ ~qMWMM}77 Od&'@Ǐ'Ǝ
sPm^KMd]!!q ]u`
X'xH聦wf0ID&Ike,S/9oix}Kw 9!aH74??U(dC}; wHݔ/`MhX(qx ]iu`NQYUC 92xN |6⒨%f (WqT`q|sԴZy4c0e?BZ8"\}ru{jvFnY 9<+.-0 ,
\{9S=9ðuڲg:bլbL8>=.f|^\ykyga& D 1CxLs:O=ՕWgM/?#n=g p̬ZFOjT
3@F'e
=/h7O e(0ۻ? kЅ,ne+].EA@$Kғ_c? MP̫vùOe /;Z XFNΘFV?dQzϺ=D"CE-6~K@e(D(6,]!10zǠkfӮ- Vq lӲx=v鲡J2g& s Aݠšݶ<ۥJʧ~k ң ܿzYhz(bO\\owViFA]b&+|k:^۴0 F(U;l*6 4=vԜԱK˝1%jwKVF>m<4I(0,V~u=Cg
ّq暶.F>۬~x1`䒥/zuL=cO IjVP #@7k5 C`X9&*auN"rF*ꂔf0," WA[вjr7JZ s fF۳o^1.r:*㉏ =)nq~Y7빣jñP@hfmp3$u)@ mK2K\@:u^
yKON {_?#W~JCSKR@ϒ!+4BrŘ-%ɢ4 kn[b}$gRq@CRr ,aVFWo־{ s5?z
BH#!XzER8-F#JΛ
~ `AN ZѪ^~e1 ݲqxAͮ1Syo Xlĩ%B_ BfJ
#mLjO f`y~ЂQӱF A?v߶S
}9%R:+^,ϯ5Zn:o_vx=K9`1t9|pj ks#_l,( #ʦӗs}#>PMo`q0fk矻F@i%:<^WfAk6y+x&
ao-8ё3]sBo/cq I :f]< l3?O&z3~ROt7pRR|' +ęɉ3i(RJp):UhŤmA/{Q$l=}K&8&^GE 43
;)MIM0ھs0 &\Ru: +DJ9k 0V #SĜ鲂,q5;I iuZ̐(q)p=o| th "&|?ARZfֶA@96]sGe2ܣDa˵*0*t0Bhdf9&$b0-Y ^KbnE}$vJ]ɖ "G!YlǡW<6&,zgPB#; A0/HE @q}OO6f. ( Q
M}:IkP$d ,Ԏ0WeX^812ai D0R]OV
vUsZoAJ{IǬ4˭L浉Uؚ%D$Wu cC0a[$U2dL&UMf|#~#wݩWqcT _;O*M8ZwLƸH)]VK o:$7fO )+)au:3u !N!f qp'̀ąs" CNV"{~ ~9*_m .:NK"q!n Tޮv#TC2 :vd'% |,m;mױ;bBQ% dǬ`\3淬*L< p㹚\x3 VmG-osdF莓Ք mV2rCb^z8;%' rVBq,Id$XQ̩94 LmY(B
K}|1#BHþ$İ71h%\e9}QE:7 Q Jt'A=ERJ]+Bs)% 㥒 hex~h! ʥ#vu{Jx!
@ hSYxs>y6M,6}nXҾI DI(f
K穙0Q01 Rzˑ&El!8Hb I z&$B9"@`|14b\1"`[<k ]/Lr ǎ | {Lৄ7Ĭɱ?~z[h0'Q !LbN#>YIPr`8%Zs1 JBzIes1Kx(F ] _@D*7plVhɥR'ppc%!(RTY!CAdF$Y>\>+8JFG1"G]: Y[~
l=̖N~C]aqՑN,kbFF@VюEVX!DqWx%k7Ӈr
I~%k&'UbB ] "x,A
Y) 1Jz8]+9C1ɆfØҘ&`FB /ЊOXQf 淣M`*dYٛ({SpBK{qqV.f3%6||V2Ƥ +5ˆ+R;Y&ыYrF۬0WL"5n|WZVH1T%fsk M@
jՎQ1 Q&D6$/:D=E`UEe Z`ScZ#BF P.Q(w*:.d }7VG",,``E<20kvUR1Aוo\>:Uz#'a*G.c1<ۮ^|!eo07A
Tl,V h3*7qYQ8Zз1/xv^1+CBBnO}g_yѕx>*O6umf
ߢkwVx+ڹ_zȇ{iTDERDz˅n)/^uj gfIeqG!PLU|7J¥ߡ6(}Q̝Bsntf3t iC
hi<NV-Iiw/_Uɾ$Yy:x,tɡx}}۸~`줡eجի vmS< ~y®; "12Q " 1R? Q#j|%F[Y8KK`qU\o``-kTe\bwHZ#IE4 9%}g 83 rɶ5q2Dؓ -DYÝV (cq %9
VZE0+: Q_=w_85(km%䭁:Wա*C`?O "=s;fXb r:B/8?RTM˼q/@^JlhWW["vF]ade,
I-iB*A$톐
b; Dt +#ɺz Y~r
6DQ0y^^ȱ ` [6ڎiY2=a _1 }s[3~Plphiz8[>ޢxn7a(V۞儌pFSLخ`P~:ueSK4/BRBs DR,O*||.G0-B:-J)+P<$=S
e$)!K.y.Ƒ ac Uf)(C lNAP uԁB0'O=4uL]rB"wVF87k ȏ;ZmMa@vU
J9(JfgNgjs-ՏwB|ZzQg~4ES- lB B8wl+_A?% *2qT(P-Zqx?p
@zOnTո.$+bxwnlHw1$ YӖXmף+ #.}gّ
҂
9ͶW4e rձ ,yƭ=2
Hd^/![PM@f.v#/3bzlYg7B}`7I%H SV5 uqBA%mmZݒ 1T1J
c]Pc. M78k BV}$ mh_sm*V ?CcANN|w.v$y*a[Pӝ!B]6[Fn9Rf',8`7Mv, W$ Srl[Qݓ?]i& dM cl"X522]6?05.}@e,Qa4z!dN
㯡c^0LJi Aڎwo;A*e kXFLq1!iVEd˶ lTI DB,xbHeA"Sm;A#H!-D.to5[ꙅΑ0N+"39Wo;f
{/J 9 . "%9]m&-NW\Im8,Ӥ[n{s1K&OG`;v*'t+z" ds7JARhJlzTd 0W*/mADh>1?A
YV(t
Vx>؎#.B[ -@>#`QGUe &4"eT nXNhtWSugg.P MvfaLTֵ~UQW6!sa8]ܿ") _65q&XB7f|Tյ+;\jX;m lY GsE CFZ:I&V?.
D8 #aR^'_!Je]?yܶEMrݬvu$J-E YVc5i9Fӵ0ߴji4,QADVZMmXKkV BpthH#$xNJaA%0{¬W[w2՝`,n \;t0rt1/x6Y2hK z g]9f0$1f qYoT5 G' ě6x_,m-tT]Hh䇬b:!m'gIhltPGh:iYkabE0I894Uwmi~v mЩBY ( PPՂ*pӡξxϾB ]%)H4 Q
#~-ADB;(Wӧakʊ6 daPcB N1tUO.{ ~
Zv (b1^όO?5*pqRB%EFH $TJt/jx qJ1jHQ/).VnGf'/7B(
Fպ yL'Ř(.?мZ"*N@ 0e nvJ,O!E֢,}gC{ Po 1ȬjmPbH3hf\0P>m衙Si1֚gQx[n(7(@"Gd
{¬N/,Iޠwx|f]=RۃYO zU]Ok~OO `Sn+3Qgk@AhѷOuI`V {{HM箕5m+&}!3,?5bV)}b{m XOaIݔk~4r}XjT CA(<=A;(/uJSdgnYVì] **
cJՋ!sEaĸ(z{Oks٢mS#ŗߺ 1B0
!D7e 5Y c0EMQ>reIQ )=\ R;Ů H|3|V?#ΐ$Yk.bzk˕٥դCZtB9j$(LR DoEt@G%KT"∏XaɋͲn-dĿȊrs"LcGW {2=*~ena*z$:P̦%ց%Y:wTkc'
Nzk ͜At9h`08`;E į\p*J ^ 8 ZaKeT(퉞X@M7r;v|8_.;#smnv~=nW M$. \&L.E;UϣO1i}8zVIlVAxt{+ n=
$Tc +O{?wR(2xC[w˿D!$}ݏ4Fj NC'0TZS ;XL^mL϶f .HN[وآptx-T)"x6@,lx(^ts gbT*3Ov;ZI -0=\ti=744N\.q2ɒ_nV':d%y0XMǝSȋ.} ?Qf N^5 cy8D ]:u;/R;Hp v2{v@0kWW
;X ȡ+u7=PvJY ,Y~>PY#Ô&3nYnr M 2:0==59fwѢ(ZZ&),B Yi ɥ2P6L;+j Ebf}p
)R( \'}iԏG~ܗ S̡*`(trCXN' w8
,ٌV=O:QdvX|Jʙ"vYk:C'czCc :fڦe[Vr%U- ಐХn ,Ei(~PqC@2z>ic,z6#~h*T^U}l\h|<'Ô^2c DgJ >k0Pm[BR6I~\JWbn
q@HL˄}JÂD!r wΦg$QJ*uj! !t%
JR<(ڀ
%j{38 R0Id \QxU
0@61"llCHYG lK}O?m4cVy)y#?ࣵ
iԁFF >(
x5M :;YDe(tBˆ(;^[Pv]C@_ B4~EY T 1>rO.>_}gߘL57qz2jLJp4" .-Qt,4-]4e`~MK%m Zf pX x DI8{r@QfVT`Mf$!BQt&nXbBׯ "@p!B=BB?iNv P
/ac^ZmK3w @Я -H DouH!=O] tݬRz { [Oc¡TLGd.bJw1a,i jZaU
Y>pT&#gx' (Va!,BQ:\wdmQdB\qmR`;3@Wu OŘNV~D ?iv
#`K4pˍ0JϞ9>І[ 2).p* caj)(=i!_'?YXӖT{p
>ursru4ށ%*H1S$Pz/f[In[cC%";V?~C2#~'ݖOWTڋp\EJC"K j fM+Bv~a!fidY1Ŕx؈V0"QȚDM<7"H1 ;j3>
;KpX=at8]iCGeA+AYs-,*),"6zZw5nIaVJ- e\a,Jb 8`%^B
JTy}~J*lmIx q- 0ŭhR{IE m-Ij>&A qϿ{wI* Qеd}IJZm7䪴BTYxɣP{4ڊA!`ᮇ]fsYghO8^Bn)]5BMH8 i].6χ?ՉT/$t;oLVrc nf,w ?_auTyi" (f 3f ? ~@UlpGw BN =<33 ީV|?z(DA|d|8$z m #0t
ږP.LBХ}v*9m-˷uU.LE[eH4+܍
l7V1W+)]ެb&kfDzoW%Lz.qWnY*Oe3iY96ߪ5:QIՕ `^Q$rCs{};"t5@eMezH,4$RUY#D):6%לź:ON %I VK%mO`8.wӬA/aP\ z`lM.( =rۦoP e CDR O篾%#7AǢ
t*:~k ѽ[cSՠݵ̥(/3bI#є>(l +g &rwb#"7P $kF6ynFA(骪kV #fwˢ*3; `G
551MܕeΆk{N^Gsҋ
, ,Y S5o95T@Ռp0 !-_##$b=aV5~tugɹ3#VF5<4?cܗh?@*Q^_!J64禧giyĘ)b]4eyjeh7 F b%X6J{" 4zGW[ rug1d,bр\p%fC'eIB$JcU^BTEhS4h036:\;*j&d^!j O `XU [D岯UYmg8^TY>{luW&\PXzʲ,
( C+K1c%tZgBz>4vU" 3VlDu baz\qM( ]r\ On6,3mTs vyc%eQŎf\5
.mrJt/2yt:ugÅcj;V.. B߈a[wƕ t<_
@)t.YށiWI$BIUxz.[reYX,Ijv}g _i52q+R)LO-v]@]
/V @/bγ1ƀPAB1^B$vP$B&$HCD=f> R0Xw5
. -aFsOK/, T8Nu 2c v+BvXeqBŒ(o ғƕ;Y{\^bVA( tR%с b`%=
ZT"}95ڑی*viu0ɣHE=r `+V ֡[V;t$UHpGg#'ɒl7᠀M+*n)"u9ϐ%M>S39 %
BݭWJBwC'D$cA!b%(vd15۔RUQ=o%.vYdLf Bz>@u:2̵OgӀ߂ f:B&2 cڢF=/븤+aY U+ZH9N>s9NPoؚ,jJ\$ƕj@͊<HttCT K^'>pV9;E$4AHIbZQ[WvYD o5 3Ht;hE/BݏFl_I+"~il1A vEEOݒve(hMWx/O{p_9(mB~.Ϟ#R&K~B]rPeEVea'-IVb]S.5`/< ?@p H `_w EESgO; B`>K+>fm3gXb\^m,;?
ATdzF -S3`2`%P$؇$PG-ӅL1pRW'b̊shv\ny>:4RBW=#%Ĥm{>; X^Y jxM𞓹t{ @R7N@VJoi:|ˠDqL I-f pK?2%p RZ#ݬDcSr;Rޫ@_R .Nhv6,MO ȴ")Mb_rVA:&; "D\0' $LKEtpm;BIi}Ux 1Aə"a]+K(~u3 R
INK.u+Z.k,)on 9W/
}Ty ~Z;ȉʿ B7U 8iw?naP_d{5ˑ ~ڃ-X}E
R'F^}5ێ QJfu>߶`F(VXd-I 6X&ёdM÷W%! xS+z݉0Q$1FwW,# ĸ[C(Yd0vhDBYZ6;h`%=;&oX`mI#!b GpDRy43z~9¨;t3>?ᆠ`xqADM,hsn*?ÓQu*,v"{oE>\ȥ0]^@I2e[" F xNmmɴkqS 4 ?hy/ŭ@&Ddb۬"ȋ-tATR%,P*V&c&Y$9 /\)£}
̪rK!PQð˩>ۯߋ_h 5%
OO,.ekhXY*)@H
:N(l!ҚT ?ّ-ŝJo GD%Ihp6]7aŋ^D# @cq,
Z.tPҮkuj?ٱR'ORp=lKB=XG3PXBڗ۪6.s -f{NV;K78ieSq1VJx
PuW9Ea' -]S'zж X똅<9kل"jā,ɴ%u(LE&1
d] h~/cN8*
h^NqtLHr}!6A鴉ؖ j@<7~)%v d9NM ]yXytĆ.MQ`&4lNu2m kMhAlNC ꬴ2Z &c!JtWC8Jc"B9`4,=~*L Ǔԋ:%caީa0zR FcR^gH:_ѽM%F̛kzx0 " :rW
WHZ>. p هRk M -N;cZezr/0s{1+kms!4i *#$vz 91:Aadzr8 d >9'q<\}X!Lj[>JKv-%pG*ΔKcDa`vZ $Iر: p i iPIn#c))vl
JV)60ڽ>"@=Q W%y4j2_=znA'1faeCNMM# !@+JS)B CEFN{*7/Ezapq\Zם KXM Q E)Q_o.4Jtˆ˓y O
γMFڃ*#bo
6ҭ l7\ )2 qJC*#F'hstAXx&Ms,;etgmR:t @h!KKiw(u.3Еkl2n`6Wt#75e^L. cۄJ_'S2DQppԇ!v%h hG7&1a/Vo(f=5BQ8pAޑ`)J0 Ǭ.?sέe``»iekoY nf|G_}w69hofҢ@\^ IȤ,pިK<ۈY`KuvC| Mgo}# xB\$Ͷ oDЛ#%虀 K4"+ɮN 'A(f܊@5Ӧa/ GWRg\Z7s!#E AG+624Y!p.NfmhcM&K\b6h_۟21LcϭJ@ 2 } Xwjw'&QIHq#%E3|sgW 8N/kɗeDPR%]UTde|b;R`U )mzǩ{x
Wkڍ& 4DYCNJ2m1{v[>+ +Nnr[NEB ˅*cW:UDUT5*AYQx deYElJ\G~#l$Ds[xlv0Țֵ /7#gr2Mg* oW G& * ,Vz |v
3 yq
>Y V7}k! d9cqH۷`1)+QreW_B o 8T߷}3 7e@NwŊ3eYRl䱓5?Ӑ
t `q貮c(a$Yּ/{v]'$25ϫΌW~oH8e
v+ ZmԻ//Ā +SӒH ܶV"h qۉTSZ4Ѯ%e+XڜsuL2ݠA Z3[ PTU7[mnl!Wm vmYcbⶋo,4_ , Kg{xG3Ćtzy_YDh) F^M7y`:4|hlG'VYl^\Lf%<"@ O\=N K"g] 074E'sWYsaOw'%Er]m ۢ PImSdǬ-$J ~0xanRo*卾x2`ymMM+ޯB KcsWsgyRlא%ӈ`/anmV6ij\TU:ғpSCt sG wOQ
N8 ?_xj;,eO~9i6[qAIx; |@g0\ M:KatBn)ơӢ Yd
wiW_z
{l? @ɑ
o :t!L+2N}2P͝#
P}`iG =(m mk6vnt̫_:_;,aAS m^:G@Χޢu}K=Ju8^u+قvmsiDQ"K1#-Y??߾fVSf霪]]
cGQa@vt;2"2/ԽbTrUe!_QdRѕSC yY9M\?bF9YDѕ$jխ;;wECuq2# rXTf=R _G?i%nM Hbg' 1g, 0}~[ G|{~)J)Wvn~flL;)Yҵ,m7λ =cú|\K Qxaz],Rer^˧tMڢ+g #_d9zuY_WUO=m,?(
/ Ə Ujx]6Hyr~-j&aW⌕$ }ґţ%Ss_-cB}9V9 _ԝ *=q4cO >>Z kfH|j(:̹E?_>I ױ ݈/8V.=~)nKg/[IR"2JiHvYD_[ :\aB 96[sж@AQѝkukuܤ/9ՇkN ?>T2T V1ӎOoDgפJ⤱ A4/ =
b$Z!Ȋ^,ʺ.6yu7mU2pcӶV+5܋}y*_
AC PC m?2Ƨ%
&0]֞B r)as[(/_ׯT 7oj1)A 3w X#'GW7U~cu$%ܗ|/?h ?h۾lz
ۻn_8 v8 զs&@li}rR{u}_f1 B2Hh$[@#d
۲X!K%#Eyy{ު~]]UY̬cC8[ )u<Nv6P]"8k5UsTh}ҘE=U`a-_o^#%G\3Hǿ;KG5A+]pdG02 ƿ|xW0x)A{Ĭo7WΎp sչ`$t!#fO>{N{9,̂
`xoAAK_O9c#V r>l[c {uDG9| %Du9II V;o ?fSw\V` ILÀǑH(*U
/_7jy
êYN`}Y)cƖRjq eETe+GsC
o$mZ> o/?w `W
CdYc_@4 Z0y=ۜoG2 ` =
-!qON< 9ba&Y
X ![`u%F9gR8V_1 `an7G]
[oM?<3V`y;oA| oSs'9W{ix?BE
cuCjl/`7gsnV ;۞j{JYdt5X7!}oKӻOϔ&iLJc2FŌ/~2o,@M$uALnS *зoIP3c%aj: |`D_Q_V7 N^ű l?|q
U
EVAqi`.ut|9ǟ @ U6R %svsjS#l_0 % cj~{v{߯\xQA#%64]>JXz~5 `6ћԊG*^ hFLjS)Ԑyg䄍'rꦪ`翴 `,|`![Ym7CzZޕ=:5V3 $JzD s 2m {id;/dE\֎r`<0#F+SRMXs
j Xɱ }_x0ɶx *KH^/={|blZ9Jr tȕ9}`|uzD OBC^2)_yN\264JW0a
r B
|T{z5_91&]|O.iO?sܴgY ޅwn>~`@8XKӕ&' HG¬v"07v"UR)2#!
_!l!2$C8af\3d26&F{uL :(pl0wJw&% #- j8I2RseZZ9gIVrX6nkyVgFo#l9i[nGe 20Bf؉h, ۈ1b\B4݈ەĎM~p.v&jnBx,F+_33Jt! r.-,ogJ)Ze[ DK. mY!#, @_!w/ R$vB٬lm G+i*O +vckUy Sv'KL
;AZ4Y4`1 Q!R}J` A mTu-+@+yJ1Oyӊ?}/*ALD=#s/_9 h8L9v_7 Aw {L~qi&(15!H؟U8:p5``zRd,+f| 6J[|ۙO8. 06dGGf:d:uM7;dz߭S(4&i6fa1,4LZIS6
X8=@hBQ"It`ȼEr>m!eK`cEZLD"CON5ݎ 0.f SGwq~X0TtTlk f<Pᲄ8#5Aۑ͆2$C0SMH{4A~?8
L'm RQ H$zY` 0 A"4l,0`eN[3] d`m{;ߏ9
!Vs{ONḎcP6[[Yɍ$w7t\vv7BGךM qH|~S 0{>{߅}-[LXV{$BȮVm_K JH [Ǭ& 9 nmOkfzG,͘jI& =( lM?y {Zm!NW(SR;YdFB2N,"d@T^w;A`Z0Ih
a< a#>]eCh!ϒL#Ji)n2vOA R,Q0[C; I1D`
`m.ޑ5?v ,#ne
;u씄荛k03 ll ։KPlK>z;W%[PrLٵfʅ(
ɦylkP@
\X l =.#ar.A,'6()|~<ُMH{ Äy6umC\g~˥e (S,n9b)88.",] Ùyz|fJ7ܣbw0)kEZGW1kseLUan tL`ǒ@aC!
-+5{vnj) /g/(>:-avAv;!>u@\Ȩ`Ê'c:aдGԐ :fxR h+ .z ͮU] 5P`d 6e'9
0^6Z?jزl`ە.8^vs"^m CC[cI YTPtnL9Abl븶zjW N0
eDBovu!&,V!eJW1M#a ڈW n^"0bT <뭮ERkK^m: VP LzQH~=IV)' - ݠ;$_U XC=J_Z"ldYc xFrIy;Q}
ODgHEv{O 8c6+'TD͐mL8MC}7V7>I%
kovZ}B`aӼ l#[,Ϟ}e XO|٧F6R
f rlP OZ8w 9v|8E9= Q ջpQA)"qL.JIU iBuÕjeC|0S
J ``IR^𠳅mGI8W5}|R,pJRlYճ86 vͰ {s$vDy[Ŗ/;ppolo 7gm+&!{* c,ݒ`!쐐\XyD0P"hR)OL (:xvʛ۟6}?WٿŨuNJ w#Na>[L9YPPZQih!l
uv<~gIx !$ ,%c2&дua"8IO~0,sS{j. iMܑ{s1JQubbyv<3V^-f
f- 3@P )ڒt u-am=V(ewƿ=L DLb_B`:|
k%|A)K p̄q&u1101?%Om# P ,b^
0RV2We9&rPfB mEIqn߅&dr3ߛ,_lx7c'bO|O1Jz>T֎ZD
Z;j ľ րq6p0DQ8+yj]k Bɢ7(f);pv^11$fFb'
nj'^E{MtMuƔ$znIɱ(g]H !K sH{ |fAzG(I{(H{{]a x0ej9N G k҆76I<# [툠+# }c*3AltSZtI1so,* Yv(}e-1A+qk X ;[knB.hڄP@pLax;I
nX* & ^ nQveV"}kԁ(.ZRh1繥: p(E(&-W g5P5&
Nɵ &;c>vl.gB? "V6#Xóe?6n $83cfN + iZ+st9D8CH]g<x(n`"
r<J[hC @f,Yo}+/\r
(ն3f [n5x&ZȰlT{ }7ZKohC6M3l1,[% G X )2S.=%6W
?8Q+ 4cjyRr,U<ϟZ_~?dw]㧇
fYl ΔE}#ڄ2R9NǷYʟ*XփZz)}`Xu 5HZ;TJ zX2ajrBp0a8˸d[h 'S6Tz⁙͆/vwzgl5DZz0Dũ7@*3
㩈 ƄdS세9H5$QyEAH= <N;ҟ@gW=`ftko~zX]4}BJDT6?umn1Ivkؤ>lYE8_!+} 쓏QQquZ3 -~! A:Wy AiZlYrk&w"i cH ~Kݩv-W
Z"/N.xղx5, Ħ܋\Qj !_e:Z:S uvl!҈ !{yrZ*;cG;Tp$L8mVB0
5'kc7u|:*so IKV:ef\* t?an>ҁa~̈!!@P[ĬEZ=Z$<`,mGkel@ f
%ӰbQ0YCv ;rb P0kS C[s-#\Lf>^#%@<>LX *O&\X|D2x&(`$!l21#6Ïz 6c;U$ݍ%ܒ ߞ5VA>w>\ }̸jhǃa@rud9 BM-?ьsh9dp%zZ1v|z'
DiI"_DP4e|εxS\$3N7ӻpX;Ս b:)RjveGqc6
=R>[=$h3$| BǬ@ ,@YBu߬4 *Kwn`/Qҟ D0 b:#_HpL>C汢&ce&ͨTj̏O%Aruh$9JnK=r,,) %Q ) 4 Q 3#qґt;6{W%n]0k:1p]m1G(yضmzUq a4OmxYI4I0 (BeQ(8(uu]kCW l0]@NwBh{pT' aAY^)yւjKpB7Oh|&j7wdjrjqlpff%m3gotW4`1d4H9 ml,WDr'2+̜Lu%Kv! `h .\vb챿Dmi (Etbhp)gB5cqlKmg#HV؍zlIQ\QW\
mB , HeD!jԍ?E [zbԒE_zk'N~"(cLpV *J^4-AH
Z@lc%0V{ìT2WW7`He Wŗ ݚt wH_"BA2섔mx*r'q ' (FAh+h˩s !v= @\щ FPTu \%?o~G5W'Ɵ~фfjrqWu) Ji.H
U+kԔfX :3zڭw7R[1U%ӹ lYS@
cg
$e/ׯgI:DLlk9;a90d$44Q)U#дL-Ps?O~lafR="&*NVsv6ur*91 x@Ҫ_Y?Hw.EOHb0%p UoJLY9KVtM9~7}P 1<Ѳ"9eh~@դZeflEoXیKڿ Jk 5?[!
Ŕet5|W#| pmCtTR}'N't86aXoR;`8HJ\q1쫱nuA?5W-*Cuf^+}EJiLqqz_j:Qcz5ӥmNֻQ+^XH Q̊߉$ceIkktgN ?p1 7z,6 b R"ܩ2nC:7]t zw=ybrP\ v}в KV)KLӃ`|Q~ "Ht0hv_ c6ii` BNRK7>6T&qP6R2h^}g 92[`o s6AWaL}'4w4 zsфJkWz~$Ch yրe_y=22 ?F̏:8$8=+FPLb~l2Q\ʅ1ѺFO?HK9,"t7n6 |rʢt;Sh c2*y FSu!+'^JEb
#mJ
|_NݫqRn- 8I"k#4L+`هSxK_&T~Ewm*2JzpDO!k]r_ z-<%FwqUV&
e Uv ) +ƬWÂm /x( q~TS3`]?\ X#Y~C] 3m
-9X\Ih&Vmo>6Y :_Suydjʏ Ѵe㕢Ư.k?qXRSH? *ͥʩ(%(筼k!b$hVVO)uJ'|c~-cNEQtv˙"m6Iwt~L"bhX *g`lL&' T~3( BWlQ@dp?ꅕ>`U1jc4i'H:!rܻ=I !쩿=;6V$)`5` := IlRKkY.w ^j Ĝ !y0!H͞VLc?Y&JʪʢUpb 0,yT>{I2bp z :z÷oր3MWpO.tsX*6F&3q6rUpkCe%Dzd& 1XҶ=LՋ+ij!~Dd xcAMW@xv 1mCՠPHyci] 4ZznYbh
Ϟ%=暟~y-YņEU'N=32W^z]8,囒 X`Ȅ\(2
ڶBtTȳ+mZ ڝN?>~X7Ѣi3a.t3BVrQI)ä{ΕRN\PEtҍFsn[fŁ |S4nX?sa +X"fY\{+D .Gg.͖Rvت0Mi9\̂P [j^^31xh!v`,]XTV$HOOm(.+߬wA+~
G]V^씀;';L$(ڨ`O jpse>ۙ&- o~Bz?ySi+`Aϱ *5@[V^+
w(9S \5* UQKzerfmVÀTK u1@;
{qP#e̴Lډ9rt )~э!PT:cMiRūa o(/-y>n=27$/v l4ChW.p_c1IcXcWa,;M(~*~v֞M{}V@+J&DAN1
VFWU6{woXpUjЃh a d~-bwhV,b?zhlD]Osʔ&C,Zei@OVf7^!2C
w,!
d E- K
Ȭt]o$O׆-av[XẈfr4vf_Z#HEFW ,8NO>cJY@2U x8T~,xu4]AT?X!-AK ,ޠ+Y,XdJ8֛A6J0?3㨔%rCPG hjlhWAmVQhĀ͎&Dž 0keMWjو'1=Bpˢyˏ8IZG.!wehEXrE 茸iZԳk!DU)6OCCV-N ;'Ii
jȀhY6@{ KZmJ脴'gd*7ld:C l
Ē(
V]$r݉c; u q+_ R!V]- MX GM&\kr] " 4A+l9ٹrw
r/
~%t Q |#Vz S R=D3Zrs:ڰSqFҘc`ioNљ {(WUJuRH? Fՠecl 6v(W,bTQ
Z8'1QtJӕ|/gnh \Fu;ځh3 W;a@_%l2D
վߤxc5$۔kK$SǶnos<+1k1gqeOŖwIQ v:̗#G8>m\0?I85Y9E[k.b0KY$QVpdH5g0;J5qn*?Q]eTAÕ ',րGTtQ1̊g r}[8aP0,m L kزL" Y]5 գ|6黢 @J,'@2YhjR BXRοƖR܉
&T"ܚ P
ꄑ Aܕ)J[qh
!x~||hmt ŽBΥaXC\7l\RN؛b8
& `
@蕡[b ր+:aڨe4chVw_֤rH=~bb!~zH BPwjRܥb!_E~51#4HH"dM7fXXKdTLe$$`Lp'
#k!( ^5}_{A Eێ pm7-=^R^bs F@Crk [ٙ JUzWѭI'B 3XS 6o5W 8gh3goW'2Z/}15 >vj?+讒8kDYY8Jhps-Z1LpX-&0f;iu ar
͜J7mfp%%} An
ˤ
f]ϙOH cI \*OB;8@J^IIxi6 thtiX@,0P&-G ?-)Y*k1[B\M߂YfVƫZ%N"36\@D5ƁU*!cŴ,mzu $wF{/!A6۵WtVo|<=e~#_Nx]h۟S `"Cn`vQC'[Ĕ/6U 71dQ&YWex=襁- fB)JȰaN!
n[s}v!cx昐6IY\_kwafD5]@m-4dZ{ sWM0h~'q,S
3p-b JzrUTY B05מ+;L0]r ,-*N'0yR( Uɿ$\/ Y֗'l/_<#<fE =75Q*U~ a u Gcƭ`V
#&W7 p=Wo\wս[kWVչR
ܤ#ǵ0Km=" 264rN~k=7\֮}0z # NO>qzFₑb,
XZRB-X;8j} .{ $y;- i0XR
+r1Oo+=O
V=No/bDUty;n[$L%nĥU*|zecc'VXouxNzRD n>):SͱJ6IԒ Jӿ A\$2eI`XO2@L;M Eyl
͍(F*gt^ ~:vXaؽgn,%7 eU6$1ֽi(UEL-UD7D@n(ұi#X{ ]
U}G< DJ iN$erؓ'N`"'Ѐ$ CaVf^_Xz
k9L 9Bj U B
@v (!ЛE5\\imL홊W,KXqťDJ 4?CAj1_{N|pe~-
'UPO7E 0\}pߑj&V>#څ! Dn6q މm[j;Mܥ@N^BxKL|ZE1톪!s3'O 9ҥ3ÅfHRmjKkHۏ]rU !ED,zVjQZ"
(?VZ[h;iPGGdբ&n6rA֗ O~T@s4o.]YÄQ4(i
Apb }3Y2MZ$BHj;;7 !Eԫ^msFLȀڕ2S&(渷ҕOh
iO:SF clh!AC @xc:t fY3ւCeVdҤON+q < ~W9F8'Y$
*YpU7D#B"yK$Lb
<{#z!, 'G8 oc.j97-w
eGras2+]
|n[ml,٩CA¤.n;Qcd)|ggA''Z\^zs)cA*|
xJ\ :k|&e}tyWjC !jt0)g8`N0YL[i0
ؼax q,% ~v)tm ?]lAxkW1(#:xB|Yfee`%J¶T B_nK FBC/-aT
`\.\Ơo @&,
Zuf8S~s74X2HehEZV/nI{ d5UOJa=սf~DQ.k3wt|0|X@@ %jhcQB 7Sp-8@Rg ^Eގ U_i{h3ӰkjaUf,]J9A@!ۄĖJBukkQ&&v7`w$7b-T1!6W;* \8K.`>1^Pt+S Mkwn6.,o8s䘓
i .Ҍ>c毽v_{9Hb\XYr
8W6:Adi!5ю:tD0Gz h EI]aeDx)yH% < ͺ_R-Yo!D GXbAT+-]sSշؤRrbV
$fr3#'J!$d`D =~h`34!Jk
th\813A0@WL
܃^@ X\zS wn4A@$qn鶯0ZS9(ad3L߄ײww!^&9SZܧo._Yӻ̐ 1\ϾcҼse.Y e?yw̢ t
< f
zj1!5&v0ï;uusl:0]-ŵkyVq:,IL a, `cٱ|H%`x"od-ڳ df
.;ۆ a
J7^r*d &y_[})kU:vk̭HJ
~e=<^5 ZiUcPGk xK~鵱"s'\
=!Db>2M!D1-ԃnG$F,UE[#KbgUdE 0* .mLb.C:66H$dw/f cMj[7*Z(XE!ż[ 郤{NR^XjqmU2'qUZuDv7̹R{",{tL @ &^ G3P B;O~+"ֽ' %ls)jΜ X
7>X
% LO䑉xLc "0^23\wbAJR$c!o>;㹫` 1eLG,iz@;BH6mbFfu 11PF;kHiFv&iqR +Wx+lKJ4;Ncȶ_O[)?vd$B;F`0KFA.W1 4LbƊj+܂#JVYel# wƠ0xi( 7)171 ?|ll;!g﵋s׆&r(f dA"Nx&Y^F秮rt ͟x
j4U!e=jf吂%DP,2
z3{cZhWZC %
wbXX ٝ.%Rfoa`} 6pߊ8q0 z
:x4J*ML." ^^ h}A?9ײ{>a
mr4IrnKaȏXʏ v
π (ʸy>i IOcaĴЂީwô"=$DR}60MXel'\XEU;6n+աU9K.E+HAԴ)6B3Y ß6GKO֬q+%^S?9Ȭ
uEYkv2u z{Z2
{wj %;sn{iW?9{7r
Y$ C Ҝlx'`cnZ{߈ +kWk'ұvyi3D}$6 4KR\X* v6yf̵$IЦ'[@H(TI)GXQdAJ/=VPAf\JlMG^=ba3+A¢C]ۖX6=IBnߊ@ߦrp!(=TO[鲭Iq}ޙgfYK( >憒6(6WmpT/7֛-ƅe1u np/?biӎI$Y6`.o.8|?[I(]HTx bZ *gS
t#};)J óF2?@s@Ji R@y58iR#3 LI:U;'Q}{)2-ۜmK0 6K05xSڇ2bw鴉= ?O "o`rYJ5؝`11 S6gNDMB-aL-~Y&ʃ,LH`)aB%sgsc 4E&f $66)((\ݼQI"fM\mz0f4S F7 C~@fIގlSцmQ*-ݵ5})6Њ2 )R-K\smɹML,!#Sg&oٴ[gM:@8 Z1Gt8aI|?*^{M\D%Љ sbwDSqUd55VRdK]]0 8ig[6 =!VcsoL$ILX!cgOz7Q玲>˛7;/Gz>oD pH_`Xk6Ef9$0& ~R{343
t4,!9'l&LH?VM9zC AIb"QC[ˮ{g~Do4i֘n+ V]DubnPВT iڿ_Um0o,_-tWO܃ 0k0lNCa]!MPKR^{IFq: YcEA
uVr6D}ÃVoc+$t%IT,ßձb|{eoN@b )edw 3*s
Nxx)g4á2۲V*8I (xA!X ly#wuq4Z! O(+2c-ZM΄cڅG .# :ѡlI^Yi{`7t0\ j!6Sg*H zzA'wV^ E 2NJ:BXJgaTѵvtrPT6: F{@2>}O7bjm`q ;Vwc6Ra:ѻ7
Or?mbǜ-b;~Y2gt(c\rNq(yZ_HwWK%5( f&qY慨J'ԠZj%`Ď<|뗤eB_I iՊ_{u 暠tGro b~GKJ1K
5W6k/# So;~õ `1|p-Õ1
@YD`[RlVh E"_ !5 #V &4M#~5`I"J۶㰳4Fb\PЊzE^S-heKs-FΪGAfJN veС?
+ YQʶX$ HJY:x9m0Uү -exn|v_K1+S *rZK03?ٙfS&!0zv恹/z5B. n`!px8u]"POq(X1;9vrwL4ik)a2l>o'/\iL1( En,,zUzЎLNLeX Ǣg:!P8Aҫ`LI@ 3;+Zp,gt?$wřQwWuuy=9jM.$!YM Öe
Ȇ`ذ0d]uEq)qI.wgz<<]WU}tu~͛/jb6?w dQCa0J]>d,M,?%Ȑa̋W48D^|[) Bԛk ࡩ<2vL#,nkNh]%Yk_m8&sC2*NcٿX[vH5w6n71f "&ť\oC3P% zrn 1nq:?[1
mfn:wզ3aP1,W%; @Ĵ V r+dBe]vd~ٹKlr! 7H_L( k zˏՎI߬#U
c\*lON~Yos?kЫyJrSE-ɉ1)k/W!
g[ZAU% %*;AN{A,4H$ 6kC)ez]%Н"jRrMhGx4!d$l/{]!1R讀oP] d` 9U}j}Z\Y[TCU )=1t$-TpaΒ!p)} ubiy^]U8MH4_5 yҸǴcU ئ0M_ 02%UEsƧM\7Dg R:0IE ==[x :]DxJ+ ;1Ẳ q V x`t|
yGb Y m
n芫)XD#" 빬W
Y .ԜT&h(hx .Ĭ
(|peJBϳ!l-_YOw1!&GYĵ QWmZh@5 |w7Igg!@a#C-E(
X ,6ePEY_kmv6Q .WN P5op
hH 6Zާ[ml$uFo'Qm 6s,<\tA|𐊼%l3e`)
n$\{.@x Pv@j
$Bj`➘E$̉mt6P^ֶ3qZ $/^I@&zaq#,!\/q o:WJ E?+I4O F!B`'&os`"|b!d˷mMy^H`9`jmSϱ
F`1$(Ƭp pC
@*i Ƀ7 P`]7knO& 8scJ*H ŝ&rö.A0ri}~\w|70[79]PaOmBdvF-3 M(B>:#Iv_ Yi![t<ިsDո&8EEL H( vrTo@zP
ΒHa L>" YSZ&6`RL
#9,h%0 /o78@V"E.d+ hH@yMaBP+9&B}RFdX
S or5 P!H:E" pHK-1V OB ̞ /l + *Q31 !kٙkBp\NJ{ӟ.!B?d H9 ~TǨZ,0Ϊ~yø9Q mʍx䈶Q@FNيQlE4{S
'u˴qPt}R.tBti >7.$ l )T5ѐhm6D Nj0_[ƭkn
5K yP,^i@4fęzlVҶ̸s5/ ͏LnI\GYwܟ[7fIlՀ9.D5m!il skDͿ >;k %Ka52N1Ja nlRc$?L:OnR%赿e21 / \d̀ M>()RLm=ynK*RZӭ+~=W}
-|z,vW]L66)^ݘ9]"cۥ=U&έ?/ͣgg3PC||؋ =*ު;
,`aCǦ ":_{vܶv<tXV]gN 0|vМ χp ͽ 8oiTP!V4?go~>9\Z0u ! )Dj}c>H Sܨ>.F2 p x%zo4Tu{gH~-.IVfSAUM `` ^g'NqREaח f^s8w
DZ5#\F
$17R~].D+
kز
a.mH % NQk5GLbș(o[m&滹0V+ N4!Ju7|
tuqG0uI̤c6t-^2u3Ia\gr : C!k|\a9f W)b;;Z2Yu OM1
"vƫccߜf] ŅhV}4a# 5. +=f?Qڜ*9Rmsij^fh8@אCBw5-mOj_!XB@(-
>=VMo8rW р@ EA@N%c?97znUS]e<=[,o^Ya|( ;+}&y2 bW'/^@)п2t+ *o 4$$ 12gOPa4p%ġD 8虅Ս-850~zc1y RN)W! 7]EA"5<Jr sw0@j R B !m\?Ya ؍s߹tk\ύ\nJiJ1&VӤ`7cE q s @ Ǥg^@/B[
X:TP**`kwS4WZܬ4/бR1^]/^jwtHzz[8 Y{
j5Lz~Ȳ>
?n;R`yCuk@RpF) 7u?:IX묓mJ= *%IR V khwtfN .]EJ
ҽ,"*u<1˔p*JJ#P'
1 pxm(e "oAL0L"倖חTB" BY (B?HX8)B&/-"d6x4U`\sc T^O1r sSxDH95e}|(]d>=]ubNYj h ]:3թ2ǷZ2V9p3eaEiB-z,\p
kô-3
]J]Z%V-գ~F8-Sk)DBs0817=5VӉF
) <ǧ pᩲ c7}WTOL
YBN]A\ i6S*!H?$ĜrqM76Pn7j݀/z?|kX]vr5-p4S@'u||J`i@J % Sןyz5 D*Hi$Ĭءl6Tl`sH_@Q߽+)*ImM J/Lp oO &;Vi$%óXkkOMN&9)P9foPtFNJ]hxB(MZK9#y)Q0IJPeڔ0=-Ѷ隣7ֻb|K ,NЉ}X* |gLR||;撽
e8:w9 v!\E_qgf4mq&7w*!XG`"9
Rn{ 4#ݺ[?qiKYr Ή[M=vlwݺ !n 2m_u] *4M[:{| ߹ .(/j@&Q UqUd5 ٪3pVdZ
q^G1 i~R!gV~ ѐhj_<7a뻤9>S
:̄(z1up5Mx\0b=6Q33Պ UOM2V4!>{YBpWАlQD) bj94h` l%zyCjDt-B
)D T,e_J]6=;'ouXpA Xik
WA*gjڧ; GfeF>1.yXR`>fx
ѕK~l0^HT,7wo)g}ӹk3D. $L7DrΨ竢)J7ᕍf3W3F %D!!D,l67oː[%lȻzHD^
J3 L_=|Pb#Jٵe BV%-[ů F;iώ
fLTf^X X-n,?a9<*/}ӿ7a.O hۋF' Z\E_ol$BеGkKFOԙ_8 w
r]:Va5Apc'IY^2GB IĬhy> bR%#
!؛֯"[ka , l6_IP0+Yow֝@:ʏ ~zkzL)A7[FC.0Y- a,];qMFD$DqկR&=.)cw
*
XM
w h+mHL}eh$4>~~fk""C?`IK= K`AGۃ!e'@iJ+& hdfYg$<9xk#34ܘY9%!dJ^ i O:ҙYgy@4ScB9D EL 0% v m+
dTte!a&G
6G"
Gm1p=xD
vM1tҺR|gY!=>YR6:6f_[s#'\]k7ݝ\:AMbLAUqy@>Hؔ2f \##A\(2
*cu`
f&$_l<]:A
Xjab)gYEd4yfKWL[WaɶZ^h;R:#C6
I' rRvYQCۡ/?b|OJB\RK >6fk3D4?W 7 LWu< 0L q8Zj?>N2 |hOD wA_>8]8B\e =fŀ\j xW:79Xq##Z +V.~5헞ƶ]C)1AEvYV*@ W(IO5U%ٸ'iȆLĎFҒBE :hJ[B {2Vz
Az<"-],w;PҐ"htҧ[⋿eEWJy:ؙV۹~*ȨT~4 Bvc%=4-<`Ce%~{ެ|cNB})`oy86 q$JO_LD ! kg>Zѭtgz;ș\4}芯+FJVH]'G+W6#$J)i i*.ȌɕCi4L [:tɭCWJvm:]p2kιI"3A:yZF+哪GM/ (EP <8-?u'EJ
݅-Eۇ#ˊVcCu"1wB$Q?ш iyW mxh4&]P-_?=tq R
iA~UYܩ^+t(1"BiZ̔ +[/k=R"O 3$ B${>.0GrnV.-ӌFR9vd
)ZԜ^%RNKI1FPgfj rG>GPoAC͔#ak0K<ʟJmaf ^7ի= ZAٗ 3G =qdr!0{/RERƻNOԚ\ͻْm!
"B
ϗǫDW 7#-Ss\tzV01won|zwk ئ^WJD1ŨZlƌ%jtd%*rnwuy{cƘ4Tn&|2 i J Kl(뾅 'E=0DR u.Ѹ 95?XfL>& V"VS3IEMM W$e+ϛ% - \r!TrCqmix UqH /YѸ0_{ƍf? AF D
¬/\)Q>s k /ِE1NXʅW ЮbWﶵ$@|zɝwW>oE D2aVh8ݑڪ`O%lxa
Qŀsu
$AbGWawh9?[)Ap__mz![kz[ g@U]`jU<
pAF p ) {8XɥF4X!`8 N='\E0I33h3m\eIK"DTh\\FȞkb(miA cЈ`諧7 ,GCW2>o +I0? \j&l4Q#DY:
` #UH0RbAdUPS3]w4}lP
n㨑Du+ X~ @La֒9m~k:R9,rK0F.c)khqb$tپ0Ʌ\[O$T,L?zXt+դQK/<%\rN}GʗVR cr@FyaD9 7~@7y`Irh/(: Xʥ8UjhL+يw6 pE Op5%D#*XFj0i |U`qNh` Kae٪u{{5F2v`R pXK=1_wTT2(B
={w>y4헴gDV}7&@B}~1C,Y& d$$8n6cE+|>@
B(-{5roRr 0e5sPw4눩!̪k_~kWn\|SUqXi
/y6W2) y,r1k
#M;{`F#2>]t"[k+-]4B_$)I>}+4cO }jf@v~Bp%X#dS`y_]CWN^W M|,feh~pf Z 5djchazShn6dbTɝ !9m=[^C懌-n qgG(}A%s FE +d9g9L//5}b*'&!~ʛڙr4B&խ2N0a)Jcpl̵'k_^ MUˮ*V1䆏HB/⠱pS¼+{ mMgKxO*B?|ιZDđ/1)Næ tCHNHT lNG$1բZ7&}JC_
E|z."o#VHjɱ\dqý^dž q2ƥ3pZhxF D #]˾30Kx'Qe7m Z(~/+}Xܯ:X=esNΟGw9Um-ɇ6jPbIx`Љ 8YjZ`2guKr~ݮyWmp45[ͭg w*YDGz
QQCUGk6Aжt(Bd{b9, rE0{5mG"Y3A$ûլ.?Rmz/Qސ_ jy>u`~wդKKoh7O VjGx rN00 ]O$~ݥz^yYw_y,xLɒ-}cz O)`Y,ƬͭM ݏ`%,
v*0/` osZ˛ ?
.\aS9^rVJm `%u:)Jċ[1[]..lBw,-t..0Ro<=S\Ļܑs5ԝ@UB<1K2(lArGApXgXr9B&b֫FhfG2<
~Ag35K?'(1 ?jIk0KǾ͜K¬X:4]4+'R;٠rݍrsŗL}l!GcZKR _}$DCӕS7F+vr XgNjf~?Sӧu6X
s_Jx.p9V/53$$D;`3r\//hVIPFF瞞-l?zf =>.. B BUvgF0&M,~&ֿ Ͽ[z̢~Gk;!-ń!'3,İu8 f#IBɲث|a _}=g~f¦n[z}sj0){V4Ha+/d`YHUcfi)E^.?qt +}Fg鴭{0F\?^ӀuED]d% x~f^̏gweU3 f^7mJ" v * ~_`Vgf*cE (^#I:vTw$5G{jJڋ]-j+ Yl 撇JA!m/evA0Pi kN=UPcH T C7H`>LQĿʶD;۰79}!}>?LKЪI>-wͲmk-v.ŬY!Y٤ "b^rihX YWiY 59)\cyS# +oQmeq-N_8sJu0|굕&H oAAsZ G[I(13 =F|~>b}@zf|yf E31eb!mSrݹ\o 7D _٬7FF aVP_S!厛$YjS-o;X`]h'F$}1XuLlӾRRMt .9E
ћ=aLؗn25dP-~A ".3.ss!Jɽ쬷 Ry s3U*Z7@!gL;R-7C|3B>ZN[k퐋~VعqJ)ek@Lj{jEH7yc !#\|NT| RN!BZ/Uf\t)iMT s+ͦ УSoZ#
`M^OQHӑtB K#Il BӷM L\qtiLY*UxjDItL4j'g#>vdm8øUhڳp.f+~A@ C@ԇ{3rvukdzh;AHSe%Y\P_$!4 s6"dmn&)BC*:=,;`9HmY?+@)jr gjo jzau 02-%<&'ΞDoh.Jy;ӘDp5
=6?NL W rd6NhG\U 4`$fÁ;9sRJC7^8w;@L_f{ 9@r'9窿'$RZnhHPHĺ5AZ)Q:!h?Iu Vٜ䭳4{5x_w-
I JS9(4Rh6uAtt}m̒Q+Y]V 0w]mӇ /<1YD]A~t-Z !!Bi#.aç:E[XŜMˈ'44M+j%eo+q, >Vbgi!&|cA$4t+U^ z4LW6\Zn ,Np6fxbavtfj8@
|*)5 Bn ;oMv/-p=
%$BԎd!uAŅa aHR`n/%i^o )5{%3?@zd\='3Ͼܬ0 U־4=9u)N|RK` @McX₋ C??_4)+obtX-xϾqN"BB@VbMðm[j't,lR+Ŝ'w͠Y< :; tȡ^4 dAHCyo:Z#,Z5ʬƥYjQ JL/"$q`g?ghgNL].w"䠘 4LЪ[-sJ#
yp:BJǧ OQFs .|}t,nGVut, Ht# rC>@asEYF*yb0b @FRCCT`eYֵ>
LcZ?@:T͞% -$z~FNgraԑZנzͿ( ) !L47Gۏn.~t:qшٝ?^j]Yi.y!go'f )o CԁsU+
_{iEZZltk asa@O].zc]<:n 3t즎폨==iHֹH͈3yҟ|qxxAzs'hQMj9
?y# D%$dۢ)9YނÆ=^TN`֛?>L#S3`%rp:IY
&
Z]eכ[o?;zϾ4/@Hݽm ㈱"5-EWuzeO@$D܃GZB+p h$KSE2U4mԜPGWV6/ySIn *ۼkorCnA_mN4- bq H(l &[i/<3:jl5-W3s <IB&g e9 _TU^!3$eeC=u?u=7^Z>Wrh0'I:dA(ЕZ=\iTÚ"t0Z%TMv[2Ҧ|'` 'nu!Hߑ0sEQ!IR)+Re k̊zUꒀgK6-G.!rG/:`
XLW \3pr~0 c<35s-p/aϜ`FB
;ڀ
.cHV5bfD^iz ߭( |/SGgK|L;tha u<5m41
I[ A`,I 6>h$8nkX&'v 2 ɦ\o/ۏLٕ3yZ r *_Q/É(8l5տ;vY {щs[UcSGءZ
9 pA/۶=
aʤ : vBM2Q47G*곖oW{OuS3Z{tJ79cԧ, NO_dz9_*Yx̆8F+E;`FCAq 2Ac
tr}KΩ_NO.rvtza65!ՒmhNUU#zkyvE Q T"{ .5ư˭ 6hb%>8
9 X,
?yy?@}~hff f빞L(O+ a|0E@BU,`Nq! D\a `Ue_ mCy)0o( I YvR# F 'H"F'2$q[s14̸پHlN RFW7 X |J2"X:!4ARP ZnX#IAlRc5g쫴N d(N@, X ,*qXHR,f}"J0㊃;j3wࠡa/\|^Ro4(h^_lGm,4j43"H=1Ki%4D?7Ժh륜nu xVSWr}h_]mD [^HCWP]R4SvUJMZSyjU+/Uk rAiq5xsufB26f
uBHit$dr=2usT+ u"Dg%1;{4F S
8DÎm/lEå-7l `$ c.eiW#ݓVKTwB~X$ :T~+a#|-?w(c N0)!4MLK#º/$օ#u~\Alէq|9,4T&Xu`c "쁀rIVS !:lS ;Z)LUG,!EX
H50^(k!8IRwUb2 uxgTLVj~/Yx =,0MА4?rldGyi=f/|&]!=!gε\<ƹk}̿%ƍ2@ܮDĚ
䈿Ix$ЊP#pWtuf A@`G4! &lo֣E}j혤f]/Jx%w }>X3eH@٘ե3.daHr!@OiaZ uiRnmå$! z@Q0ЌP&t*=3Uei=k&Я p/ȼ >>Nf7SАI\ IENDB`name = Image Styles test
description = Provides additional hook implementations for testing Image Styles functionality.
package = Core
version = VERSION
core = 7.x
files[] = image_module_styles_test.module
dependencies[] = image_module_test
hidden = TRUE
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
'Test Image Style',
'effects' => array(
array(
'name' => 'image_scale',
'data' => array('width' => 100, 'height' => 100, 'upscale' => 1),
'weight' => 0,
),
array(
'name' => 'image_module_test_null',
),
)
);
return $styles;
}
name = Image test
description = Provides hook implementations for testing Image module functionality.
package = Core
version = VERSION
core = 7.x
files[] = image_module_test.module
hidden = TRUE
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
'image_module_test');
}
if (variable_get('image_module_test_invalid_headers', FALSE) == $uri) {
return array('Content-Type' => 'image/png');
}
}
/**
* Implements hook_image_effect_info().
*/
function image_module_test_image_effect_info() {
$effects = array(
'image_module_test_null' => array(
'label' => 'image_module_test_null',
'effect callback' => 'image_module_test_null_effect',
),
);
return $effects;
}
/**
* Image effect callback; Null.
*
* @param $image
* An image object returned by image_load().
* @param $data
* An array with no attributes.
*
* @return
* TRUE
*/
function image_module_test_null_effect(&$image, array $data) {
return TRUE;
}
/**
* Implements hook_image_effect_info_alter().
*
* Used to keep a count of cache misses in image_effect_definitions().
*/
function image_module_test_image_effect_info_alter(&$effects) {
$image_effects_definition_called = &drupal_static(__FUNCTION__, 0);
$image_effects_definition_called++;
}
#locale-translation-filter-form .form-item-language,
#locale-translation-filter-form .form-item-translation,
#locale-translation-filter-form .form-item-group {
float: right;
padding-left: .8em;
padding-right: 0;
}
#locale-translation-filter-form .form-actions {
float: right;
padding: 3ex 1em 0 0;
}
TRUE);
foreach ($languages as $langcode => $language) {
$options[$langcode] = '';
if ($language->enabled) {
$enabled[] = $langcode;
}
$form['weight'][$langcode] = array(
'#type' => 'weight',
'#title' => t('Weight for @title', array('@title' => $language->name)),
'#title_display' => 'invisible',
'#default_value' => $language->weight,
'#attributes' => array('class' => array('language-order-weight')),
);
$form['name'][$langcode] = array('#markup' => check_plain($language->name));
$form['native'][$langcode] = array('#markup' => check_plain($language->native));
$form['direction'][$langcode] = array('#markup' => ($language->direction == LANGUAGE_RTL ? t('Right to left') : t('Left to right')));
}
$form['enabled'] = array(
'#type' => 'checkboxes',
'#title' => t('Enabled languages'),
'#title_display' => 'invisible',
'#options' => $options,
'#default_value' => $enabled,
);
$form['site_default'] = array(
'#type' => 'radios',
'#title' => t('Default language'),
'#title_display' => 'invisible',
'#options' => $options,
'#default_value' => language_default('language'),
);
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array('#type' => 'submit', '#value' => t('Save configuration'));
$form['#theme'] = 'locale_languages_overview_form';
return $form;
}
/**
* Returns HTML for the language overview form.
*
* @param $variables
* An associative array containing:
* - form: A render element representing the form.
*
* @ingroup themeable
*/
function theme_locale_languages_overview_form($variables) {
$form = $variables['form'];
$default = language_default();
foreach ($form['name'] as $key => $element) {
// Do not take form control structures.
if (is_array($element) && element_child($key)) {
// Disable checkbox for the default language, because it cannot be disabled.
if ($key == $default->language) {
$form['enabled'][$key]['#attributes']['disabled'] = 'disabled';
}
// Add invisible labels for the checkboxes and radio buttons in the table
// for accessibility. These changes are only required and valid when the
// form is themed as a table, so it would be wrong to perform them in the
// form constructor.
$title = drupal_render($form['name'][$key]);
$form['enabled'][$key]['#title'] = t('Enable !title', array('!title' => $title));
$form['enabled'][$key]['#title_display'] = 'invisible';
$form['site_default'][$key]['#title'] = t('Set !title as default', array('!title' => $title));
$form['site_default'][$key]['#title_display'] = 'invisible';
$rows[] = array(
'data' => array(
'' . $title . ' ',
drupal_render($form['native'][$key]),
check_plain($key),
drupal_render($form['direction'][$key]),
array('data' => drupal_render($form['enabled'][$key]), 'align' => 'center'),
drupal_render($form['site_default'][$key]),
drupal_render($form['weight'][$key]),
l(t('edit'), 'admin/config/regional/language/edit/' . $key) . (($key != 'en' && $key != $default->language) ? ' ' . l(t('delete'), 'admin/config/regional/language/delete/' . $key) : '')
),
'class' => array('draggable'),
);
}
}
$header = array(array('data' => t('English name')), array('data' => t('Native name')), array('data' => t('Code')), array('data' => t('Direction')), array('data' => t('Enabled')), array('data' => t('Default')), array('data' => t('Weight')), array('data' => t('Operations')));
$output = theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('id' => 'language-order')));
$output .= drupal_render_children($form);
drupal_add_tabledrag('language-order', 'order', 'sibling', 'language-order-weight');
return $output;
}
/**
* Process language overview form submissions, updating existing languages.
*/
function locale_languages_overview_form_submit($form, &$form_state) {
$languages = language_list();
$default = language_default();
$url_prefixes = variable_get('locale_language_negotiation_url_part', LOCALE_LANGUAGE_NEGOTIATION_URL_PREFIX) == LOCALE_LANGUAGE_NEGOTIATION_URL_PREFIX;
$enabled_count = 0;
foreach ($languages as $langcode => $language) {
if ($form_state['values']['site_default'] == $langcode || $default->language == $langcode) {
// Automatically enable the default language and the language
// which was default previously (because we will not get the
// value from that disabled checkbox).
$form_state['values']['enabled'][$langcode] = 1;
}
// If language URL prefixes are enabled we must clear language domains and
// assign a valid prefix to each non-default language.
if ($url_prefixes) {
$language->domain = '';
if (empty($language->prefix) && $form_state['values']['site_default'] != $langcode) {
$language->prefix = $langcode;
}
}
if ($form_state['values']['enabled'][$langcode]) {
$enabled_count++;
$language->enabled = 1;
}
else {
$language->enabled = 0;
}
$language->weight = $form_state['values']['weight'][$langcode];
db_update('languages')
->fields(array(
'enabled' => $language->enabled,
'weight' => $language->weight,
'prefix' => $language->prefix,
'domain' => $language->domain,
))
->condition('language', $langcode)
->execute();
$languages[$langcode] = $language;
}
variable_set('language_default', $languages[$form_state['values']['site_default']]);
variable_set('language_count', $enabled_count);
drupal_set_message(t('Configuration saved.'));
// Changing the language settings impacts the interface.
cache_clear_all('*', 'cache_page', TRUE);
module_invoke_all('multilingual_settings_changed');
$form_state['redirect'] = 'admin/config/regional/language';
return;
}
/**
* User interface for the language addition screen.
*/
function locale_languages_add_screen() {
$build['predefined'] = drupal_get_form('locale_languages_predefined_form');
$build['custom'] = drupal_get_form('locale_languages_custom_form');
return $build;
}
/**
* Predefined language setup form.
*/
function locale_languages_predefined_form($form) {
$predefined = _locale_prepare_predefined_list();
$form['language list'] = array('#type' => 'fieldset',
'#title' => t('Predefined language'),
'#collapsible' => TRUE,
);
$form['language list']['langcode'] = array('#type' => 'select',
'#title' => t('Language name'),
'#default_value' => key($predefined),
'#options' => $predefined,
'#description' => t('Use the Custom language section below if your desired language does not appear in this list.'),
);
$form['language list']['actions'] = array('#type' => 'actions');
$form['language list']['actions']['submit'] = array('#type' => 'submit', '#value' => t('Add language'));
return $form;
}
/**
* Custom language addition form.
*/
function locale_languages_custom_form($form) {
$form['custom language'] = array('#type' => 'fieldset',
'#title' => t('Custom language'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
_locale_languages_common_controls($form['custom language']);
$form['custom language']['actions'] = array('#type' => 'actions');
$form['custom language']['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Add custom language')
);
// Reuse the validation and submit functions of the predefined language setup form.
$form['#submit'][] = 'locale_languages_predefined_form_submit';
$form['#validate'][] = 'locale_languages_predefined_form_validate';
return $form;
}
/**
* Editing screen for a particular language.
*
* @param $langcode
* Language code of the language to edit.
*/
function locale_languages_edit_form($form, &$form_state, $langcode) {
if ($language = db_query("SELECT * FROM {languages} WHERE language = :language", array(':language' => $langcode))->fetchObject()) {
_locale_languages_common_controls($form, $language);
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Save language')
);
$form['#submit'][] = 'locale_languages_edit_form_submit';
$form['#validate'][] = 'locale_languages_edit_form_validate';
return $form;
}
else {
drupal_not_found();
drupal_exit();
}
}
/**
* Common elements of the language addition and editing form.
*
* @param $form
* A parent form item (or empty array) to add items below.
* @param $language
* Language object to edit.
*/
function _locale_languages_common_controls(&$form, $language = NULL) {
if (!is_object($language)) {
$language = new stdClass();
}
if (isset($language->language)) {
$form['langcode_view'] = array(
'#type' => 'item',
'#title' => t('Language code'),
'#markup' => $language->language
);
$form['langcode'] = array(
'#type' => 'value',
'#value' => $language->language
);
}
else {
$form['langcode'] = array('#type' => 'textfield',
'#title' => t('Language code'),
'#maxlength' => 12,
'#required' => TRUE,
'#default_value' => @$language->language,
'#disabled' => (isset($language->language)),
'#description' => t('RFC 4646 compliant language identifier. Language codes typically use a country code, and optionally, a script or regional variant name. Examples: "en", "en-US" and "zh-Hant". ', array('@rfc4646' => 'http://www.ietf.org/rfc/rfc4646.txt')),
);
}
$form['name'] = array('#type' => 'textfield',
'#title' => t('Language name in English'),
'#maxlength' => 64,
'#default_value' => @$language->name,
'#required' => TRUE,
'#description' => t('Name of the language in English. Will be available for translation in all languages.'),
);
$form['native'] = array('#type' => 'textfield',
'#title' => t('Native language name'),
'#maxlength' => 64,
'#default_value' => @$language->native,
'#required' => TRUE,
'#description' => t('Name of the language in the language being added.'),
);
$form['prefix'] = array('#type' => 'textfield',
'#title' => t('Path prefix language code'),
'#maxlength' => 64,
'#default_value' => @$language->prefix,
'#description' => t('Language code or other custom text to use as a path prefix for URL language detection, if your Detection and selection settings use URL path prefixes. For the default language, this value may be left blank. Modifying this value may break existing URLs. Use with caution in a production environment. Example: Specifying "deutsch" as the path prefix code for German results in URLs like "example.com/deutsch/contact".')
);
$form['domain'] = array('#type' => 'textfield',
'#title' => t('Language domain'),
'#maxlength' => 128,
'#default_value' => @$language->domain,
'#description' => t('The domain name to use for this language if URL domains are used for Detection and selection . Leave blank for the default language. Changing this value may break existing URLs. Example: Specifying "de.example.com" as language domain for German will result in an URL like "http://de.example.com/contact".'),
);
$form['direction'] = array('#type' => 'radios',
'#title' => t('Direction'),
'#required' => TRUE,
'#description' => t('Direction that text in this language is presented.'),
'#default_value' => @$language->direction,
'#options' => array(LANGUAGE_LTR => t('Left to right'), LANGUAGE_RTL => t('Right to left'))
);
return $form;
}
/**
* Validate the language addition form.
*/
function locale_languages_predefined_form_validate($form, &$form_state) {
$langcode = $form_state['values']['langcode'];
if (($duplicate = db_query("SELECT COUNT(*) FROM {languages} WHERE language = :language", array(':language' => $langcode))->fetchField()) != 0) {
form_set_error('langcode', t('The language %language (%code) already exists.', array('%language' => $form_state['values']['name'], '%code' => $langcode)));
}
if (!isset($form_state['values']['name'])) {
// Predefined language selection.
include_once DRUPAL_ROOT . '/includes/iso.inc';
$predefined = _locale_get_predefined_list();
if (!isset($predefined[$langcode])) {
form_set_error('langcode', t('Invalid language code.'));
}
}
else {
// Reuse the editing form validation routine if we add a custom language.
locale_languages_edit_form_validate($form, $form_state);
}
}
/**
* Process the language addition form submission.
*/
function locale_languages_predefined_form_submit($form, &$form_state) {
$langcode = $form_state['values']['langcode'];
if (isset($form_state['values']['name'])) {
// Custom language form.
locale_add_language($langcode, $form_state['values']['name'], $form_state['values']['native'], $form_state['values']['direction'], $form_state['values']['domain'], $form_state['values']['prefix']);
drupal_set_message(t('The language %language has been created and can now be used. More information is available on the help screen .', array('%language' => t($form_state['values']['name']), '@locale-help' => url('admin/help/locale'))));
}
else {
// Predefined language selection.
include_once DRUPAL_ROOT . '/includes/iso.inc';
$predefined = _locale_get_predefined_list();
locale_add_language($langcode);
drupal_set_message(t('The language %language has been created and can now be used. More information is available on the help screen .', array('%language' => t($predefined[$langcode][0]), '@locale-help' => url('admin/help/locale'))));
}
// See if we have language files to import for the newly added
// language, collect and import them.
if ($batch = locale_batch_by_language($langcode, '_locale_batch_language_finished')) {
batch_set($batch);
}
$form_state['redirect'] = 'admin/config/regional/language';
}
/**
* Validate the language editing form. Reused for custom language addition too.
*/
function locale_languages_edit_form_validate($form, &$form_state) {
// Ensure sane field values for langcode, name, and native.
if (!isset($form['langcode_view']) && preg_match('@[^a-zA-Z_-]@', $form_state['values']['langcode'])) {
form_set_error('langcode', t('%field may only contain characters a-z, underscores, or hyphens.', array('%field' => $form['langcode']['#title'])));
}
if ($form_state['values']['name'] != check_plain($form_state['values']['name'])) {
form_set_error('name', t('%field cannot contain any markup.', array('%field' => $form['name']['#title'])));
}
if ($form_state['values']['native'] != check_plain($form_state['values']['native'])) {
form_set_error('native', t('%field cannot contain any markup.', array('%field' => $form['native']['#title'])));
}
if (!empty($form_state['values']['domain']) && !empty($form_state['values']['prefix'])) {
form_set_error('prefix', t('Domain and path prefix values should not be set at the same time.'));
}
if (!empty($form_state['values']['domain']) && $duplicate = db_query("SELECT language FROM {languages} WHERE domain = :domain AND language <> :language", array(':domain' => $form_state['values']['domain'], ':language' => $form_state['values']['langcode']))->fetchField()) {
form_set_error('domain', t('The domain (%domain) is already tied to a language (%language).', array('%domain' => $form_state['values']['domain'], '%language' => $duplicate)));
}
if (empty($form_state['values']['prefix']) && language_default('language') != $form_state['values']['langcode'] && empty($form_state['values']['domain'])) {
form_set_error('prefix', t('Only the default language can have both the domain and prefix empty.'));
}
if (!empty($form_state['values']['prefix']) && $duplicate = db_query("SELECT language FROM {languages} WHERE prefix = :prefix AND language <> :language", array(':prefix' => $form_state['values']['prefix'], ':language' => $form_state['values']['langcode']))->fetchField()) {
form_set_error('prefix', t('The prefix (%prefix) is already tied to a language (%language).', array('%prefix' => $form_state['values']['prefix'], '%language' => $duplicate)));
}
}
/**
* Process the language editing form submission.
*/
function locale_languages_edit_form_submit($form, &$form_state) {
db_update('languages')
->fields(array(
'name' => $form_state['values']['name'],
'native' => $form_state['values']['native'],
'domain' => $form_state['values']['domain'],
'prefix' => $form_state['values']['prefix'],
'direction' => $form_state['values']['direction'],
))
->condition('language', $form_state['values']['langcode'])
->execute();
$default = language_default();
if ($default->language == $form_state['values']['langcode']) {
$properties = array('name', 'native', 'direction', 'enabled', 'plurals', 'formula', 'domain', 'prefix', 'weight');
foreach ($properties as $keyname) {
if (isset($form_state['values'][$keyname])) {
$default->$keyname = $form_state['values'][$keyname];
}
}
variable_set('language_default', $default);
}
$form_state['redirect'] = 'admin/config/regional/language';
return;
}
/**
* User interface for the language deletion confirmation screen.
*/
function locale_languages_delete_form($form, &$form_state, $langcode) {
// Do not allow deletion of English locale.
if ($langcode == 'en') {
drupal_set_message(t('The English language cannot be deleted.'));
drupal_goto('admin/config/regional/language');
}
if (language_default('language') == $langcode) {
drupal_set_message(t('The default language cannot be deleted.'));
drupal_goto('admin/config/regional/language');
}
// For other languages, warn user that data loss is ahead.
$languages = language_list();
if (!isset($languages[$langcode])) {
drupal_not_found();
drupal_exit();
}
else {
$form['langcode'] = array('#type' => 'value', '#value' => $langcode);
return confirm_form($form, t('Are you sure you want to delete the language %name?', array('%name' => t($languages[$langcode]->name))), 'admin/config/regional/language', t('Deleting a language will remove all interface translations associated with it, and posts in this language will be set to be language neutral. This action cannot be undone.'), t('Delete'), t('Cancel'));
}
}
/**
* Process language deletion submissions.
*/
function locale_languages_delete_form_submit($form, &$form_state) {
$languages = language_list();
if (isset($languages[$form_state['values']['langcode']])) {
// Remove translations first.
db_delete('locales_target')
->condition('language', $form_state['values']['langcode'])
->execute();
cache_clear_all('locale:' . $form_state['values']['langcode'], 'cache');
// With no translations, this removes existing JavaScript translations file.
_locale_rebuild_js($form_state['values']['langcode']);
// Remove the language.
db_delete('languages')
->condition('language', $form_state['values']['langcode'])
->execute();
db_update('node')
->fields(array('language' => ''))
->condition('language', $form_state['values']['langcode'])
->execute();
if ($languages[$form_state['values']['langcode']]->enabled) {
variable_set('language_count', variable_get('language_count', 1) - 1);
}
module_invoke_all('multilingual_settings_changed');
$variables = array('%locale' => $languages[$form_state['values']['langcode']]->name);
drupal_set_message(t('The language %locale has been removed.', $variables));
watchdog('locale', 'The language %locale has been removed.', $variables);
}
// Changing the language settings impacts the interface:
cache_clear_all('*', 'cache_page', TRUE);
$form_state['redirect'] = 'admin/config/regional/language';
return;
}
/**
* Setting for language negotiation options
*/
function locale_languages_configure_form() {
include_once DRUPAL_ROOT . '/includes/language.inc';
$form = array(
'#submit' => array('locale_languages_configure_form_submit'),
'#theme' => 'locale_languages_configure_form',
'#language_types' => language_types_configurable(FALSE),
'#language_types_info' => language_types_info(),
'#language_providers' => language_negotiation_info(),
);
foreach ($form['#language_types'] as $type) {
_locale_languages_configure_form_language_table($form, $type);
}
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Save settings'),
);
return $form;
}
/**
* Helper function to build a language provider table.
*/
function _locale_languages_configure_form_language_table(&$form, $type) {
$info = $form['#language_types_info'][$type];
$table_form = array(
'#title' => t('@type language detection', array('@type' => $info['name'])),
'#tree' => TRUE,
'#description' => $info['description'],
'#language_providers' => array(),
'#show_operations' => FALSE,
'weight' => array('#tree' => TRUE),
'enabled' => array('#tree' => TRUE),
);
$language_providers = $form['#language_providers'];
$enabled_providers = variable_get("language_negotiation_$type", array());
$providers_weight = variable_get("locale_language_providers_weight_$type", array());
// Add missing data to the providers lists.
foreach ($language_providers as $id => $provider) {
if (!isset($providers_weight[$id])) {
$providers_weight[$id] = language_provider_weight($provider);
}
}
// Order providers list by weight.
asort($providers_weight);
foreach ($providers_weight as $id => $weight) {
// A language provider might be no more available if the defining module has
// been disabled after the last configuration saving.
if (!isset($language_providers[$id])) {
continue;
}
$enabled = isset($enabled_providers[$id]);
$provider = $language_providers[$id];
// List the provider only if the current type is defined in its 'types' key.
// If it is not defined default to all the configurable language types.
$types = array_flip(isset($provider['types']) ? $provider['types'] : $form['#language_types']);
if (isset($types[$type])) {
$table_form['#language_providers'][$id] = $provider;
$table_form['weight'][$id] = array(
'#type' => 'weight',
'#title' => t('Weight for @title', array('@title' => $provider['name'])),
'#title_display' => 'invisible',
'#default_value' => $weight,
'#attributes' => array('class' => array("language-provider-weight-$type")),
);
$table_form['title'][$id] = array('#markup' => check_plain($provider['name']));
$table_form['enabled'][$id] = array(
'#type' => 'checkbox',
'#title' => t('@title language provider', array('@title' => $provider['name'])),
'#title_display' => 'invisible',
'#default_value' => $enabled,
);
if ($id === LANGUAGE_NEGOTIATION_DEFAULT) {
$table_form['enabled'][$id]['#default_value'] = TRUE;
$table_form['enabled'][$id]['#attributes'] = array('disabled' => 'disabled');
}
$table_form['description'][$id] = array('#markup' => filter_xss_admin($provider['description']));
$config_op = array();
if (isset($provider['config'])) {
$config_op = array('#type' => 'link', '#title' => t('Configure'), '#href' => $provider['config']);
// If there is at least one operation enabled show the operation column.
$table_form['#show_operations'] = TRUE;
}
$table_form['operation'][$id] = $config_op;
}
}
$form[$type] = $table_form;
}
/**
* Returns HTML for a language configuration form.
*
* @param $variables
* An associative array containing:
* - form: A render element representing the form.
*
* @ingroup themeable
*/
function theme_locale_languages_configure_form($variables) {
$form = $variables['form'];
$output = '';
foreach ($form['#language_types'] as $type) {
$rows = array();
$info = $form['#language_types_info'][$type];
$title = '' . $form[$type]['#title'] . ' ';
$description = '' . $form[$type]['#description'] . '
';
foreach ($form[$type]['title'] as $id => $element) {
// Do not take form control structures.
if (is_array($element) && element_child($id)) {
$row = array(
'data' => array(
'' . drupal_render($form[$type]['title'][$id]) . ' ',
drupal_render($form[$type]['description'][$id]),
drupal_render($form[$type]['enabled'][$id]),
drupal_render($form[$type]['weight'][$id]),
),
'class' => array('draggable'),
);
if ($form[$type]['#show_operations']) {
$row['data'][] = drupal_render($form[$type]['operation'][$id]);
}
$rows[] = $row;
}
}
$header = array(
array('data' => t('Detection method')),
array('data' => t('Description')),
array('data' => t('Enabled')),
array('data' => t('Weight')),
);
// If there is at least one operation enabled show the operation column.
if ($form[$type]['#show_operations']) {
$header[] = array('data' => t('Operations'));
}
$variables = array(
'header' => $header,
'rows' => $rows,
'attributes' => array('id' => "language-negotiation-providers-$type"),
);
$table = theme('table', $variables);
$table .= drupal_render_children($form[$type]);
drupal_add_tabledrag("language-negotiation-providers-$type", 'order', 'sibling', "language-provider-weight-$type");
$output .= '' . $title . $description . $table . '
';
}
$output .= drupal_render_children($form);
return $output;
}
/**
* Submit handler for language negotiation settings.
*/
function locale_languages_configure_form_submit($form, &$form_state) {
$configurable_types = $form['#language_types'];
foreach ($configurable_types as $type) {
$negotiation = array();
$enabled_providers = $form_state['values'][$type]['enabled'];
$enabled_providers[LANGUAGE_NEGOTIATION_DEFAULT] = TRUE;
$providers_weight = $form_state['values'][$type]['weight'];
foreach ($providers_weight as $id => $weight) {
if ($enabled_providers[$id]) {
$provider = $form[$type]['#language_providers'][$id];
$provider['weight'] = $weight;
$negotiation[$id] = $provider;
}
}
language_negotiation_set($type, $negotiation);
variable_set("locale_language_providers_weight_$type", $providers_weight);
}
// Update non-configurable language types and the related language negotiation
// configuration.
language_types_set();
$form_state['redirect'] = 'admin/config/regional/language/configure';
drupal_set_message(t('Language negotiation configuration saved.'));
}
/**
* The URL language provider configuration form.
*/
function locale_language_providers_url_form($form, &$form_state) {
$form['locale_language_negotiation_url_part'] = array(
'#title' => t('Part of the URL that determines language'),
'#type' => 'radios',
'#options' => array(
LOCALE_LANGUAGE_NEGOTIATION_URL_PREFIX => t('Path prefix'),
LOCALE_LANGUAGE_NEGOTIATION_URL_DOMAIN => t('Domain'),
),
'#default_value' => variable_get('locale_language_negotiation_url_part', LOCALE_LANGUAGE_NEGOTIATION_URL_PREFIX),
'#description' => t('Path prefix : URLs like http://example.com/de/contact set language to German (de). Domain : URLs like http://de.example.com/contact set the language to German. Warning: Changing this setting may break incoming URLs. Use with caution on a production site. '),
);
$form_state['redirect'] = 'admin/config/regional/language/configure';
return system_settings_form($form);
}
/**
* The URL language provider configuration form.
*/
function locale_language_providers_session_form($form, &$form_state) {
$form['locale_language_negotiation_session_param'] = array(
'#title' => t('Request/session parameter'),
'#type' => 'textfield',
'#default_value' => variable_get('locale_language_negotiation_session_param', 'language'),
'#description' => t('Name of the request/session parameter used to determine the desired language.'),
);
$form_state['redirect'] = 'admin/config/regional/language/configure';
return system_settings_form($form);
}
/**
* @} End of "locale-language-administration"
*/
/**
* @defgroup locale-translate-administration-screens Translation administration screens
* @{
* Screens for translation administration.
*
* These functions provide various screens as administration interface
* to import, export and view translations.
*/
/**
* Overview screen for translations.
*/
function locale_translate_overview_screen() {
drupal_static_reset('language_list');
$languages = language_list('language');
$groups = module_invoke_all('locale', 'groups');
// Build headers with all groups in order.
$headers = array_merge(array(t('Language')), array_values($groups));
// Collect summaries of all source strings in all groups.
$sums = db_query("SELECT COUNT(*) AS strings, textgroup FROM {locales_source} GROUP BY textgroup");
$groupsums = array();
foreach ($sums as $group) {
$groupsums[$group->textgroup] = $group->strings;
}
// Set up overview table with default values, ensuring common order for values.
$rows = array();
foreach ($languages as $langcode => $language) {
$rows[$langcode] = array('name' => ($langcode == 'en' ? t('English (built-in)') : t($language->name)));
foreach ($groups as $group => $name) {
$rows[$langcode][$group] = ($langcode == 'en' ? t('n/a') : '0/' . (isset($groupsums[$group]) ? $groupsums[$group] : 0) . ' (0%)');
}
}
// Languages with at least one record in the locale table.
$translations = db_query("SELECT COUNT(*) AS translation, t.language, s.textgroup FROM {locales_source} s INNER JOIN {locales_target} t ON s.lid = t.lid GROUP BY textgroup, language");
foreach ($translations as $data) {
$ratio = (!empty($groupsums[$data->textgroup]) && $data->translation > 0) ? round(($data->translation/$groupsums[$data->textgroup]) * 100.0, 2) : 0;
$rows[$data->language][$data->textgroup] = $data->translation . '/' . $groupsums[$data->textgroup] . " ($ratio%)";
}
return theme('table', array('header' => $headers, 'rows' => $rows));
}
/**
* String search screen.
*/
function locale_translate_seek_screen() {
// Add CSS.
drupal_add_css(drupal_get_path('module', 'locale') . '/locale.css');
$elements = drupal_get_form('locale_translation_filter_form');
$output = drupal_render($elements);
$output .= _locale_translate_seek();
return $output;
}
/**
* List locale translation filters that can be applied.
*/
function locale_translation_filters() {
$filters = array();
// Get all languages, except English
drupal_static_reset('language_list');
$languages = locale_language_list('name');
unset($languages['en']);
$filters['string'] = array(
'title' => t('String contains'),
'description' => t('Leave blank to show all strings. The search is case sensitive.'),
);
$filters['language'] = array(
'title' => t('Language'),
'options' => array_merge(array('all' => t('All languages'), 'en' => t('English (provided by Drupal)')), $languages),
);
$filters['translation'] = array(
'title' => t('Search in'),
'options' => array('all' => t('Both translated and untranslated strings'), 'translated' => t('Only translated strings'), 'untranslated' => t('Only untranslated strings')),
);
$groups = module_invoke_all('locale', 'groups');
$filters['group'] = array(
'title' => t('Limit search to'),
'options' => array_merge(array('all' => t('All text groups')), $groups),
);
return $filters;
}
/**
* Return form for locale translation filters.
*
* @ingroup forms
*/
function locale_translation_filter_form() {
$filters = locale_translation_filters();
$form['filters'] = array(
'#type' => 'fieldset',
'#title' => t('Filter translatable strings'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
);
foreach ($filters as $key => $filter) {
// Special case for 'string' filter.
if ($key == 'string') {
$form['filters']['status']['string'] = array(
'#type' => 'textfield',
'#title' => $filter['title'],
'#description' => $filter['description'],
);
}
else {
$form['filters']['status'][$key] = array(
'#title' => $filter['title'],
'#type' => 'select',
'#empty_value' => 'all',
'#empty_option' => $filter['options']['all'],
'#size' => 0,
'#options' => $filter['options'],
);
}
if (!empty($_SESSION['locale_translation_filter'][$key])) {
$form['filters']['status'][$key]['#default_value'] = $_SESSION['locale_translation_filter'][$key];
}
}
$form['filters']['actions'] = array(
'#type' => 'actions',
'#attributes' => array('class' => array('container-inline')),
);
$form['filters']['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Filter'),
);
if (!empty($_SESSION['locale_translation_filter'])) {
$form['filters']['actions']['reset'] = array(
'#type' => 'submit',
'#value' => t('Reset')
);
}
return $form;
}
/**
* Validate result from locale translation filter form.
*/
function locale_translation_filter_form_validate($form, &$form_state) {
if ($form_state['values']['op'] == t('Filter') && empty($form_state['values']['language']) && empty($form_state['values']['group'])) {
form_set_error('type', t('You must select something to filter by.'));
}
}
/**
* Process result from locale translation filter form.
*/
function locale_translation_filter_form_submit($form, &$form_state) {
$op = $form_state['values']['op'];
$filters = locale_translation_filters();
switch ($op) {
case t('Filter'):
foreach ($filters as $name => $filter) {
if (isset($form_state['values'][$name])) {
$_SESSION['locale_translation_filter'][$name] = $form_state['values'][$name];
}
}
break;
case t('Reset'):
$_SESSION['locale_translation_filter'] = array();
break;
}
$form_state['redirect'] = 'admin/config/regional/translate/translate';
}
/**
* User interface for the translation import screen.
*/
function locale_translate_import_form($form) {
// Get all languages, except English
drupal_static_reset('language_list');
$names = locale_language_list('name');
unset($names['en']);
if (!count($names)) {
$languages = _locale_prepare_predefined_list();
$default = key($languages);
}
else {
$languages = array(
t('Already added languages') => $names,
t('Languages not yet added') => _locale_prepare_predefined_list()
);
$default = key($names);
}
$form['import'] = array('#type' => 'fieldset',
'#title' => t('Import translation'),
);
$form['import']['file'] = array('#type' => 'file',
'#title' => t('Language file'),
'#size' => 50,
'#description' => t('A Gettext Portable Object (.po ) file.'),
);
$form['import']['langcode'] = array('#type' => 'select',
'#title' => t('Import into'),
'#options' => $languages,
'#default_value' => $default,
'#description' => t('Choose the language you want to add strings into. If you choose a language which is not yet set up, it will be added.'),
);
$form['import']['group'] = array('#type' => 'radios',
'#title' => t('Text group'),
'#default_value' => 'default',
'#options' => module_invoke_all('locale', 'groups'),
'#description' => t('Imported translations will be added to this text group.'),
);
$form['import']['mode'] = array('#type' => 'radios',
'#title' => t('Mode'),
'#default_value' => LOCALE_IMPORT_KEEP,
'#options' => array(
LOCALE_IMPORT_OVERWRITE => t('Strings in the uploaded file replace existing ones, new ones are added. The plural format is updated.'),
LOCALE_IMPORT_KEEP => t('Existing strings and the plural format are kept, only new strings are added.')
),
);
$form['import']['submit'] = array('#type' => 'submit', '#value' => t('Import'));
return $form;
}
/**
* Process the locale import form submission.
*/
function locale_translate_import_form_submit($form, &$form_state) {
$validators = array('file_validate_extensions' => array('po'));
// Ensure we have the file uploaded
if ($file = file_save_upload('file', $validators)) {
// Add language, if not yet supported
drupal_static_reset('language_list');
$languages = language_list('language');
$langcode = $form_state['values']['langcode'];
if (!isset($languages[$langcode])) {
include_once DRUPAL_ROOT . '/includes/iso.inc';
$predefined = _locale_get_predefined_list();
locale_add_language($langcode);
drupal_set_message(t('The language %language has been created.', array('%language' => t($predefined[$langcode][0]))));
}
// Now import strings into the language
if ($return = _locale_import_po($file, $langcode, $form_state['values']['mode'], $form_state['values']['group']) == FALSE) {
$variables = array('%filename' => $file->filename);
drupal_set_message(t('The translation import of %filename failed.', $variables), 'error');
watchdog('locale', 'The translation import of %filename failed.', $variables, WATCHDOG_ERROR);
}
}
else {
drupal_set_message(t('File to import not found.'), 'error');
$form_state['redirect'] = 'admin/config/regional/translate/import';
return;
}
$form_state['redirect'] = 'admin/config/regional/translate';
return;
}
/**
* User interface for the translation export screen.
*/
function locale_translate_export_screen() {
// Get all languages, except English
drupal_static_reset('language_list');
$names = locale_language_list('name');
unset($names['en']);
$output = '';
// Offer translation export if any language is set up.
if (count($names)) {
$elements = drupal_get_form('locale_translate_export_po_form', $names);
$output = drupal_render($elements);
}
$elements = drupal_get_form('locale_translate_export_pot_form');
$output .= drupal_render($elements);
return $output;
}
/**
* Form to export PO files for the languages provided.
*
* @param $names
* An associate array with localized language names
*/
function locale_translate_export_po_form($form, &$form_state, $names) {
$form['export_title'] = array('#type' => 'item',
'#title' => t('Export translation'),
);
$form['langcode'] = array('#type' => 'select',
'#title' => t('Language name'),
'#options' => $names,
'#description' => t('Select the language to export in Gettext Portable Object (.po ) format.'),
);
$form['group'] = array('#type' => 'radios',
'#title' => t('Text group'),
'#default_value' => 'default',
'#options' => module_invoke_all('locale', 'groups'),
);
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array('#type' => 'submit', '#value' => t('Export'));
return $form;
}
/**
* Translation template export form.
*/
function locale_translate_export_pot_form() {
// Complete template export of the strings
$form['export_title'] = array('#type' => 'item',
'#title' => t('Export template'),
'#description' => t('Generate a Gettext Portable Object Template (.pot ) file with all strings from the Drupal locale database.'),
);
$form['group'] = array('#type' => 'radios',
'#title' => t('Text group'),
'#default_value' => 'default',
'#options' => module_invoke_all('locale', 'groups'),
);
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array('#type' => 'submit', '#value' => t('Export'));
// Reuse PO export submission callback.
$form['#submit'][] = 'locale_translate_export_po_form_submit';
return $form;
}
/**
* Process a translation (or template) export form submission.
*/
function locale_translate_export_po_form_submit($form, &$form_state) {
// If template is required, language code is not given.
$language = NULL;
if (isset($form_state['values']['langcode'])) {
$languages = language_list();
$language = $languages[$form_state['values']['langcode']];
}
_locale_export_po($language, _locale_export_po_generate($language, _locale_export_get_strings($language, $form_state['values']['group'])));
}
/**
* @} End of "locale-translate-administration-screens"
*/
/**
* @defgroup locale-translate-edit-delete Translation editing/deletion interface
* @{
* Edit and delete translation strings.
*
* These functions provide the user interface to edit and delete
* translation strings.
*/
/**
* User interface for string editing.
*/
function locale_translate_edit_form($form, &$form_state, $lid) {
// Fetch source string, if possible.
$source = db_query('SELECT source, context, textgroup, location FROM {locales_source} WHERE lid = :lid', array(':lid' => $lid))->fetchObject();
if (!$source) {
drupal_set_message(t('String not found.'), 'error');
drupal_goto('admin/config/regional/translate/translate');
}
// Add original text to the top and some values for form altering.
$form['original'] = array(
'#type' => 'item',
'#title' => t('Original text'),
'#markup' => check_plain(wordwrap($source->source, 0)),
);
if (!empty($source->context)) {
$form['context'] = array(
'#type' => 'item',
'#title' => t('Context'),
'#markup' => check_plain($source->context),
);
}
$form['lid'] = array(
'#type' => 'value',
'#value' => $lid
);
$form['textgroup'] = array(
'#type' => 'value',
'#value' => $source->textgroup,
);
$form['location'] = array(
'#type' => 'value',
'#value' => $source->location
);
// Include both translated and not yet translated target languages in the
// list. The source language is English for built-in strings and the default
// language for other strings.
$languages = language_list();
$default = language_default();
$omit = $source->textgroup == 'default' ? 'en' : $default->language;
unset($languages[($omit)]);
$form['translations'] = array('#tree' => TRUE);
// Approximate the number of rows to use in the default textarea.
$rows = min(ceil(str_word_count($source->source) / 12), 10);
foreach ($languages as $langcode => $language) {
$form['translations'][$langcode] = array(
'#type' => 'textarea',
'#title' => t($language->name),
'#rows' => $rows,
'#default_value' => '',
);
}
// Fetch translations and fill in default values in the form.
$result = db_query("SELECT DISTINCT translation, language FROM {locales_target} WHERE lid = :lid AND language <> :omit", array(':lid' => $lid, ':omit' => $omit));
foreach ($result as $translation) {
$form['translations'][$translation->language]['#default_value'] = $translation->translation;
}
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array('#type' => 'submit', '#value' => t('Save translations'));
return $form;
}
/**
* Validate string editing form submissions.
*/
function locale_translate_edit_form_validate($form, &$form_state) {
// Locale string check is needed for default textgroup only.
$safe_check_needed = $form_state['values']['textgroup'] == 'default';
foreach ($form_state['values']['translations'] as $key => $value) {
if ($safe_check_needed && !locale_string_is_safe($value)) {
form_set_error('translations', t('The submitted string contains disallowed HTML: %string', array('%string' => $value)));
watchdog('locale', 'Attempted submission of a translation string with disallowed HTML: %string', array('%string' => $value), WATCHDOG_WARNING);
}
}
}
/**
* Process string editing form submissions.
*
* Saves all translations of one string submitted from a form.
*/
function locale_translate_edit_form_submit($form, &$form_state) {
$lid = $form_state['values']['lid'];
foreach ($form_state['values']['translations'] as $key => $value) {
$translation = db_query("SELECT translation FROM {locales_target} WHERE lid = :lid AND language = :language", array(':lid' => $lid, ':language' => $key))->fetchField();
if (!empty($value)) {
// Only update or insert if we have a value to use.
if (is_string($translation)) {
db_update('locales_target')
->fields(array(
'translation' => $value,
))
->condition('lid', $lid)
->condition('language', $key)
->execute();
}
else {
db_insert('locales_target')
->fields(array(
'lid' => $lid,
'translation' => $value,
'language' => $key,
))
->execute();
}
}
elseif (!empty($translation)) {
// Empty translation entered: remove existing entry from database.
db_delete('locales_target')
->condition('lid', $lid)
->condition('language', $key)
->execute();
}
// Force JavaScript translation file recreation for this language.
_locale_invalidate_js($key);
}
drupal_set_message(t('The string has been saved.'));
// Clear locale cache.
_locale_invalidate_js();
cache_clear_all('locale:', 'cache', TRUE);
$form_state['redirect'] = 'admin/config/regional/translate/translate';
return;
}
/**
* String deletion confirmation page.
*/
function locale_translate_delete_page($lid) {
if ($source = db_query('SELECT lid, source FROM {locales_source} WHERE lid = :lid', array(':lid' => $lid))->fetchObject()) {
return drupal_get_form('locale_translate_delete_form', $source);
}
return MENU_NOT_FOUND;
}
/**
* User interface for the string deletion confirmation screen.
*/
function locale_translate_delete_form($form, &$form_state, $source) {
$form['lid'] = array('#type' => 'value', '#value' => $source->lid);
return confirm_form($form, t('Are you sure you want to delete the string "%source"?', array('%source' => $source->source)), 'admin/config/regional/translate/translate', t('Deleting the string will remove all translations of this string in all languages. This action cannot be undone.'), t('Delete'), t('Cancel'));
}
/**
* Process string deletion submissions.
*/
function locale_translate_delete_form_submit($form, &$form_state) {
db_delete('locales_source')
->condition('lid', $form_state['values']['lid'])
->execute();
db_delete('locales_target')
->condition('lid', $form_state['values']['lid'])
->execute();
// Force JavaScript translation file recreation for all languages.
_locale_invalidate_js();
cache_clear_all('locale:', 'cache', TRUE);
drupal_set_message(t('The string has been removed.'));
$form_state['redirect'] = 'admin/config/regional/translate/translate';
}
/**
* @} End of "locale-translate-edit-delete"
*/
/**
* Returns HTML for a locale date format form.
*
* @param $variables
* An associative array containing:
* - form: A render element representing the form.
*
* @ingroup themeable
*/
function theme_locale_date_format_form($variables) {
$form = $variables['form'];
$header = array(
t('Date type'),
t('Format'),
);
foreach (element_children($form['date_formats']) as $key) {
$row = array();
$row[] = $form['date_formats'][$key]['#title'];
unset($form['date_formats'][$key]['#title']);
$row[] = array('data' => drupal_render($form['date_formats'][$key]));
$rows[] = $row;
}
$output = drupal_render($form['language']);
$output .= theme('table', array('header' => $header, 'rows' => $rows));
$output .= drupal_render_children($form);
return $output;
}
/**
* Display edit date format links for each language.
*/
function locale_date_format_language_overview_page() {
$header = array(
t('Language'),
array('data' => t('Operations'), 'colspan' => '2'),
);
// Get list of languages.
$languages = locale_language_list('native');
foreach ($languages as $langcode => $info) {
$row = array();
$row[] = $languages[$langcode];
$row[] = l(t('edit'), 'admin/config/regional/date-time/locale/' . $langcode . '/edit');
$row[] = l(t('reset'), 'admin/config/regional/date-time/locale/' . $langcode . '/reset');
$rows[] = $row;
}
return theme('table', array('header' => $header, 'rows' => $rows));
}
/**
* Provide date localization configuration options to users.
*/
function locale_date_format_form($form, &$form_state, $langcode) {
$languages = locale_language_list('native');
$language_name = $languages[$langcode];
// Display the current language name.
$form['language'] = array(
'#type' => 'item',
'#title' => t('Language'),
'#markup' => check_plain($language_name),
'#weight' => -10,
);
$form['langcode'] = array(
'#type' => 'value',
'#value' => $langcode,
);
// Get list of date format types.
$types = system_get_date_types();
// Get list of available formats.
$formats = system_get_date_formats();
$choices = array();
foreach ($formats as $type => $list) {
foreach ($list as $f => $format) {
$choices[$f] = format_date(REQUEST_TIME, 'custom', $f);
}
}
reset($formats);
// Get configured formats for each language.
$locale_formats = system_date_format_locale($langcode);
// Display a form field for each format type.
foreach ($types as $type => $type_info) {
if (!empty($locale_formats) && in_array($type, array_keys($locale_formats))) {
$default = $locale_formats[$type];
}
else {
$default = variable_get('date_format_' . $type, key($formats));
}
// Show date format select list.
$form['date_formats']['date_format_' . $type] = array(
'#type' => 'select',
'#title' => check_plain($type_info['title']),
'#attributes' => array('class' => array('date-format')),
'#default_value' => (isset($choices[$default]) ? $default : 'custom'),
'#options' => $choices,
);
}
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Save configuration'),
);
return $form;
}
/**
* Submit handler for configuring localized date formats on the locale_date_format_form.
*/
function locale_date_format_form_submit($form, &$form_state) {
include_once DRUPAL_ROOT . '/includes/locale.inc';
$langcode = $form_state['values']['langcode'];
// Get list of date format types.
$types = system_get_date_types();
foreach ($types as $type => $type_info) {
$format = $form_state['values']['date_format_' . $type];
if ($format == 'custom') {
$format = $form_state['values']['date_format_' . $type . '_custom'];
}
locale_date_format_save($langcode, $type, $format);
}
drupal_set_message(t('Configuration saved.'));
$form_state['redirect'] = 'admin/config/regional/date-time/locale';
}
/**
* Reset locale specific date formats to the global defaults.
*
* @param $langcode
* Language code, e.g. 'en'.
*/
function locale_date_format_reset_form($form, &$form_state, $langcode) {
$form['langcode'] = array('#type' => 'value', '#value' => $langcode);
$languages = language_list();
return confirm_form($form,
t('Are you sure you want to reset the date formats for %language to the global defaults?', array('%language' => $languages[$langcode]->name)),
'admin/config/regional/date-time/locale',
t('Resetting will remove all localized date formats for this language. This action cannot be undone.'),
t('Reset'), t('Cancel'));
}
/**
* Reset date formats for a specific language to global defaults.
*/
function locale_date_format_reset_form_submit($form, &$form_state) {
db_delete('date_format_locale')
->condition('language', $form_state['values']['langcode'])
->execute();
$form_state['redirect'] = 'admin/config/regional/date-time/locale';
}
t('Custom'));
}
}
/**
* Allow modules to react to language settings changes.
*
* Every module needing to act when the number of enabled languages changes
* should implement this. This is an "internal" hook and should not be invoked
* elsewhere. The typical implementation would trigger some kind of rebuilding,
* this way system components could properly react to the change of the enabled
* languages number.
*/
function hook_multilingual_settings_changed() {
field_info_cache_clear();
}
/**
* @} End of "addtogroup hooks".
*/
.locale-untranslated {
font-style: normal;
text-decoration: line-through;
}
#locale-translation-filter-form .form-item-language,
#locale-translation-filter-form .form-item-translation,
#locale-translation-filter-form .form-item-group {
float: left; /* LTR */
padding-right: .8em; /* LTR */
margin: 0.1em;
/**
* In Opera 9, DOM elements with the property of "overflow: auto"
* will partially hide its contents with unnecessary scrollbars when
* its immediate child is floated without an explicit width set.
*/
width: 15em;
}
#locale-translation-filter-form .form-type-select select {
width: 100%;
}
#locale-translation-filter-form .form-actions {
float: left; /* LTR */
padding: 3ex 0 0 1em; /* LTR */
}
.language-switcher-locale-session a.active {
color: #0062A0;
}
.language-switcher-locale-session a.session-active {
color: #000000;
}
(function ($) {
/**
* Attaches language support to the jQuery UI datepicker component.
*/
Drupal.behaviors.localeDatepicker = {
attach: function(context, settings) {
// This code accesses Drupal.settings and localized strings via Drupal.t().
// So this code should run after these are initialized. By placing it in an
// attach behavior this is assured.
$.datepicker.regional['drupal-locale'] = $.extend({
closeText: Drupal.t('Done'),
prevText: Drupal.t('Prev'),
nextText: Drupal.t('Next'),
currentText: Drupal.t('Today'),
monthNames: [
Drupal.t('January'),
Drupal.t('February'),
Drupal.t('March'),
Drupal.t('April'),
Drupal.t('May'),
Drupal.t('June'),
Drupal.t('July'),
Drupal.t('August'),
Drupal.t('September'),
Drupal.t('October'),
Drupal.t('November'),
Drupal.t('December')
],
monthNamesShort: [
Drupal.t('Jan'),
Drupal.t('Feb'),
Drupal.t('Mar'),
Drupal.t('Apr'),
Drupal.t('May'),
Drupal.t('Jun'),
Drupal.t('Jul'),
Drupal.t('Aug'),
Drupal.t('Sep'),
Drupal.t('Oct'),
Drupal.t('Nov'),
Drupal.t('Dec')
],
dayNames: [
Drupal.t('Sunday'),
Drupal.t('Monday'),
Drupal.t('Tuesday'),
Drupal.t('Wednesday'),
Drupal.t('Thursday'),
Drupal.t('Friday'),
Drupal.t('Saturday')
],
dayNamesShort: [
Drupal.t('Sun'),
Drupal.t('Mon'),
Drupal.t('Tue'),
Drupal.t('Wed'),
Drupal.t('Thu'),
Drupal.t('Fri'),
Drupal.t('Sat')
],
dayNamesMin: [
Drupal.t('Su'),
Drupal.t('Mo'),
Drupal.t('Tu'),
Drupal.t('We'),
Drupal.t('Th'),
Drupal.t('Fr'),
Drupal.t('Sa')
],
dateFormat: Drupal.t('mm/dd/yy'),
firstDay: 0,
isRTL: 0
}, Drupal.settings.jquery.ui.datepicker);
$.datepicker.setDefaults($.datepicker.regional['drupal-locale']);
}
};
})(jQuery);
name = Locale
description = Adds language handling functionality and enables the translation of the user interface to languages other than English.
package = Core
version = VERSION
core = 7.x
files[] = locale.test
configure = admin/config/regional/language
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
fields(array(
'language' => 'en',
'name' => 'English',
'native' => 'English',
'direction' => 0,
'enabled' => 1,
'weight' => 0,
'javascript' => '',
))
->execute();
}
/**
* @addtogroup updates-6.x-to-7.x
* @{
*/
/**
* Add context field index and allow longer location.
*/
function locale_update_7000() {
db_drop_index('locales_source', 'source');
db_add_index('locales_source', 'source_context', array(array('source', 30), 'context'));
// Also drop the 'textgroup_location' index added by the i18nstrings module
// of the i18n project, which prevents the below schema update from running.
if (db_index_exists('locales_source', 'textgroup_location')) {
db_drop_index('locales_source', 'textgroup_location');
}
db_change_field('locales_source', 'location', 'location', array(
'type' => 'text',
'not null' => FALSE,
'size' => 'big',
'description' => 'Drupal path in case of online discovered translations or file path in case of imported strings.',
));
}
/**
* Upgrade language negotiation settings.
*/
function locale_update_7001() {
require_once DRUPAL_ROOT . '/includes/language.inc';
require_once DRUPAL_ROOT . '/includes/locale.inc';
require_once DRUPAL_ROOT . '/modules/locale/locale.module';
switch (variable_get('language_negotiation', 0)) {
// LANGUAGE_NEGOTIATION_NONE.
case 0:
$negotiation = array();
break;
// LANGUAGE_NEGOTIATION_PATH_DEFAULT.
case 1:
$negotiation = array(LOCALE_LANGUAGE_NEGOTIATION_URL);
// In Drupal 6 path prefixes are shown for the default language only when
// language negotiation is set to LANGUAGE_NEGOTIATION_PATH, while in
// Drupal 7 path prefixes are always shown if not empty. Hence we need to
// ensure that the default language has an empty prefix to avoid breaking
// the site URLs with a prefix that previously was missing.
$default = language_default();
$default->prefix = '';
variable_set('language_default', $default);
db_update('languages')
->fields(array('prefix' => $default->prefix))
->condition('language', $default->language)
->execute();
break;
// LANGUAGE_NEGOTIATION_PATH.
case 2:
$negotiation = array(LOCALE_LANGUAGE_NEGOTIATION_URL, LOCALE_LANGUAGE_NEGOTIATION_USER, LOCALE_LANGUAGE_NEGOTIATION_BROWSER);
break;
// LANGUAGE_NEGOTIATION_DOMAIN.
case 3:
variable_set('locale_language_negotiation_url_part', LOCALE_LANGUAGE_NEGOTIATION_URL_DOMAIN);
$negotiation = array(LOCALE_LANGUAGE_NEGOTIATION_URL);
break;
}
// Save the new language negotiation options.
language_negotiation_set(LANGUAGE_TYPE_INTERFACE, array_flip($negotiation));
language_negotiation_set(LANGUAGE_TYPE_CONTENT, array(LOCALE_LANGUAGE_NEGOTIATION_INTERFACE => 0));
language_negotiation_set(LANGUAGE_TYPE_URL, array(LOCALE_LANGUAGE_NEGOTIATION_URL => 0));
// Save admininstration UI settings.
$type = LANGUAGE_TYPE_INTERFACE;
$provider_weights = array_flip(array_keys(locale_language_negotiation_info()));
variable_set("locale_language_providers_weight_$type", $provider_weights);
// Unset the old language negotiation system variable.
variable_del('language_negotiation');
return array();
}
/**
* Updates URL language negotiation by adding the URL fallback detection method.
*/
function locale_update_7002() {
// language.inc may not have been included during bootstrap if there is not
// more than one language currently enabled.
require_once DRUPAL_ROOT . '/includes/language.inc';
$language_types_info = language_types_info();
$info = $language_types_info[LANGUAGE_TYPE_URL];
if (isset($info['fixed'])) {
language_negotiation_set(LANGUAGE_TYPE_URL, array_flip($info['fixed']));
}
}
/**
* @} End of "addtogroup updates-6.x-to-7.x".
*/
/**
* @addtogroup updates-7.x-extra
* @{
*/
/**
* Update "language_count" variable.
*/
function locale_update_7003() {
$languages = language_list('enabled');
variable_set('language_count', count($languages[1]));
}
/**
* Remove duplicates in {locales_source}.
*/
function locale_update_7004() {
// Look up all duplicates. For each set of duplicates, we select the row
// with the lowest lid as the "master" that will be preserved.
$result_source = db_query("SELECT MIN(lid) AS lid, source, context FROM {locales_source} WHERE textgroup = 'default' GROUP BY source, context HAVING COUNT(*) > 1");
$conflict = FALSE;
foreach ($result_source as $source) {
// Find all rows in {locales_target} that are translations of the same
// string (incl. context).
$result_target = db_query("SELECT t.lid, t.language, t.plural, t.translation FROM {locales_source} s JOIN {locales_target} t ON s.lid = t.lid WHERE s.source = :source AND s.context = :context AND s.textgroup = 'default' ORDER BY lid", array(
':source' => $source->source,
':context' => $source->context,
));
$translations = array();
$keep_lids = array($source->lid);
foreach ($result_target as $target) {
if (!isset($translations[$target->language])) {
$translations[$target->language] = $target->translation;
if ($target->lid != $source->lid) {
// Move translation to the master lid.
db_query('UPDATE {locales_target} SET lid = :new_lid WHERE lid = :old_lid', array(
':new_lid' => $source->lid,
':old_lid' => $target->lid));
}
}
elseif ($translations[$target->language] == $target->translation) {
// Delete duplicate translation.
db_query('DELETE FROM {locales_target} WHERE lid = :lid AND language = :language', array(
':lid' => $target->lid,
':language' => $target->language));
}
else {
// The same string is translated into several different strings in one
// language. We do not know which is the preferred, so we keep them all.
$keep_lids[] = $target->lid;
$conflict = TRUE;
}
}
// Delete rows in {locales_source} that are no longer referenced from
// {locales_target}.
db_delete('locales_source')
->condition('source', $source->source)
->condition('context', $source->context)
->condition('textgroup', 'default')
->condition('lid', $keep_lids, 'NOT IN')
->execute();
}
if ($conflict) {
$url = 'http://drupal.org/node/746240';
drupal_set_message('Your {locales_source} table contains duplicates that could not be removed automatically. See ' . $url . ' for more information.', 'warning');
}
}
/**
* Increase {locales_languages}.formula column's length.
*/
function locale_update_7005() {
db_change_field('languages', 'formula', 'formula', array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
'description' => 'Plural formula in PHP code to evaluate to get plural indexes.',
));
}
/**
* @} End of "addtogroup updates-7.x-extra".
*/
/**
* Implements hook_uninstall().
*/
function locale_uninstall() {
// Delete all JavaScript translation files.
$locale_js_directory = 'public://' . variable_get('locale_js_directory', 'languages');
if (is_dir($locale_js_directory)) {
$files = db_query('SELECT language, javascript FROM {languages}');
foreach ($files as $file) {
if (!empty($file->javascript)) {
file_unmanaged_delete($locale_js_directory . '/' . $file->language . '_' . $file->javascript . '.js');
}
}
// Delete the JavaScript translations directory if empty.
if (!file_scan_directory($locale_js_directory, '/.*/')) {
drupal_rmdir($locale_js_directory);
}
}
// Clear variables.
variable_del('language_default');
variable_del('language_count');
variable_del('language_types');
variable_del('locale_language_negotiation_url_part');
variable_del('locale_language_negotiation_session_param');
variable_del('language_content_type_default');
variable_del('language_content_type_negotiation');
variable_del('locale_cache_strings');
variable_del('locale_js_directory');
variable_del('javascript_parsed');
variable_del('locale_field_language_fallback');
variable_del('locale_cache_length');
foreach (language_types() as $type) {
variable_del("language_negotiation_$type");
variable_del("locale_language_providers_weight_$type");
}
foreach (node_type_get_types() as $type => $content_type) {
$setting = variable_del("language_content_type_$type");
}
// Switch back to English: with a $language->language value different from 'en'
// successive calls of t() might result in calling locale(), which in turn might
// try to query the unexisting {locales_source} and {locales_target} tables.
drupal_language_initialize();
}
/**
* Implements hook_schema().
*/
function locale_schema() {
$schema['languages'] = array(
'description' => 'List of all available languages in the system.',
'fields' => array(
'language' => array(
'type' => 'varchar',
'length' => 12,
'not null' => TRUE,
'default' => '',
'description' => "Language code, e.g. 'de' or 'en-US'.",
),
'name' => array(
'type' => 'varchar',
'length' => 64,
'not null' => TRUE,
'default' => '',
'description' => 'Language name in English.',
),
'native' => array(
'type' => 'varchar',
'length' => 64,
'not null' => TRUE,
'default' => '',
'description' => 'Native language name.',
),
'direction' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'Direction of language (Left-to-Right = 0, Right-to-Left = 1).',
),
'enabled' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'Enabled flag (1 = Enabled, 0 = Disabled).',
),
'plurals' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'Number of plural indexes in this language.',
),
'formula' => array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
'description' => 'Plural formula in PHP code to evaluate to get plural indexes.',
),
'domain' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
'description' => 'Domain to use for this language.',
),
'prefix' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
'description' => 'Path prefix to use for this language.',
),
'weight' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'Weight, used in lists of languages.',
),
'javascript' => array(
'type' => 'varchar',
'length' => 64,
'not null' => TRUE,
'default' => '',
'description' => 'Location of JavaScript translation file.',
),
),
'primary key' => array('language'),
'indexes' => array(
'list' => array('weight', 'name'),
),
);
$schema['locales_source'] = array(
'description' => 'List of English source strings.',
'fields' => array(
'lid' => array(
'type' => 'serial',
'not null' => TRUE,
'description' => 'Unique identifier of this string.',
),
'location' => array(
'type' => 'text',
'not null' => FALSE,
'size' => 'big',
'description' => 'Drupal path in case of online discovered translations or file path in case of imported strings.',
),
'textgroup' => array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => 'default',
'description' => 'A module defined group of translations, see hook_locale().',
),
'source' => array(
'type' => 'text',
'mysql_type' => 'blob',
'not null' => TRUE,
'description' => 'The original string in English.',
),
'context' => array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
'description' => 'The context this string applies to.',
),
'version' => array(
'type' => 'varchar',
'length' => 20,
'not null' => TRUE,
'default' => 'none',
'description' => 'Version of Drupal, where the string was last used (for locales optimization).',
),
),
'primary key' => array('lid'),
'indexes' => array(
'source_context' => array(array('source', 30), 'context'),
),
);
$schema['locales_target'] = array(
'description' => 'Stores translated versions of strings.',
'fields' => array(
'lid' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'Source string ID. References {locales_source}.lid.',
),
'translation' => array(
'type' => 'text',
'mysql_type' => 'blob',
'not null' => TRUE,
'description' => 'Translation string value in this language.',
),
'language' => array(
'type' => 'varchar',
'length' => 12,
'not null' => TRUE,
'default' => '',
'description' => 'Language code. References {languages}.language.',
),
'plid' => array(
'type' => 'int',
'not null' => TRUE, // This should be NULL for no referenced string, not zero.
'default' => 0,
'description' => 'Parent lid (lid of the previous string in the plural chain) in case of plural strings. References {locales_source}.lid.',
),
'plural' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'Plural index number in case of plural strings.',
),
),
'primary key' => array('language', 'lid', 'plural'),
'foreign keys' => array(
'locales_source' => array(
'table' => 'locales_source',
'columns' => array('lid' => 'lid'),
),
),
'indexes' => array(
'lid' => array('lid'),
'plid' => array('plid'),
'plural' => array('plural'),
),
);
return $schema;
}
' . t('About') . '';
$output .= '' . t('The Locale module allows your Drupal site to be presented in languages other than the default English, and to be multilingual. The Locale module works by maintaining a database of translations, and examining text as it is about to be displayed. When a translation of the text is available in the language to be displayed, the translation is displayed rather than the original text. When a translation is unavailable, the original text is displayed, and then stored for review by a translator. For more information, see the online handbook entry for Locale module .', array('@locale' => 'http://drupal.org/documentation/modules/locale/')) . '
';
$output .= '' . t('Uses') . ' ';
$output .= '';
$output .= '' . t('Translating interface text') . ' ';
$output .= '' . t('Translations of text in the Drupal interface may be provided by:');
$output .= '';
$output .= '' . t("Translating within your site, using the Locale module's integrated translation interface .", array('@translate' => url('admin/config/regional/translate'))) . ' ';
$output .= '' . t('Importing files from a set of existing translations, known as a translation package. A translation package enables the display of a specific version of Drupal in a specific language, and contains files in the Gettext Portable Object (.po ) format. Although not all languages are available for every version of Drupal, translation packages for many languages are available for download from the Drupal translations page .', array('@translations' => 'http://localize.drupal.org')) . ' ';
$output .= '' . t("If an existing translation package does not meet your needs, the Gettext Portable Object (.po ) files within a package may be modified, or new .po files may be created, using a desktop Gettext editor. The Locale module's import feature allows the translated strings from a new or modified .po file to be added to your site. The Locale module's export feature generates files from your site's translated strings, that can either be shared with others or edited offline by a Gettext translation editor.", array('@import' => url('admin/config/regional/translate/import'), '@export' => url('admin/config/regional/translate/export'))) . ' ';
$output .= ' ';
$output .= '' . t('Configuring a multilingual site') . ' ';
$output .= '' . t("Language negotiation allows your site to automatically change language based on the domain or path used for each request. Users may (optionally) select their preferred language on their My account page, and your site can be configured to honor a web browser's preferred language settings. Site content can be translated using the Content translation module .", array('@content-help' => url('admin/help/translation'))) . ' ';
$output .= ' ';
return $output;
case 'admin/config/regional/language':
$output = '' . t('With multiple languages enabled, interface text can be translated, registered users may select their preferred language, and authors can assign a specific language to content. Download contributed translations from Drupal.org.', array('@translations' => 'http://localize.drupal.org')) . '
';
return $output;
case 'admin/config/regional/language/add':
return '' . t('Add a language to be supported by your site. If your desired language is not available in the Language name drop-down, click Custom language and provide a language code and other details manually. When providing a language code manually, be sure to enter a standardized language code, since this code may be used by browsers to determine an appropriate display language.') . '
';
case 'admin/config/regional/language/configure':
$output = '' . t("Define how to decide which language is used to display page elements (primarily text provided by Drupal and modules, such as field labels and help text). This decision is made by evaluating a series of detection methods for languages; the first detection method that gets a result will determine which language is used for that type of text. Define the order of evaluation of language detection methods on this page.") . '
';
return $output;
case 'admin/config/regional/language/configure/session':
$output = '' . t('Determine the language from a request/session parameter. Example: "http://example.com?language=de" sets language to German based on the use of "de" within the "language" parameter.') . '
';
return $output;
case 'admin/config/regional/translate':
$output = '' . t('This page provides an overview of available translatable strings. Drupal displays translatable strings in text groups; modules may define additional text groups containing other translatable strings. Because text groups provide a method of grouping related strings, they are often used to focus translation efforts on specific areas of the Drupal interface.') . '
';
$output .= '' . t('See the Languages page for more information on adding support for additional languages.', array('@languages' => url('admin/config/regional/language'))) . '
';
return $output;
case 'admin/config/regional/translate/import':
$output = '' . t('This page imports the translated strings contained in an individual Gettext Portable Object (.po ) file. Normally distributed as part of a translation package (each translation package may contain several .po files), a .po file may need to be imported after offline editing in a Gettext translation editor. Importing an individual .po file may be a lengthy process.') . '
';
$output .= '' . t('Note that the .po files within a translation package are imported automatically (if available) when new modules or themes are enabled, or as new languages are added. Since this page only allows the import of one .po file at a time, it may be simpler to download and extract a translation package into your Drupal installation directory and add the language (which automatically imports all .po files within the package). Translation packages are available for download on the Drupal translation page .', array('@language-add' => url('admin/config/regional/language/add'), '@translations' => 'http://localize.drupal.org')) . '
';
return $output;
case 'admin/config/regional/translate/export':
return '' . t('This page exports the translated strings used by your site. An export file may be in Gettext Portable Object (.po ) form, which includes both the original string and the translation (used to share translations with others), or in Gettext Portable Object Template (.pot ) form, which includes the original strings only (used to create new translations with a Gettext translation editor).') . '
';
case 'admin/config/regional/translate/translate':
return '' . t('This page allows a translator to search for specific translated and untranslated strings, and is used when creating or editing translations. (Note: For translation tasks involving many strings, it may be more convenient to export strings for offline editing in a desktop Gettext translation editor.) Searches may be limited to strings found within a specific text group or in a specific language.', array('@export' => url('admin/config/regional/translate/export'))) . '
';
case 'admin/structure/block/manage/%/%':
if ($arg[4] == 'locale' && $arg[5] == 'language') {
return '' . t('This block is only shown if at least two languages are enabled and language negotiation is set to URL or Session .', array('@languages' => url('admin/config/regional/language'), '@configuration' => url('admin/config/regional/language/configure'))) . '
';
}
break;
}
}
/**
* Implements hook_menu().
*/
function locale_menu() {
// Manage languages
$items['admin/config/regional/language'] = array(
'title' => 'Languages',
'description' => 'Configure languages for content and the user interface.',
'page callback' => 'drupal_get_form',
'page arguments' => array('locale_languages_overview_form'),
'access arguments' => array('administer languages'),
'file' => 'locale.admin.inc',
'weight' => -10,
);
$items['admin/config/regional/language/overview'] = array(
'title' => 'List',
'weight' => 0,
'type' => MENU_DEFAULT_LOCAL_TASK,
);
$items['admin/config/regional/language/add'] = array(
'title' => 'Add language',
'page callback' => 'locale_languages_add_screen', // two forms concatenated
'access arguments' => array('administer languages'),
'weight' => 5,
'type' => MENU_LOCAL_ACTION,
'file' => 'locale.admin.inc',
);
$items['admin/config/regional/language/configure'] = array(
'title' => 'Detection and selection',
'page callback' => 'drupal_get_form',
'page arguments' => array('locale_languages_configure_form'),
'access arguments' => array('administer languages'),
'weight' => 10,
'file' => 'locale.admin.inc',
'type' => MENU_LOCAL_TASK,
);
$items['admin/config/regional/language/configure/url'] = array(
'title' => 'URL language detection configuration',
'page callback' => 'drupal_get_form',
'page arguments' => array('locale_language_providers_url_form'),
'access arguments' => array('administer languages'),
'file' => 'locale.admin.inc',
'type' => MENU_VISIBLE_IN_BREADCRUMB,
);
$items['admin/config/regional/language/configure/session'] = array(
'title' => 'Session language detection configuration',
'page callback' => 'drupal_get_form',
'page arguments' => array('locale_language_providers_session_form'),
'access arguments' => array('administer languages'),
'file' => 'locale.admin.inc',
'type' => MENU_VISIBLE_IN_BREADCRUMB,
);
$items['admin/config/regional/language/edit/%'] = array(
'title' => 'Edit language',
'page callback' => 'drupal_get_form',
'page arguments' => array('locale_languages_edit_form', 5),
'access arguments' => array('administer languages'),
'file' => 'locale.admin.inc',
);
$items['admin/config/regional/language/delete/%'] = array(
'title' => 'Confirm',
'page callback' => 'drupal_get_form',
'page arguments' => array('locale_languages_delete_form', 5),
'access arguments' => array('administer languages'),
'file' => 'locale.admin.inc',
);
// Translation functionality
$items['admin/config/regional/translate'] = array(
'title' => 'Translate interface',
'description' => 'Translate the built in interface and optionally other text.',
'page callback' => 'locale_translate_overview_screen',
'access arguments' => array('translate interface'),
'file' => 'locale.admin.inc',
'weight' => -5,
);
$items['admin/config/regional/translate/overview'] = array(
'title' => 'Overview',
'weight' => 0,
'type' => MENU_DEFAULT_LOCAL_TASK,
);
$items['admin/config/regional/translate/translate'] = array(
'title' => 'Translate',
'weight' => 10,
'type' => MENU_LOCAL_TASK,
'page callback' => 'locale_translate_seek_screen', // search results and form concatenated
'access arguments' => array('translate interface'),
'file' => 'locale.admin.inc',
);
$items['admin/config/regional/translate/import'] = array(
'title' => 'Import',
'page callback' => 'drupal_get_form',
'page arguments' => array('locale_translate_import_form'),
'access arguments' => array('translate interface'),
'weight' => 20,
'type' => MENU_LOCAL_TASK,
'file' => 'locale.admin.inc',
);
$items['admin/config/regional/translate/export'] = array(
'title' => 'Export',
'page callback' => 'locale_translate_export_screen', // possibly multiple forms concatenated
'access arguments' => array('translate interface'),
'weight' => 30,
'type' => MENU_LOCAL_TASK,
'file' => 'locale.admin.inc',
);
$items['admin/config/regional/translate/edit/%'] = array(
'title' => 'Edit string',
'page callback' => 'drupal_get_form',
'page arguments' => array('locale_translate_edit_form', 5),
'access arguments' => array('translate interface'),
'file' => 'locale.admin.inc',
);
$items['admin/config/regional/translate/delete/%'] = array(
'title' => 'Delete string',
'page callback' => 'locale_translate_delete_page',
'page arguments' => array(5),
'access arguments' => array('translate interface'),
'file' => 'locale.admin.inc',
);
// Localize date formats.
$items['admin/config/regional/date-time/locale'] = array(
'title' => 'Localize',
'description' => 'Configure date formats for each locale',
'page callback' => 'locale_date_format_language_overview_page',
'access arguments' => array('administer site configuration'),
'type' => MENU_LOCAL_TASK,
'weight' => -8,
'file' => 'locale.admin.inc',
);
$items['admin/config/regional/date-time/locale/%/edit'] = array(
'title' => 'Localize date formats',
'description' => 'Configure date formats for each locale',
'page callback' => 'drupal_get_form',
'page arguments' => array('locale_date_format_form', 5),
'access arguments' => array('administer site configuration'),
'file' => 'locale.admin.inc',
);
$items['admin/config/regional/date-time/locale/%/reset'] = array(
'title' => 'Reset date formats',
'description' => 'Reset localized date formats to global defaults',
'page callback' => 'drupal_get_form',
'page arguments' => array('locale_date_format_reset_form', 5),
'access arguments' => array('administer site configuration'),
'file' => 'locale.admin.inc',
);
return $items;
}
/**
* Implements hook_init().
*
* Initialize date formats according to the user's current locale.
*/
function locale_init() {
global $conf, $language;
include_once DRUPAL_ROOT . '/includes/locale.inc';
// For each date type (e.g. long, short), get the localized date format
// for the user's current language and override the default setting for it
// in $conf. This should happen on all pages except the date and time formats
// settings page, where we want to display the site default and not the
// localized version.
if (strpos($_GET['q'], 'admin/config/regional/date-time/formats') !== 0) {
$languages = array($language->language);
// Setup appropriate date formats for this locale.
$formats = locale_get_localized_date_format($languages);
foreach ($formats as $format_type => $format) {
$conf[$format_type] = $format;
}
}
}
/**
* Implements hook_permission().
*/
function locale_permission() {
return array(
'administer languages' => array(
'title' => t('Administer languages'),
),
'translate interface' => array(
'title' => t('Translate interface texts'),
'restrict access' => TRUE,
),
);
}
/**
* Implements hook_locale().
*/
function locale_locale($op = 'groups') {
switch ($op) {
case 'groups':
return array('default' => t('Built-in interface'));
}
}
/**
* Form builder callback to display language selection widget.
*
* @ingroup forms
* @see locale_form_alter()
*/
function locale_language_selector_form(&$form, &$form_state, $user) {
global $language;
$languages = language_list('enabled');
$languages = $languages[1];
// If the user is being created, we set the user language to the page language.
$user_preferred_language = $user->uid ? user_preferred_language($user) : $language;
$names = array();
foreach ($languages as $langcode => $item) {
$name = t($item->name);
$names[$langcode] = $name . ($item->native != $name ? ' (' . $item->native . ')' : '');
}
$form['locale'] = array(
'#type' => 'fieldset',
'#title' => t('Language settings'),
'#weight' => 1,
'#access' => ($form['#user_category'] == 'account' || ($form['#user_category'] == 'register' && user_access('administer users'))),
);
// Get language negotiation settings.
$mode = language_negotiation_get(LANGUAGE_TYPE_INTERFACE) != LANGUAGE_NEGOTIATION_DEFAULT;
$form['locale']['language'] = array(
'#type' => (count($names) <= 5 ? 'radios' : 'select'),
'#title' => t('Language'),
'#default_value' => $user_preferred_language->language,
'#options' => $names,
'#description' => $mode ? t("This account's default language for e-mails, and preferred language for site presentation.") : t("This account's default language for e-mails."),
);
}
/**
* Implements hook_form_FORM_ID_alter().
*/
function locale_form_path_admin_form_alter(&$form, &$form_state) {
$form['language'] = array(
'#type' => 'select',
'#title' => t('Language'),
'#options' => array(LANGUAGE_NONE => t('All languages')) + locale_language_list('name'),
'#default_value' => $form['language']['#value'],
'#weight' => -10,
'#description' => t('A path alias set for a specific language will always be used when displaying this page in that language, and takes precedence over path aliases set for All languages .'),
);
}
/**
* Implements hook_form_FORM_ID_alter().
*/
function locale_form_node_type_form_alter(&$form, &$form_state) {
if (isset($form['type'])) {
$form['workflow']['language_content_type'] = array(
'#type' => 'radios',
'#title' => t('Multilingual support'),
'#default_value' => variable_get('language_content_type_' . $form['#node_type']->type, 0),
'#options' => array(t('Disabled'), t('Enabled')),
'#description' => t('Enable multilingual support for this content type. If enabled, a language selection field will be added to the editing form, allowing you to select from one of the enabled languages . If disabled, new posts are saved with the default language. Existing content will not be affected by changing this option.', array('!languages' => url('admin/config/regional/language'))),
);
}
}
/**
* Return whether the given content type has multilingual support.
*
* @return
* True if multilingual support is enabled.
*/
function locale_multilingual_node_type($type_name) {
return (bool) variable_get('language_content_type_' . $type_name, 0);
}
/**
* Implements hook_form_alter().
*
* Adds language fields to user forms.
*/
function locale_form_alter(&$form, &$form_state, $form_id) {
// Only alter user forms if there is more than one language.
if (drupal_multilingual()) {
// Display language selector when either creating a user on the admin
// interface or editing a user account.
if ($form_id == 'user_register_form' || ($form_id == 'user_profile_form' && $form['#user_category'] == 'account')) {
locale_language_selector_form($form, $form_state, $form['#user']);
}
}
}
/**
* Implements hook_form_BASE_FORM_ID_alter().
*/
function locale_form_node_form_alter(&$form, &$form_state) {
if (isset($form['#node']->type) && locale_multilingual_node_type($form['#node']->type)) {
$form['language'] = array(
'#type' => 'select',
'#title' => t('Language'),
'#default_value' => (isset($form['#node']->language) ? $form['#node']->language : ''),
'#options' => array(LANGUAGE_NONE => t('Language neutral')) + locale_language_list('name'),
);
}
// Node type without language selector: assign the default for new nodes
elseif (!isset($form['#node']->nid)) {
$default = language_default();
$form['language'] = array(
'#type' => 'value',
'#value' => $default->language
);
}
$form['#submit'][] = 'locale_field_node_form_submit';
}
/**
* Form submit handler for node_form().
*
* This submit handler needs to run before entity_form_submit_build_entity()
* is invoked by node_form_submit_build_node(), because it alters the values of
* attached fields. Therefore, it cannot be a hook_node_submit() implementation.
*/
function locale_field_node_form_submit($form, &$form_state) {
locale_field_entity_form_submit('node', $form, $form_state);
}
/**
* Implements hook_form_FORM_ID_alter().
*/
function locale_form_comment_form_alter(&$form, &$form_state, $form_id) {
// If a content type has multilingual support we set the content language as
// comment language.
if ($form['language']['#value'] == LANGUAGE_NONE && locale_multilingual_node_type($form['#node']->type)) {
global $language_content;
$form['language']['#value'] = $language_content->language;
$submit_callback = 'locale_field_comment_form_submit';
array_unshift($form['actions']['preview']['#submit'], $submit_callback);
array_unshift($form['#submit'], $submit_callback);
}
}
/**
* Form submit handler for comment_form().
*
* This submit handler needs to run before entity_form_submit_build_entity()
* is invoked by comment_form_submit_build_comment(), because it alters the
* values of attached fields.
*/
function locale_field_comment_form_submit($form, &$form_state) {
locale_field_entity_form_submit('comment', $form, $form_state);
}
/**
* Handles field language on submit for the given entity type.
*
* Checks if Locale is registered as a translation handler and handle possible
* language changes.
*/
function locale_field_entity_form_submit($entity_type, $form, &$form_state ) {
if (field_has_translation_handler($entity_type, 'locale')) {
$entity = (object) $form_state['values'];
$current_language = entity_language($entity_type, $entity);
list(, , $bundle) = entity_extract_ids($entity_type, $entity);
foreach (field_info_instances($entity_type, $bundle) as $instance) {
$field_name = $instance['field_name'];
$field = field_info_field($field_name);
$previous_language = $form[$field_name]['#language'];
// Handle a possible language change: new language values are inserted,
// previous ones are deleted.
if ($field['translatable'] && $previous_language != $current_language) {
$form_state['values'][$field_name][$current_language] = $entity->{$field_name}[$previous_language];
$form_state['values'][$field_name][$previous_language] = array();
}
}
}
}
/**
* Implements hook_theme().
*/
function locale_theme() {
return array(
'locale_languages_overview_form' => array(
'render element' => 'form',
),
'locale_languages_configure_form' => array(
'render element' => 'form',
),
'locale_date_format_form' => array(
'render element' => 'form',
),
);
}
/**
* Implements hook_field_language_alter().
*/
function locale_field_language_alter(&$display_language, $context) {
// Do not apply core language fallback rules if they are disabled or if Locale
// is not registered as a translation handler.
if (variable_get('locale_field_language_fallback', TRUE) && field_has_translation_handler($context['entity_type'], 'locale')) {
locale_field_language_fallback($display_language, $context['entity'], $context['language']);
}
}
/**
* Applies language fallback rules to the fields attached to the given entity.
*
* Core language fallback rules simply check if fields have a field translation
* for the requested language code. If so the requested language is returned,
* otherwise all the fallback candidates are inspected to see if there is a
* field translation available in another language.
* By default this is called by locale_field_language_alter(), but this
* behavior can be disabled by setting the 'locale_field_language_fallback'
* variable to FALSE.
*
* @param $display_language
* A reference to an array of language codes keyed by field name.
* @param $entity
* The entity to be displayed.
* @param $langcode
* The language code $entity has to be displayed in.
*/
function locale_field_language_fallback(&$display_language, $entity, $langcode) {
// Lazily init fallback candidates to avoid unnecessary calls.
$fallback_candidates = NULL;
$field_languages = array();
foreach ($display_language as $field_name => $field_language) {
// If the requested language is defined for the current field use it,
// otherwise search for a fallback value among the fallback candidates.
if (isset($entity->{$field_name}[$langcode])) {
$display_language[$field_name] = $langcode;
}
elseif (!empty($entity->{$field_name})) {
if (!isset($fallback_candidates)) {
require_once DRUPAL_ROOT . '/includes/language.inc';
$fallback_candidates = language_fallback_get_candidates();
}
foreach ($fallback_candidates as $fallback_language) {
if (isset($entity->{$field_name}[$fallback_language])) {
$display_language[$field_name] = $fallback_language;
break;
}
}
}
}
}
/**
* Implements hook_entity_info_alter().
*/
function locale_entity_info_alter(&$entity_info) {
$entity_info['node']['translation']['locale'] = TRUE;
if (isset($entity_info['comment'])) {
$entity_info['comment']['translation']['locale'] = TRUE;
}
}
/**
* Implements hook_language_types_info().
*
* Defines the three core language types:
* - Interface language is the only configurable language type in core. It is
* used by t() as the default language if none is specified.
* - Content language is by default non-configurable and inherits the interface
* language negotiated value. It is used by the Field API to determine the
* display language for fields if no explicit value is specified.
* - URL language is by default non-configurable and is determined through the
* URL language provider or the URL fallback provider if no language can be
* detected. It is used by l() as the default language if none is specified.
*/
function locale_language_types_info() {
require_once DRUPAL_ROOT . '/includes/locale.inc';
return array(
LANGUAGE_TYPE_INTERFACE => array(
'name' => t('User interface text'),
'description' => t('Order of language detection methods for user interface text. If a translation of user interface text is available in the detected language, it will be displayed.'),
),
LANGUAGE_TYPE_CONTENT => array(
'name' => t('Content'),
'description' => t('Order of language detection methods for content. If a version of content is available in the detected language, it will be displayed.'),
'fixed' => array(LOCALE_LANGUAGE_NEGOTIATION_INTERFACE),
),
LANGUAGE_TYPE_URL => array(
'name' => t('URL'),
'description' => t('Order of language detection methods for URLs. The detected language will be used as the default when generating URLs for internal links on the site.'),
'fixed' => array(LOCALE_LANGUAGE_NEGOTIATION_URL, LOCALE_LANGUAGE_NEGOTIATION_URL_FALLBACK),
),
);
}
/**
* Implements hook_language_negotiation_info().
*/
function locale_language_negotiation_info() {
require_once DRUPAL_ROOT . '/includes/locale.inc';
$file = 'includes/locale.inc';
$providers = array();
$providers[LOCALE_LANGUAGE_NEGOTIATION_URL] = array(
'types' => array(LANGUAGE_TYPE_CONTENT, LANGUAGE_TYPE_INTERFACE, LANGUAGE_TYPE_URL),
'callbacks' => array(
'language' => 'locale_language_from_url',
'switcher' => 'locale_language_switcher_url',
'url_rewrite' => 'locale_language_url_rewrite_url',
),
'file' => $file,
'weight' => -8,
'name' => t('URL'),
'description' => t('Determine the language from the URL (Path prefix or domain).'),
'config' => 'admin/config/regional/language/configure/url',
);
$providers[LOCALE_LANGUAGE_NEGOTIATION_SESSION] = array(
'callbacks' => array(
'language' => 'locale_language_from_session',
'switcher' => 'locale_language_switcher_session',
'url_rewrite' => 'locale_language_url_rewrite_session',
),
'file' => $file,
'weight' => -6,
'name' => t('Session'),
'description' => t('Determine the language from a request/session parameter.'),
'config' => 'admin/config/regional/language/configure/session',
);
$providers[LOCALE_LANGUAGE_NEGOTIATION_USER] = array(
'callbacks' => array('language' => 'locale_language_from_user'),
'file' => $file,
'weight' => -4,
'name' => t('User'),
'description' => t("Follow the user's language preference."),
);
$providers[LOCALE_LANGUAGE_NEGOTIATION_BROWSER] = array(
'callbacks' => array('language' => 'locale_language_from_browser'),
'file' => $file,
'weight' => -2,
'cache' => 0,
'name' => t('Browser'),
'description' => t("Determine the language from the browser's language settings."),
);
$providers[LOCALE_LANGUAGE_NEGOTIATION_INTERFACE] = array(
'types' => array(LANGUAGE_TYPE_CONTENT),
'callbacks' => array('language' => 'locale_language_from_interface'),
'file' => $file,
'weight' => 8,
'name' => t('Interface'),
'description' => t('Use the detected interface language.'),
);
$providers[LOCALE_LANGUAGE_NEGOTIATION_URL_FALLBACK] = array(
'types' => array(LANGUAGE_TYPE_URL),
'callbacks' => array('language' => 'locale_language_url_fallback'),
'file' => $file,
'weight' => 8,
'name' => t('URL fallback'),
'description' => t('Use an already detected language for URLs if none is found.'),
);
return $providers;
}
/**
* Implements hook_modules_enabled().
*/
function locale_modules_enabled($modules) {
include_once DRUPAL_ROOT . '/includes/language.inc';
language_types_set();
language_negotiation_purge();
}
/**
* Implements hook_modules_disabled().
*/
function locale_modules_disabled($modules) {
locale_modules_enabled($modules);
}
// ---------------------------------------------------------------------------------
// Locale core functionality
/**
* Provides interface translation services.
*
* This function is called from t() to translate a string if needed.
*
* @param $string
* A string to look up translation for. If omitted, all the
* cached strings will be returned in all languages already
* used on the page.
* @param $context
* The context of this string.
* @param $langcode
* Language code to use for the lookup.
*/
function locale($string = NULL, $context = NULL, $langcode = NULL) {
global $language;
// Use the advanced drupal_static() pattern, since this is called very often.
static $drupal_static_fast;
if (!isset($drupal_static_fast)) {
$drupal_static_fast['locale'] = &drupal_static(__FUNCTION__);
}
$locale_t = &$drupal_static_fast['locale'];
if (!isset($string)) {
// Return all cached strings if no string was specified
return $locale_t;
}
$langcode = isset($langcode) ? $langcode : $language->language;
// Store database cached translations in a static variable. Only build the
// cache after $language has been set to avoid an unnecessary cache rebuild.
if (!isset($locale_t[$langcode]) && isset($language)) {
$locale_t[$langcode] = array();
// Disabling the usage of string caching allows a module to watch for
// the exact list of strings used on a page. From a performance
// perspective that is a really bad idea, so we have no user
// interface for this. Be careful when turning this option off!
if (variable_get('locale_cache_strings', 1) == 1) {
if ($cache = cache_get('locale:' . $langcode, 'cache')) {
$locale_t[$langcode] = $cache->data;
}
elseif (lock_acquire('locale_cache_' . $langcode)) {
// Refresh database stored cache of translations for given language.
// We only store short strings used in current version, to improve
// performance and consume less memory.
$result = db_query("SELECT s.source, s.context, t.translation, t.language FROM {locales_source} s LEFT JOIN {locales_target} t ON s.lid = t.lid AND t.language = :language WHERE s.textgroup = 'default' AND s.version = :version AND LENGTH(s.source) < :length", array(':language' => $langcode, ':version' => VERSION, ':length' => variable_get('locale_cache_length', 75)));
foreach ($result as $data) {
$locale_t[$langcode][$data->context][$data->source] = (empty($data->translation) ? TRUE : $data->translation);
}
cache_set('locale:' . $langcode, $locale_t[$langcode]);
lock_release('locale_cache_' . $langcode);
}
}
}
// If we have the translation cached, skip checking the database
if (!isset($locale_t[$langcode][$context][$string])) {
// We do not have this translation cached, so get it from the DB.
$translation = db_query("SELECT s.lid, t.translation, s.version FROM {locales_source} s LEFT JOIN {locales_target} t ON s.lid = t.lid AND t.language = :language WHERE s.source = :source AND s.context = :context AND s.textgroup = 'default'", array(
':language' => $langcode,
':source' => $string,
':context' => (string) $context,
))->fetchObject();
if ($translation) {
// We have the source string at least.
// Cache translation string or TRUE if no translation exists.
$locale_t[$langcode][$context][$string] = (empty($translation->translation) ? TRUE : $translation->translation);
if ($translation->version != VERSION) {
// This is the first use of this string under current Drupal version. Save version
// and clear cache, to include the string into caching next time. Saved version is
// also a string-history information for later pruning of the tables.
db_update('locales_source')
->fields(array('version' => VERSION))
->condition('lid', $translation->lid)
->execute();
cache_clear_all('locale:', 'cache', TRUE);
}
}
else {
// We don't have the source string, cache this as untranslated.
db_merge('locales_source')
->insertFields(array(
'location' => request_uri(),
'version' => VERSION,
))
->key(array(
'source' => $string,
'context' => (string) $context,
'textgroup' => 'default',
))
->execute();
$locale_t[$langcode][$context][$string] = TRUE;
// Clear locale cache so this string can be added in a later request.
cache_clear_all('locale:', 'cache', TRUE);
}
}
return ($locale_t[$langcode][$context][$string] === TRUE ? $string : $locale_t[$langcode][$context][$string]);
}
/**
* Reset static variables used by locale().
*/
function locale_reset() {
drupal_static_reset('locale');
}
/**
* Returns plural form index for a specific number.
*
* The index is computed from the formula of this language.
*
* @param $count
* Number to return plural for.
* @param $langcode
* Optional language code to translate to a language other than
* what is used to display the page.
*
* @return
* The numeric index of the plural variant to use for this $langcode and
* $count combination or -1 if the language was not found or does not have a
* plural formula.
*/
function locale_get_plural($count, $langcode = NULL) {
global $language;
// Used to locally cache the plural formulas for all languages.
$plural_formulas = &drupal_static(__FUNCTION__, array());
// Used to store precomputed plural indexes corresponding to numbers
// individually for each language.
$plural_indexes = &drupal_static(__FUNCTION__ . ':plurals', array());
$langcode = $langcode ? $langcode : $language->language;
if (!isset($plural_indexes[$langcode][$count])) {
// Retrieve and statically cache the plural formulas for all languages.
if (empty($plural_formulas)) {
foreach (language_list() as $installed_language) {
$plural_formulas[$installed_language->language] = $installed_language->formula;
}
}
// If there is a plural formula for the language, evaluate it for the given
// $count and statically cache the result for the combination of language
// and count, since the result will always be identical.
if (!empty($plural_formulas[$langcode])) {
// $n is used inside the expression in the eval().
$n = $count;
$plural_indexes[$langcode][$count] = @eval('return intval(' . $plural_formulas[$langcode] . ');');
}
// In case there is no plural formula for English (no imported translation
// for English), use a default formula.
elseif ($langcode == 'en') {
$plural_indexes[$langcode][$count] = (int) ($count != 1);
}
// Otherwise, return -1 (unknown).
else {
$plural_indexes[$langcode][$count] = -1;
}
}
return $plural_indexes[$langcode][$count];
}
/**
* Returns a language name
*/
function locale_language_name($lang) {
$list = &drupal_static(__FUNCTION__);
if (!isset($list)) {
$list = locale_language_list();
}
return ($lang && isset($list[$lang])) ? $list[$lang] : t('All');
}
/**
* Returns array of language names
*
* @param $field
* 'name' => names in current language, localized
* 'native' => native names
* @param $all
* Boolean to return all languages or only enabled ones
*/
function locale_language_list($field = 'name', $all = FALSE) {
if ($all) {
$languages = language_list();
}
else {
$languages = language_list('enabled');
$languages = $languages[1];
}
$list = array();
foreach ($languages as $language) {
$list[$language->language] = ($field == 'name') ? t($language->name) : $language->$field;
}
return $list;
}
/**
* Implements hook_modules_installed().
*/
function locale_modules_installed($modules) {
locale_system_update($modules);
}
/**
* Implements hook_themes_enabled().
*
* @todo This is technically wrong. We must not import upon enabling, but upon
* initial installation. The theme system is missing an installation hook.
*/
function locale_themes_enabled($themes) {
locale_system_update($themes);
}
/**
* Imports translations when new modules or themes are installed.
*
* This function will either import translation for the component change
* right away, or start a batch if more files need to be imported.
*
* @param $components
* An array of component (theme and/or module) names to import
* translations for.
*/
function locale_system_update($components) {
include_once DRUPAL_ROOT . '/includes/locale.inc';
if ($batch = locale_batch_by_component($components)) {
batch_set($batch);
}
}
/**
* Implements hook_js_alter().
*
* This function checks all JavaScript files currently added via drupal_add_js()
* and invokes parsing if they have not yet been parsed for Drupal.t()
* and Drupal.formatPlural() calls. Also refreshes the JavaScript translation
* file if necessary, and adds it to the page.
*/
function locale_js_alter(&$javascript) {
global $language;
$dir = 'public://' . variable_get('locale_js_directory', 'languages');
$parsed = variable_get('javascript_parsed', array());
$files = $new_files = FALSE;
// Require because locale_js_alter() could be called without locale_init().
require_once DRUPAL_ROOT . '/includes/locale.inc';
foreach ($javascript as $item) {
if ($item['type'] == 'file') {
$files = TRUE;
$filepath = $item['data'];
if (!in_array($filepath, $parsed)) {
// Don't parse our own translations files.
if (substr($filepath, 0, strlen($dir)) != $dir) {
_locale_parse_js_file($filepath);
$parsed[] = $filepath;
$new_files = TRUE;
}
}
}
}
// If there are any new source files we parsed, invalidate existing
// JavaScript translation files for all languages, adding the refresh
// flags into the existing array.
if ($new_files) {
$parsed += _locale_invalidate_js();
}
// If necessary, rebuild the translation file for the current language.
if (!empty($parsed['refresh:' . $language->language])) {
// Don't clear the refresh flag on failure, so that another try will
// be performed later.
if (_locale_rebuild_js()) {
unset($parsed['refresh:' . $language->language]);
}
// Store any changes after refresh was attempted.
variable_set('javascript_parsed', $parsed);
}
// If no refresh was attempted, but we have new source files, we need
// to store them too. This occurs if current page is in English.
elseif ($new_files) {
variable_set('javascript_parsed', $parsed);
}
// Add the translation JavaScript file to the page.
if ($files && !empty($language->javascript)) {
// Add the translation JavaScript file to the page.
$file = $dir . '/' . $language->language . '_' . $language->javascript . '.js';
$javascript[$file] = drupal_js_defaults($file);
}
}
/**
* Implements hook_css_alter().
*
* This function checks all CSS files currently added via drupal_add_css() and
* and checks to see if a related right to left CSS file should be included.
*/
function locale_css_alter(&$css) {
global $language;
// If the current language is RTL, add the CSS file with the RTL overrides.
if ($language->direction == LANGUAGE_RTL) {
foreach ($css as $data => $item) {
// Only provide RTL overrides for files.
if ($item['type'] == 'file') {
$rtl_path = str_replace('.css', '-rtl.css', $item['data']);
if (file_exists($rtl_path) && !isset($css[$rtl_path])) {
// Replicate the same item, but with the RTL path and a little larger
// weight so that it appears directly after the original CSS file.
$item['data'] = $rtl_path;
$item['weight'] += 0.0001;
$css[$rtl_path] = $item;
}
}
}
}
}
/**
* Implement hook_library_alter().
*
* Provides the language support for the jQuery UI Date Picker.
*/
function locale_library_alter(&$libraries, $module) {
if ($module == 'system' && isset($libraries['ui.datepicker'])) {
global $language;
// locale.datepicker.js should be added in the JS_LIBRARY group, so that
// this attach behavior will execute early. JS_LIBRARY is the default for
// hook_library_info_alter(), thus does not have to be specified explicitly.
$datepicker = drupal_get_path('module', 'locale') . '/locale.datepicker.js';
$libraries['ui.datepicker']['js'][$datepicker] = array();
$libraries['ui.datepicker']['js'][] = array(
'data' => array(
'jquery' => array(
'ui' => array(
'datepicker' => array(
'isRTL' => $language->direction == LANGUAGE_RTL,
'firstDay' => variable_get('date_first_day', 0),
),
),
),
),
'type' => 'setting',
);
}
}
// ---------------------------------------------------------------------------------
// Language switcher block
/**
* Implements hook_block_info().
*/
function locale_block_info() {
include_once DRUPAL_ROOT . '/includes/language.inc';
$block = array();
$info = language_types_info();
foreach (language_types_configurable(FALSE) as $type) {
$block[$type] = array(
'info' => t('Language switcher (@type)', array('@type' => $info[$type]['name'])),
// Not worth caching.
'cache' => DRUPAL_NO_CACHE,
);
}
return $block;
}
/**
* Implements hook_block_view().
*
* Displays a language switcher. Only show if we have at least two languages.
*/
function locale_block_view($type) {
if (drupal_multilingual()) {
$path = drupal_is_front_page() ? '' : $_GET['q'];
$links = language_negotiation_get_switch_links($type, $path);
if (isset($links->links)) {
drupal_add_css(drupal_get_path('module', 'locale') . '/locale.css');
$class = "language-switcher-{$links->provider}";
$variables = array('links' => $links->links, 'attributes' => array('class' => array($class)));
$block['content'] = theme('links__locale_block', $variables);
$block['subject'] = t('Languages');
return $block;
}
}
}
/**
* Implements hook_url_outbound_alter().
*
* Rewrite outbound URLs with language based prefixes.
*/
function locale_url_outbound_alter(&$path, &$options, $original_path) {
// Only modify internal URLs.
if (!$options['external'] && drupal_multilingual()) {
static $drupal_static_fast;
if (!isset($drupal_static_fast)) {
$drupal_static_fast['callbacks'] = &drupal_static(__FUNCTION__);
}
$callbacks = &$drupal_static_fast['callbacks'];
if (!isset($callbacks)) {
$callbacks = array();
include_once DRUPAL_ROOT . '/includes/language.inc';
foreach (language_types_configurable() as $type) {
// Get URL rewriter callbacks only from enabled language providers.
$negotiation = variable_get("language_negotiation_$type", array());
foreach ($negotiation as $id => $provider) {
if (isset($provider['callbacks']['url_rewrite'])) {
if (isset($provider['file'])) {
require_once DRUPAL_ROOT . '/' . $provider['file'];
}
// Avoid duplicate callback entries.
$callbacks[$provider['callbacks']['url_rewrite']] = TRUE;
}
}
}
$callbacks = array_keys($callbacks);
}
foreach ($callbacks as $callback) {
$callback($path, $options);
}
// No language dependent path allowed in this mode.
if (empty($callbacks)) {
unset($options['language']);
}
}
}
'Language configuration',
'description' => 'Adds a new locale and tests changing its status and the default language.',
'group' => 'Locale',
);
}
function setUp() {
parent::setUp('locale');
}
/**
* Functional tests for adding, editing and deleting languages.
*/
function testLanguageConfiguration() {
global $base_url;
// User to add and remove language.
$admin_user = $this->drupalCreateUser(array('administer languages', 'access administration pages'));
$this->drupalLogin($admin_user);
// Add predefined language.
$edit = array(
'langcode' => 'fr',
);
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add language'));
$this->assertText('fr', 'Language added successfully.');
$this->assertEqual($this->getUrl(), url('admin/config/regional/language', array('absolute' => TRUE)), 'Correct page redirection.');
// Add custom language.
// Code for the language.
$langcode = 'xx';
// The English name for the language.
$name = $this->randomName(16);
// The native name for the language.
$native = $this->randomName(16);
// The domain prefix.
$prefix = $langcode;
$edit = array(
'langcode' => $langcode,
'name' => $name,
'native' => $native,
'prefix' => $prefix,
'direction' => '0',
);
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add custom language'));
$this->assertEqual($this->getUrl(), url('admin/config/regional/language', array('absolute' => TRUE)), 'Correct page redirection.');
$this->assertText($langcode, 'Language code found.');
$this->assertText($name, 'Name found.');
$this->assertText($native, 'Native found.');
$this->assertText($native, 'Test language added.');
// Check if we can change the default language.
$path = 'admin/config/regional/language';
$this->drupalGet($path);
$this->assertFieldChecked('edit-site-default-en', 'English is the default language.');
// Change the default language.
$edit = array(
'site_default' => $langcode,
);
$this->drupalPost(NULL, $edit, t('Save configuration'));
$this->assertNoFieldChecked('edit-site-default-en', 'Default language updated.');
$this->assertEqual($this->getUrl(), url('admin/config/regional/language', array('absolute' => TRUE)), 'Correct page redirection.');
// Check if a valid language prefix is added after changing the default
// language.
$this->drupalGet('admin/config/regional/language/edit/en');
$this->assertFieldByXPath('//input[@name="prefix"]', 'en', 'A valid path prefix has been added to the previous default language.');
// Ensure we can't delete the default language.
$this->drupalGet('admin/config/regional/language/delete/' . $langcode);
$this->assertEqual($this->getUrl(), url('admin/config/regional/language', array('absolute' => TRUE)), 'Correct page redirection.');
$this->assertText(t('The default language cannot be deleted.'), 'Failed to delete the default language.');
// Check if we can disable a language.
$edit = array(
'enabled[en]' => FALSE,
);
$this->drupalPost($path, $edit, t('Save configuration'));
$this->assertNoFieldChecked('edit-enabled-en', 'Language disabled.');
// Set disabled language to be the default and ensure it is re-enabled.
$edit = array(
'site_default' => 'en',
);
$this->drupalPost(NULL, $edit, t('Save configuration'));
$this->assertFieldChecked('edit-enabled-en', 'Default language re-enabled.');
// Ensure 'edit' link works.
$this->clickLink(t('edit'));
$this->assertTitle(t('Edit language | Drupal'), 'Page title is "Edit language".');
// Edit a language.
$name = $this->randomName(16);
$edit = array(
'name' => $name,
);
$this->drupalPost('admin/config/regional/language/edit/' . $langcode, $edit, t('Save language'));
$this->assertRaw($name, 'The language has been updated.');
$this->assertEqual($this->getUrl(), url('admin/config/regional/language', array('absolute' => TRUE)), 'Correct page redirection.');
// Ensure 'delete' link works.
$this->drupalGet('admin/config/regional/language');
$this->clickLink(t('delete'));
$this->assertText(t('Are you sure you want to delete the language'), '"delete" link is correct.');
// Delete an enabled language.
$this->drupalGet('admin/config/regional/language/delete/' . $langcode);
// First test the 'cancel' link.
$this->clickLink(t('Cancel'));
$this->assertEqual($this->getUrl(), url('admin/config/regional/language', array('absolute' => TRUE)), 'Correct page redirection.');
$this->assertRaw($name, 'The language was not deleted.');
// Delete the language for real. This a confirm form, we do not need any
// fields changed.
$this->drupalPost('admin/config/regional/language/delete/' . $langcode, array(), t('Delete'));
// We need raw here because %locale will add HTML.
$this->assertRaw(t('The language %locale has been removed.', array('%locale' => $name)), 'The test language has been removed.');
$this->assertEqual($this->getUrl(), url('admin/config/regional/language', array('absolute' => TRUE)), 'Correct page redirection.');
// Verify that language is no longer found.
$this->drupalGet('admin/config/regional/language/delete/' . $langcode);
$this->assertResponse(404, 'Language no longer found.');
// Make sure the "language_count" variable has been updated correctly.
drupal_static_reset('language_list');
$enabled = language_list('enabled');
$this->assertEqual(variable_get('language_count', 1), count($enabled[1]), 'Language count is correct.');
// Delete a disabled language.
// Disable an enabled language.
$edit = array(
'enabled[fr]' => FALSE,
);
$this->drupalPost($path, $edit, t('Save configuration'));
$this->assertNoFieldChecked('edit-enabled-fr', 'French language disabled.');
// Get the count of enabled languages.
drupal_static_reset('language_list');
$enabled = language_list('enabled');
// Delete the disabled language.
$this->drupalPost('admin/config/regional/language/delete/fr', array(), t('Delete'));
// We need raw here because %locale will add HTML.
$this->assertRaw(t('The language %locale has been removed.', array('%locale' => 'French')), 'Disabled language has been removed.');
$this->assertEqual($this->getUrl(), url('admin/config/regional/language', array('absolute' => TRUE)), 'Correct page redirection.');
// Verify that language is no longer found.
$this->drupalGet('admin/config/regional/language/delete/fr');
$this->assertResponse(404, 'Language no longer found.');
// Make sure the "language_count" variable has not changed.
$this->assertEqual(variable_get('language_count', 1), count($enabled[1]), 'Language count is correct.');
// Ensure we can't delete the English language.
$this->drupalGet('admin/config/regional/language/delete/en');
$this->assertEqual($this->getUrl(), url('admin/config/regional/language', array('absolute' => TRUE)), 'Correct page redirection.');
$this->assertText(t('The English language cannot be deleted.'), 'Failed to delete English language.');
}
}
/**
* Tests localization of the JavaScript libraries.
*
* Currently, only the jQuery datepicker is localized using Drupal translations.
*/
class LocaleLibraryInfoAlterTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Javascript library localisation',
'description' => 'Tests the localisation of JavaScript libraries.',
'group' => 'Locale',
);
}
function setUp() {
parent::setUp('locale', 'locale_test');
}
/**
* Verifies that the datepicker can be localized.
*
* @see locale_library_info_alter()
*/
public function testLibraryInfoAlter() {
drupal_add_library('system', 'ui.datepicker');
$scripts = drupal_get_js();
$this->assertTrue(strpos($scripts, 'locale.datepicker.js'), 'locale.datepicker.js added to scripts.');
}
}
/**
* Functional tests for JavaScript parsing for translatable strings.
*/
class LocaleJavascriptTranslationTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Javascript translation',
'description' => 'Tests parsing js files for translatable strings',
'group' => 'Locale',
);
}
function setUp() {
parent::setUp('locale', 'locale_test');
}
function testFileParsing() {
$filename = drupal_get_path('module', 'locale_test') . '/locale_test.js';
// Parse the file to look for source strings.
_locale_parse_js_file($filename);
// Get all of the source strings that were found.
$source_strings = db_select('locales_source', 's')
->fields('s', array('source', 'context'))
->condition('s.location', $filename)
->execute()
->fetchAllKeyed();
// List of all strings that should be in the file.
$test_strings = array(
"Standard Call t" => '',
"Whitespace Call t" => '',
"Single Quote t" => '',
"Single Quote \\'Escaped\\' t" => '',
"Single Quote Concat strings t" => '',
"Double Quote t" => '',
"Double Quote \\\"Escaped\\\" t" => '',
"Double Quote Concat strings t" => '',
"Context !key Args t" => "Context string",
"Context Unquoted t" => "Context string unquoted",
"Context Single Quoted t" => "Context string single quoted",
"Context Double Quoted t" => "Context string double quoted",
"Standard Call plural" => '',
"Standard Call @count plural" => '',
"Whitespace Call plural" => '',
"Whitespace Call @count plural" => '',
"Single Quote plural" => '',
"Single Quote @count plural" => '',
"Single Quote \\'Escaped\\' plural" => '',
"Single Quote \\'Escaped\\' @count plural" => '',
"Double Quote plural" => '',
"Double Quote @count plural" => '',
"Double Quote \\\"Escaped\\\" plural" => '',
"Double Quote \\\"Escaped\\\" @count plural" => '',
"Context !key Args plural" => "Context string",
"Context !key Args @count plural" => "Context string",
"Context Unquoted plural" => "Context string unquoted",
"Context Unquoted @count plural" => "Context string unquoted",
"Context Single Quoted plural" => "Context string single quoted",
"Context Single Quoted @count plural" => "Context string single quoted",
"Context Double Quoted plural" => "Context string double quoted",
"Context Double Quoted @count plural" => "Context string double quoted",
);
// Assert that all strings were found properly.
foreach ($test_strings as $str => $context) {
$args = array('%source' => $str, '%context' => $context);
// Make sure that the string was found in the file.
$this->assertTrue(isset($source_strings[$str]), format_string('Found source string: %source', $args));
// Make sure that the proper context was matched.
$this->assertTrue(isset($source_strings[$str]) && $source_strings[$str] === $context, strlen($context) > 0 ? format_string('Context for %source is %context', $args) : format_string('Context for %source is blank', $args));
}
$this->assertEqual(count($source_strings), count($test_strings), 'Found correct number of source strings.');
}
/**
* Test handling of null values in JS parsing for PHP8.0+ deprecations.
*/
function testNullValuesLocalesSource() {
db_insert('locales_source')
->fields(array(
'location' => NULL,
'source' => 'Standard Call t',
'context' => '',
'textgroup' => 'default',
))
->execute();
$filename = drupal_get_path('module', 'locale_test') . '/locale_test.js';
// Parse the file to look for source strings.
_locale_parse_js_file($filename);
$num_records = db_select('locales_source')->fields(NULL, array('lid'))->countQuery()->execute()->fetchField();
$this->assertEqual($num_records, 32, 'Correct number of strings parsed from JS file');
}
}
/**
* Functional test for string translation and validation.
*/
class LocaleTranslationFunctionalTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'String translate, search and validate',
'description' => 'Adds a new locale and translates its name. Checks the validation of translation strings and search results.',
'group' => 'Locale',
);
}
function setUp() {
parent::setUp('locale');
}
/**
* Adds a language and tests string translation by users with the appropriate permissions.
*/
function testStringTranslation() {
global $base_url;
// User to add and remove language.
$admin_user = $this->drupalCreateUser(array('administer languages', 'access administration pages'));
// User to translate and delete string.
$translate_user = $this->drupalCreateUser(array('translate interface', 'access administration pages'));
// Code for the language.
$langcode = 'xx';
// The English name for the language. This will be translated.
$name = $this->randomName(16);
// The native name for the language.
$native = $this->randomName(16);
// The domain prefix.
$prefix = $langcode;
// This is the language indicator on the translation search screen for
// untranslated strings. Copied straight from locale.inc.
$language_indicator = "$langcode ";
// This will be the translation of $name.
$translation = $this->randomName(16);
// Add custom language.
$this->drupalLogin($admin_user);
$edit = array(
'langcode' => $langcode,
'name' => $name,
'native' => $native,
'prefix' => $prefix,
'direction' => '0',
);
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add custom language'));
// Add string.
t($name, array(), array('langcode' => $langcode));
// Reset locale cache.
locale_reset();
$this->assertText($langcode, 'Language code found.');
$this->assertText($name, 'Name found.');
$this->assertText($native, 'Native found.');
// No t() here, we do not want to add this string to the database and it's
// surely not translated yet.
$this->assertText($native, 'Test language added.');
$this->drupalLogout();
// Search for the name and translate it.
$this->drupalLogin($translate_user);
$search = array(
'string' => $name,
'language' => 'all',
'translation' => 'all',
'group' => 'all',
);
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
// assertText() seems to remove the input field where $name always could be
// found, so this is not a false assert. See how assertNoText succeeds
// later.
$this->assertText($name, 'Search found the name.');
$this->assertRaw($language_indicator, 'Name is untranslated.');
// Assume this is the only result, given the random name.
$this->clickLink(t('edit'));
// We save the lid from the path.
$matches = array();
preg_match('!admin/config/regional/translate/edit/(\d+)!', $this->getUrl(), $matches);
$lid = $matches[1];
// No t() here, it's surely not translated yet.
$this->assertText($name, 'name found on edit screen.');
$edit = array(
"translations[$langcode]" => $translation,
);
$this->drupalPost(NULL, $edit, t('Save translations'));
$this->assertText(t('The string has been saved.'), 'The string has been saved.');
$this->assertEqual($this->getUrl(), url('admin/config/regional/translate/translate', array('absolute' => TRUE)), 'Correct page redirection.');
$this->assertTrue($name != $translation && t($name, array(), array('langcode' => $langcode)) == $translation, 't() works.');
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
// The indicator should not be here.
$this->assertNoRaw($language_indicator, 'String is translated.');
// Verify that a translation set which has an empty target string can be
// updated without any database error.
db_update('locales_target')
->fields(array('translation' => ''))
->condition('language', $langcode, '=')
->condition('lid', $lid, '=')
->execute();
$this->drupalPost('admin/config/regional/translate/edit/' . $lid, $edit, t('Save translations'));
$this->assertText(t('The string has been saved.'), 'The string has been saved.');
// Try to edit a non-existent string and ensure we're redirected correctly.
// Assuming we don't have 999,999 strings already.
$random_lid = 999999;
$this->drupalGet('admin/config/regional/translate/edit/' . $random_lid);
$this->assertText(t('String not found'), 'String not found.');
$this->assertEqual($this->getUrl(), url('admin/config/regional/translate/translate', array('absolute' => TRUE)), 'Correct page redirection.');
$this->drupalLogout();
// Delete the language.
$this->drupalLogin($admin_user);
$path = 'admin/config/regional/language/delete/' . $langcode;
// This a confirm form, we do not need any fields changed.
$this->drupalPost($path, array(), t('Delete'));
// We need raw here because %locale will add HTML.
$this->assertRaw(t('The language %locale has been removed.', array('%locale' => $name)), 'The test language has been removed.');
// Reload to remove $name.
$this->drupalGet($path);
// Verify that language is no longer found.
$this->assertResponse(404, 'Language no longer found.');
$this->drupalLogout();
// Delete the string.
$this->drupalLogin($translate_user);
$search = array(
'string' => $name,
'language' => 'all',
'translation' => 'all',
'group' => 'all',
);
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
// Assume this is the only result, given the random name.
$this->clickLink(t('delete'));
$this->assertText(t('Are you sure you want to delete the string'), '"delete" link is correct.');
// Delete the string.
$path = 'admin/config/regional/translate/delete/' . $lid;
$this->drupalGet($path);
// First test the 'cancel' link.
$this->clickLink(t('Cancel'));
$this->assertEqual($this->getUrl(), url('admin/config/regional/translate/translate', array('absolute' => TRUE)), 'Correct page redirection.');
$this->assertRaw($name, 'The string was not deleted.');
// Delete the name string.
$this->drupalPost('admin/config/regional/translate/delete/' . $lid, array(), t('Delete'));
$this->assertText(t('The string has been removed.'), 'The string has been removed message.');
$this->assertEqual($this->getUrl(), url('admin/config/regional/translate/translate', array('absolute' => TRUE)), 'Correct page redirection.');
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
$this->assertNoText($name, 'Search now can not find the name.');
}
/*
* Adds a language and checks that the JavaScript translation files are
* properly created and rebuilt on deletion.
*/
function testJavaScriptTranslation() {
$user = $this->drupalCreateUser(array('translate interface', 'administer languages', 'access administration pages'));
$this->drupalLogin($user);
$langcode = 'xx';
// The English name for the language. This will be translated.
$name = $this->randomName(16);
// The native name for the language.
$native = $this->randomName(16);
// The domain prefix.
$prefix = $langcode;
// Add custom language.
$edit = array(
'langcode' => $langcode,
'name' => $name,
'native' => $native,
'prefix' => $prefix,
'direction' => '0',
);
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add custom language'));
drupal_static_reset('language_list');
// Build the JavaScript translation file.
$this->drupalGet('admin/config/regional/translate/translate');
// Retrieve the id of the first string available in the {locales_source}
// table and translate it.
$query = db_select('locales_source', 'l');
$query->addExpression('min(l.lid)', 'lid');
$result = $query->condition('l.location', '%.js%', 'LIKE')
->condition('l.textgroup', 'default')
->execute();
$url = 'admin/config/regional/translate/edit/' . $result->fetchObject()->lid;
$edit = array('translations['. $langcode .']' => $this->randomName());
$this->drupalPost($url, $edit, t('Save translations'));
// Trigger JavaScript translation parsing and building.
require_once DRUPAL_ROOT . '/includes/locale.inc';
_locale_rebuild_js($langcode);
// Retrieve the JavaScript translation hash code for the custom language to
// check that the translation file has been properly built.
$file = db_select('languages', 'l')
->fields('l', array('javascript'))
->condition('language', $langcode)
->execute()
->fetchObject();
$js_file = 'public://' . variable_get('locale_js_directory', 'languages') . '/' . $langcode . '_' . $file->javascript . '.js';
$this->assertTrue($result = file_exists($js_file), format_string('JavaScript file created: %file', array('%file' => $result ? $js_file : 'not found')));
// Test JavaScript translation rebuilding.
file_unmanaged_delete($js_file);
$this->assertTrue($result = !file_exists($js_file), format_string('JavaScript file deleted: %file', array('%file' => $result ? $js_file : 'found')));
cache_clear_all();
_locale_rebuild_js($langcode);
$this->assertTrue($result = file_exists($js_file), format_string('JavaScript file rebuilt: %file', array('%file' => $result ? $js_file : 'not found')));
}
/**
* Tests the validation of the translation input.
*/
function testStringValidation() {
global $base_url;
// User to add language and strings.
$admin_user = $this->drupalCreateUser(array('administer languages', 'access administration pages', 'translate interface'));
$this->drupalLogin($admin_user);
$langcode = 'xx';
// The English name for the language. This will be translated.
$name = $this->randomName(16);
// The native name for the language.
$native = $this->randomName(16);
// The domain prefix.
$prefix = $langcode;
// This is the language indicator on the translation search screen for
// untranslated strings. Copied straight from locale.inc.
$language_indicator = "$langcode ";
// These will be the invalid translations of $name.
$key = $this->randomName(16);
$bad_translations[$key] = "" . $key;
$key = $this->randomName(16);
$bad_translations[$key] = '$langcode ";
// This will be the translation of $name.
$translation = $this->randomName(16);
// Add custom language.
$this->drupalLogin($admin_user);
$edit = array(
'langcode' => $langcode,
'name' => $name,
'native' => $native,
'prefix' => $prefix,
'direction' => '0',
);
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add custom language'));
// Add string.
t($name, array(), array('langcode' => $langcode));
// Reset locale cache.
locale_reset();
$this->drupalLogout();
// Search for the name.
$this->drupalLogin($translate_user);
$search = array(
'string' => $name,
'language' => 'all',
'translation' => 'all',
'group' => 'all',
);
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
// assertText() seems to remove the input field where $name always could be
// found, so this is not a false assert. See how assertNoText succeeds
// later.
$this->assertText($name, 'Search found the string.');
// Ensure untranslated string doesn't appear if searching on 'only
// translated strings'.
$search = array(
'string' => $name,
'language' => 'all',
'translation' => 'translated',
'group' => 'all',
);
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
$this->assertText(t('No strings available.'), "Search didn't find the string.");
// Ensure untranslated string appears if searching on 'only untranslated
// strings' in "all" (hasn't been translated to any language).
$search = array(
'string' => $name,
'language' => 'all',
'translation' => 'untranslated',
'group' => 'all',
);
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
$this->assertNoText(t('No strings available.'), 'Search found the string.');
// Ensure untranslated string appears if searching on 'only untranslated
// strings' in the custom language (hasn't been translated to that specific language).
$search = array(
'string' => $name,
'language' => $langcode,
'translation' => 'untranslated',
'group' => 'all',
);
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
$this->assertNoText(t('No strings available.'), 'Search found the string.');
// Add translation.
// Assume this is the only result, given the random name.
$this->clickLink(t('edit'));
// We save the lid from the path.
$matches = array();
preg_match('!admin/config/regional/translate/edit/(\d)+!', $this->getUrl(), $matches);
$lid = $matches[1];
$edit = array(
"translations[$langcode]" => $translation,
);
$this->drupalPost(NULL, $edit, t('Save translations'));
// Ensure translated string does appear if searching on 'only
// translated strings'.
$search = array(
'string' => $translation,
'language' => 'all',
'translation' => 'translated',
'group' => 'all',
);
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
$this->assertNoText(t('No strings available.'), 'Search found the translation.');
// Ensure translated source string doesn't appear if searching on 'only
// untranslated strings'.
$search = array(
'string' => $name,
'language' => 'all',
'translation' => 'untranslated',
'group' => 'all',
);
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
$this->assertText(t('No strings available.'), "Search didn't find the source string.");
// Ensure translated string doesn't appear if searching on 'only
// untranslated strings'.
$search = array(
'string' => $translation,
'language' => 'all',
'translation' => 'untranslated',
'group' => 'all',
);
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
$this->assertText(t('No strings available.'), "Search didn't find the translation.");
// Ensure translated string does appear if searching on the custom language.
$search = array(
'string' => $translation,
'language' => $langcode,
'translation' => 'all',
'group' => 'all',
);
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
$this->assertNoText(t('No strings available.'), 'Search found the translation.');
// Ensure translated string doesn't appear if searching on English.
$search = array(
'string' => $translation,
'language' => 'en',
'translation' => 'all',
'group' => 'all',
);
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
$this->assertText(t('No strings available.'), "Search didn't find the translation.");
// Search for a string that isn't in the system.
$unavailable_string = $this->randomName(16);
$search = array(
'string' => $unavailable_string,
'language' => 'all',
'translation' => 'all',
'group' => 'all',
);
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
$this->assertText(t('No strings available.'), "Search didn't find the invalid string.");
}
}
/**
* Tests plural index computation functionality.
*/
class LocalePluralFormatTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Plural formula evaluation',
'description' => 'Tests plural formula evaluation for various languages.',
'group' => 'Locale',
);
}
function setUp() {
parent::setUp('locale', 'locale_test');
$admin_user = $this->drupalCreateUser(array('administer languages', 'translate interface', 'access administration pages'));
$this->drupalLogin($admin_user);
// Import some .po files with formulas to set up the environment.
// These will also add the languages to the system and enable them.
$this->importPoFile($this->getPoFileWithSimplePlural(), array(
'langcode' => 'fr',
));
$this->importPoFile($this->getPoFileWithComplexPlural(), array(
'langcode' => 'hr',
));
}
/**
* Tests locale_get_plural() functionality.
*/
function testGetPluralFormat() {
$this->drupalGet('locale_test_plural_format_page');
$tests = _locale_test_plural_format_tests();
$result = array();
foreach ($tests as $test) {
$this->assertPluralFormat($test['count'], $test['language'], $test['expected-result']);
}
}
/**
* Helper assert to test locale_get_plural page.
*
* @param $count
* Number for testing.
* @param $lang
* Language for testing
* @param $expected_result
* Expected result.
* @param $message
*/
function assertPluralFormat($count, $lang, $expected_result) {
$message_param = array(
'@lang' => $lang,
'@count' => $count,
'@expected_result' => $expected_result,
);
$message = t("Computed plural index for '@lang' with count @count is @expected_result.", $message_param);
$message_param = array(
'@lang' => $lang,
'@expected_result' => $expected_result,
);
$this->assertText(format_string('Language: @lang, locale_get_plural: @expected_result.', $message_param, $message));
}
/**
* Imports a standalone .po file in a given language.
*
* @param $contents
* Contents of the .po file to import.
* @param $options
* Additional options to pass to the translation import form.
*/
function importPoFile($contents, array $options = array()) {
$name = drupal_tempnam('temporary://', "po_") . '.po';
file_put_contents($name, $contents);
$options['files[file]'] = $name;
$this->drupalPost('admin/config/regional/translate/import', $options, t('Import'));
drupal_unlink($name);
}
/**
* Returns a .po file with a simple plural formula.
*/
function getPoFileWithSimplePlural() {
return <<< EOF
msgid ""
msgstr ""
"Project-Id-Version: Drupal 7\\n"
"MIME-Version: 1.0\\n"
"Content-Type: text/plain; charset=UTF-8\\n"
"Content-Transfer-Encoding: 8bit\\n"
"Plural-Forms: nplurals=2; plural=(n!=1);\\n"
msgid "One sheep"
msgid_plural "@count sheep"
msgstr[0] "un mouton"
msgstr[1] "@count moutons"
msgid "Monday"
msgstr "lundi"
EOF;
}
/**
* Returns a .po file with a complex plural formula.
*/
function getPoFileWithComplexPlural() {
return <<< EOF
msgid ""
msgstr ""
"Project-Id-Version: Drupal 7\\n"
"MIME-Version: 1.0\\n"
"Content-Type: text/plain; charset=UTF-8\\n"
"Content-Transfer-Encoding: 8bit\\n"
"Plural-Forms: nplurals=3; plural=n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;\\n"
msgid "1 hour"
msgid_plural "@count hours"
msgstr[0] "@count sat"
msgstr[1] "@count sata"
msgstr[2] "@count sati"
msgid "Monday"
msgstr "Ponedjeljak"
EOF;
}
}
/**
* Functional tests for the import of translation files.
*/
class LocaleImportFunctionalTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Translation import',
'description' => 'Tests the import of locale files.',
'group' => 'Locale',
);
}
/**
* A user able to create languages and import translations.
*/
protected $admin_user = NULL;
function setUp() {
parent::setUp('locale', 'locale_test');
$this->admin_user = $this->drupalCreateUser(array('administer languages', 'translate interface', 'access administration pages'));
$this->drupalLogin($this->admin_user);
}
/**
* Test import of standalone .po files.
*/
function testStandalonePoFile() {
// Try importing a .po file.
$this->importPoFile($this->getPoFile(), array(
'langcode' => 'fr',
));
// The import should automatically create the corresponding language.
$this->assertRaw(t('The language %language has been created.', array('%language' => 'French')), 'The language has been automatically created.');
// The import should have created 7 strings.
$this->assertRaw(t('The translation was successfully imported. There are %number newly created translated strings, %update strings were updated and %delete strings were removed.', array('%number' => 9, '%update' => 0, '%delete' => 0)), 'The translation file was successfully imported.');
// This import should have saved plural forms to have 2 variants.
$this->assert(db_query("SELECT plurals FROM {languages} WHERE language = 'fr'")->fetchField() == 2, 'Plural number initialized.');
// Ensure we were redirected correctly.
$this->assertEqual($this->getUrl(), url('admin/config/regional/translate', array('absolute' => TRUE)), 'Correct page redirection.');
// Try importing a .po file with invalid tags in the default text group.
$this->importPoFile($this->getBadPoFile(), array(
'langcode' => 'fr',
));
// The import should have created 1 string and rejected 2.
$this->assertRaw(t('The translation was successfully imported. There are %number newly created translated strings, %update strings were updated and %delete strings were removed.', array('%number' => 1, '%update' => 0, '%delete' => 0)), 'The translation file was successfully imported.');
$skip_message = format_plural(2, 'One translation string was skipped because it contains disallowed HTML.', '@count translation strings were skipped because they contain disallowed HTML.');
$this->assertRaw($skip_message, 'Unsafe strings were skipped.');
// Try importing a .po file with invalid tags in a non default text group.
$this->importPoFile($this->getBadPoFile(), array(
'langcode' => 'fr',
'group' => 'custom',
));
// The import should have created 3 strings.
$this->assertRaw(t('The translation was successfully imported. There are %number newly created translated strings, %update strings were updated and %delete strings were removed.', array('%number' => 3, '%update' => 0, '%delete' => 0)), 'The translation file was successfully imported.');
// Try importing a .po file which doesn't exist.
$name = $this->randomName(16);
$this->drupalPost('admin/config/regional/translate/import', array(
'langcode' => 'fr',
'files[file]' => $name,
'group' => 'custom',
), t('Import'));
$this->assertEqual($this->getUrl(), url('admin/config/regional/translate/import', array('absolute' => TRUE)), 'Correct page redirection.');
$this->assertText(t('File to import not found.'), 'File to import not found message.');
// Try importing a .po file with overriding strings, and ensure existing
// strings are kept.
$this->importPoFile($this->getOverwritePoFile(), array(
'langcode' => 'fr',
'mode' => 1, // Existing strings are kept, only new strings are added.
));
// The import should have created 1 string.
$this->assertRaw(t('The translation was successfully imported. There are %number newly created translated strings, %update strings were updated and %delete strings were removed.', array('%number' => 1, '%update' => 0, '%delete' => 0)), 'The translation file was successfully imported.');
// Ensure string wasn't overwritten.
$search = array(
'string' => 'Montag',
'language' => 'fr',
'translation' => 'translated',
'group' => 'all',
);
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
$this->assertText(t('No strings available.'), 'String not overwritten by imported string.');
// This import should not have changed number of plural forms.
$this->assert(db_query("SELECT plurals FROM {languages} WHERE language = 'fr'")->fetchField() == 2, 'Plural numbers untouched.');
$this->importPoFile($this->getPoFileWithBrokenPlural(), array(
'langcode' => 'fr',
'mode' => 1, // Existing strings are kept, only new strings are added.
));
// Attempt to import broken .po file as well to prove that this
// will not overwrite the proper plural formula imported above.
$this->assert(db_query("SELECT plurals FROM {languages} WHERE language = 'fr'")->fetchField() == 2, 'Broken plurals: plural numbers untouched.');
$this->importPoFile($this->getPoFileWithMissingPlural(), array(
'langcode' => 'fr',
'mode' => 1, // Existing strings are kept, only new strings are added.
));
// Attempt to import .po file which has no plurals and prove that this
// will not overwrite the proper plural formula imported above.
$this->assert(db_query("SELECT plurals FROM {languages} WHERE language = 'fr'")->fetchField() == 2, 'No plurals: plural numbers untouched.');
// Try importing a .po file with overriding strings, and ensure existing
// strings are overwritten.
$this->importPoFile($this->getOverwritePoFile(), array(
'langcode' => 'fr',
'mode' => 0, // Strings in the uploaded file replace existing ones, new ones are added.
));
// The import should have updated 2 strings.
$this->assertRaw(t('The translation was successfully imported. There are %number newly created translated strings, %update strings were updated and %delete strings were removed.', array('%number' => 0, '%update' => 2, '%delete' => 0)), 'The translation file was successfully imported.');
// Ensure string was overwritten.
$search = array(
'string' => 'Montag',
'language' => 'fr',
'translation' => 'translated',
'group' => 'all',
);
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
$this->assertNoText(t('No strings available.'), 'String overwritten by imported string.');
// This import should have changed number of plural forms.
$this->assert(db_query("SELECT plurals FROM {languages} WHERE language = 'fr'")->fetchField() == 3, 'Plural numbers changed.');
}
/**
* Test automatic import of a module's translation files when a language is
* enabled.
*/
function testAutomaticModuleTranslationImportLanguageEnable() {
// Code for the language - manually set to match the test translation file.
$langcode = 'xx';
// The English name for the language.
$name = $this->randomName(16);
// The native name for the language.
$native = $this->randomName(16);
// The domain prefix.
$prefix = $langcode;
// Create a custom language.
$edit = array(
'langcode' => $langcode,
'name' => $name,
'native' => $native,
'prefix' => $prefix,
'direction' => '0',
);
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add custom language'));
// Ensure the translation file was automatically imported when language was
// added.
$this->assertText(t('One translation file imported for the enabled modules.'), 'Language file automatically imported.');
// Ensure strings were successfully imported.
$search = array(
'string' => 'lundi',
'language' => $langcode,
'translation' => 'translated',
'group' => 'all',
);
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
$this->assertNoText(t('No strings available.'), 'String successfully imported.');
}
/**
* Test msgctxt context support.
*/
function testLanguageContext() {
// Try importing a .po file.
$this->importPoFile($this->getPoFileWithContext(), array(
'langcode' => 'hr',
));
$this->assertIdentical(t('May', array(), array('langcode' => 'hr', 'context' => 'Long month name')), 'Svibanj', 'Long month name context is working.');
$this->assertIdentical(t('May', array(), array('langcode' => 'hr')), 'Svi.', 'Default context is working.');
}
/**
* Test empty msgstr at end of .po file see #611786.
*/
function testEmptyMsgstr() {
$langcode = 'hu';
// Try importing a .po file.
$this->importPoFile($this->getPoFileWithMsgstr(), array(
'langcode' => $langcode,
));
$this->assertRaw(t('The translation was successfully imported. There are %number newly created translated strings, %update strings were updated and %delete strings were removed.', array('%number' => 1, '%update' => 0, '%delete' => 0)), 'The translation file was successfully imported.');
$this->assertIdentical(t('Operations', array(), array('langcode' => $langcode)), 'Műveletek', 'String imported and translated.');
// Try importing a .po file.
$this->importPoFile($this->getPoFileWithEmptyMsgstr(), array(
'langcode' => $langcode,
'mode' => 0,
));
$this->assertRaw(t('The translation was successfully imported. There are %number newly created translated strings, %update strings were updated and %delete strings were removed.', array('%number' => 0, '%update' => 0, '%delete' => 1)), 'The translation file was successfully imported.');
// This is the language indicator on the translation search screen for
// untranslated strings. Copied straight from locale.inc.
$language_indicator = "$langcode ";
$str = "Operations";
$search = array(
'string' => $str,
'language' => 'all',
'translation' => 'all',
'group' => 'all',
);
$this->drupalPost('admin/config/regional/translate/translate', $search, t('Filter'));
// assertText() seems to remove the input field where $str always could be
// found, so this is not a false assert.
$this->assertText($str, 'Search found the string.');
$this->assertRaw($language_indicator, 'String is untranslated again.');
}
/**
* Helper function: import a standalone .po file in a given language.
*
* @param $contents
* Contents of the .po file to import.
* @param $options
* Additional options to pass to the translation import form.
*/
function importPoFile($contents, array $options = array()) {
$name = drupal_tempnam('temporary://', "po_") . '.po';
file_put_contents($name, $contents);
$options['files[file]'] = $name;
$this->drupalPost('admin/config/regional/translate/import', $options, t('Import'));
drupal_unlink($name);
}
/**
* Helper function that returns a proper .po file.
*/
function getPoFile() {
return <<< EOF
msgid ""
msgstr ""
"Project-Id-Version: Drupal 7\\n"
"MIME-Version: 1.0\\n"
"Content-Type: text/plain; charset=UTF-8\\n"
"Content-Transfer-Encoding: 8bit\\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\\n"
msgid "One sheep"
msgid_plural "@count sheep"
msgstr[0] "un mouton"
msgstr[1] "@count moutons"
msgid "Monday"
msgstr "lundi"
msgid "Tuesday"
msgstr "mardi"
msgid "Wednesday"
msgstr "mercredi"
msgid "Thursday"
msgstr "jeudi"
msgid "Friday"
msgstr "vendredi"
msgid "Saturday"
msgstr "samedi"
msgid "Sunday"
msgstr "dimanche"
EOF;
}
/**
* Helper function that returns a bad .po file.
*/
function getBadPoFile() {
return <<< EOF
msgid ""
msgstr ""
"Project-Id-Version: Drupal 7\\n"
"MIME-Version: 1.0\\n"
"Content-Type: text/plain; charset=UTF-8\\n"
"Content-Transfer-Encoding: 8bit\\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\\n"
msgid "Save configuration"
msgstr "Enregistrer la configuration"
msgid "edit"
msgstr "modifier');
$custom_path_url = base_path() . (variable_get('clean_url', 0) ? $custom_path : '?q=' . $custom_path);
$elements = $this->xpath('//a[@href=:href and .=:title]', array(':href' => $custom_path_url, ':title' => $first_node->title));
$this->assertTrue(!empty($elements), 'First node links to the path alias.');
$elements = $this->xpath('//a[@href=:href and .=:title]', array(':href' => $custom_path_url, ':title' => $second_node->title));
$this->assertTrue(!empty($elements), 'Second node links to the path alias.');
// Confirm that the custom path leads to the first node.
$this->drupalGet($custom_path);
$this->assertText($first_node->title, 'Custom alias returns first node.');
// Confirm that the custom path with prefix leads to the second node.
$this->drupalGet($prefix . '/' . $custom_path);
$this->assertText($second_node->title, 'Custom alias with prefix returns second node.');
}
}
/**
* Functional tests for multilingual support on nodes.
*/
class LocaleContentFunctionalTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Content language settings',
'description' => 'Checks you can enable multilingual support on content types and configure a language for a node.',
'group' => 'Locale',
);
}
function setUp() {
parent::setUp('locale');
}
/**
* Verifies that machine name fields are always LTR.
*/
function testMachineNameLTR() {
// User to add and remove language.
$admin_user = $this->drupalCreateUser(array('administer languages', 'administer content types', 'access administration pages'));
// Log in as admin.
$this->drupalLogin($admin_user);
// Verify that the machine name field is LTR for a new content type.
$this->drupalGet('admin/structure/types/add');
$this->assertFieldByXpath('//input[@name="type" and @dir="ltr"]', NULL, 'The machine name field is LTR when no additional language is configured.');
// Install the Arabic language (which is RTL) and configure as the default.
$edit = array();
$edit['langcode'] = 'ar';
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add language'));
$edit = array();
$edit['site_default'] = 'ar';
$this->drupalPost(NULL, $edit, t('Save configuration'));
// Verify that the machine name field is still LTR for a new content type.
$this->drupalGet('admin/structure/types/add');
$this->assertFieldByXpath('//input[@name="type" and @dir="ltr"]', NULL, 'The machine name field is LTR when the default language is RTL.');
}
/**
* Test if a content type can be set to multilingual and language setting is
* present on node add and edit forms.
*/
function testContentTypeLanguageConfiguration() {
global $base_url;
// User to add and remove language.
$admin_user = $this->drupalCreateUser(array('administer languages', 'administer content types', 'access administration pages'));
// User to create a node.
$web_user = $this->drupalCreateUser(array('create article content', 'create page content', 'edit any page content'));
// Add custom language.
$this->drupalLogin($admin_user);
// Code for the language.
$langcode = 'xx';
// The English name for the language.
$name = $this->randomName(16);
// The native name for the language.
$native = $this->randomName(16);
// The domain prefix.
$prefix = $langcode;
$edit = array(
'langcode' => $langcode,
'name' => $name,
'native' => $native,
'prefix' => $prefix,
'direction' => '0',
);
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add custom language'));
// Add disabled custom language.
// Code for the language.
$langcode_disabled = 'xx-yy';
// The English name for the language.
$name_disabled = $this->randomName(16);
// The native name for the language.
$native_disabled = $this->randomName(16);
// The domain prefix.
$prefix_disabled = $langcode_disabled;
$edit = array(
'langcode' => $langcode_disabled,
'name' => $name_disabled,
'native' => $native_disabled,
'prefix' => $prefix_disabled,
'direction' => '0',
);
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add custom language'));
// Disable second custom language.
$path = 'admin/config/regional/language';
$edit = array(
'enabled[' . $langcode_disabled . ']' => FALSE,
);
$this->drupalPost($path, $edit, t('Save configuration'));
// Set "Basic page" content type to use multilingual support.
$this->drupalGet('admin/structure/types/manage/page');
$this->assertText(t('Multilingual support'), 'Multilingual support fieldset present on content type configuration form.');
$edit = array(
'language_content_type' => 1,
);
$this->drupalPost('admin/structure/types/manage/page', $edit, t('Save content type'));
$this->assertRaw(t('The content type %type has been updated.', array('%type' => 'Basic page')), 'Basic page content type has been updated.');
$this->drupalLogout();
// Verify language selection is not present on add article form.
$this->drupalLogin($web_user);
$this->drupalGet('node/add/article');
// Verify language select list is not present.
$this->assertNoFieldByName('language', NULL, 'Language select not present on add article form.');
// Verify language selection appears on add "Basic page" form.
$this->drupalGet('node/add/page');
// Verify language select list is present.
$this->assertFieldByName('language', NULL, 'Language select present on add Basic page form.');
// Ensure enabled language appears.
$this->assertText($name, 'Enabled language present.');
// Ensure disabled language doesn't appear.
$this->assertNoText($name_disabled, 'Disabled language not present.');
// Create "Basic page" content.
$node_title = $this->randomName();
$node_body = $this->randomName();
$edit = array(
'type' => 'page',
'title' => $node_title,
'body' => array($langcode => array(array('value' => $node_body))),
'language' => $langcode,
);
$node = $this->drupalCreateNode($edit);
// Edit the content and ensure correct language is selected.
$path = 'node/' . $node->nid . '/edit';
$this->drupalGet($path);
$this->assertRaw('' . $name . ' ', 'Correct language selected.');
// Ensure we can change the node language.
$edit = array(
'language' => 'en',
);
$this->drupalPost($path, $edit, t('Save'));
$this->assertRaw(t('%title has been updated.', array('%title' => $node_title)), 'Basic page content updated.');
$this->drupalLogout();
}
/**
* Verifies that nodes may be created with different languages.
*/
function testNodeCreationWithLanguage() {
// Create an admin user and log them in.
$perms = array(
// Standard node permissions.
'create page content',
'administer content types',
'administer nodes',
'bypass node access',
// Locale.
'administer languages',
);
$web_user = $this->drupalCreateUser($perms);
$this->drupalLogin($web_user);
// Create some test nodes using different langcodes.
foreach (array(LANGUAGE_NONE, 'en', 'fr') as $langcode) {
$node_args = array(
'type' => 'page',
'promote' => 1,
'language' => $langcode,
);
$node = $this->drupalCreateNode($node_args);
$node_reloaded = node_load($node->nid, NULL, TRUE);
$this->assertEqual($node_reloaded->language, $langcode, format_string('The language code of the node was successfully set to @langcode.', array('@langcode' => $langcode)));
}
}
}
/**
* Test UI language negotiation
* 1. URL (PATH) > DEFAULT
* UI Language base on URL prefix, browser language preference has no
* influence:
* admin/config
* UI in site default language
* zh-hans/admin/config
* UI in Chinese
* blah-blah/admin/config
* 404
* 2. URL (PATH) > BROWSER > DEFAULT
* admin/config
* UI in user's browser language preference if the site has that
* language enabled, if not, the default language
* zh-hans/admin/config
* UI in Chinese
* blah-blah/admin/config
* 404
* 3. URL (DOMAIN) > DEFAULT
* http://example.com/admin/config
* UI language in site default
* http://example.cn/admin/config
* UI language in Chinese
*/
class LocaleUILanguageNegotiationTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'UI language negotiation',
'description' => 'Test UI language switching by URL path prefix and domain.',
'group' => 'Locale',
);
}
function setUp() {
parent::setUp('locale', 'locale_test');
require_once DRUPAL_ROOT . '/includes/language.inc';
drupal_load('module', 'locale');
$admin_user = $this->drupalCreateUser(array('administer languages', 'translate interface', 'access administration pages', 'administer blocks'));
$this->drupalLogin($admin_user);
}
/**
* Tests for language switching by URL path.
*/
function testUILanguageNegotiation() {
// A few languages to switch to.
// This one is unknown, should get the default lang version.
$language_unknown = 'blah-blah';
// For testing browser lang preference.
$language_browser_fallback = 'vi';
// For testing path prefix.
$language = 'zh-hans';
// For setting browser language preference to 'vi'.
$http_header_browser_fallback = array("Accept-Language: $language_browser_fallback;q=1");
// For setting browser language preference to some unknown.
$http_header_blah = array("Accept-Language: blah;q=1");
// This domain should switch the UI to Chinese.
$language_domain = 'example.cn';
// Setup the site languages by installing two languages.
require_once DRUPAL_ROOT . '/includes/locale.inc';
locale_add_language($language_browser_fallback);
locale_add_language($language);
// We will look for this string in the admin/config screen to see if the
// corresponding translated string is shown.
$default_string = 'Configure languages for content and the user interface';
// Set the default language in order for the translated string to be registered
// into database when seen by t(). Without doing this, our target string
// is for some reason not found when doing translate search. This might
// be some bug.
drupal_static_reset('language_list');
$languages = language_list('enabled');
variable_set('language_default', $languages[1]['vi']);
// First visit this page to make sure our target string is searchable.
$this->drupalGet('admin/config');
// Now the t()'ed string is in db so switch the language back to default.
variable_del('language_default');
// Translate the string.
$language_browser_fallback_string = "In $language_browser_fallback In $language_browser_fallback In $language_browser_fallback";
$language_string = "In $language In $language In $language";
// Do a translate search of our target string.
$edit = array( 'string' => $default_string);
$this->drupalPost('admin/config/regional/translate/translate', $edit, t('Filter'));
// Should find the string and now click edit to post translated string.
$this->clickLink('edit');
$edit = array(
"translations[$language_browser_fallback]" => $language_browser_fallback_string,
"translations[$language]" => $language_string,
);
$this->drupalPost(NULL, $edit, t('Save translations'));
// Configure URL language rewrite.
variable_set('locale_language_negotiation_url_type', LANGUAGE_TYPE_INTERFACE);
$tests = array(
// Default, browser preference should have no influence.
array(
'language_negotiation' => array(LOCALE_LANGUAGE_NEGOTIATION_URL, LANGUAGE_NEGOTIATION_DEFAULT),
'path' => 'admin/config',
'expect' => $default_string,
'expected_provider' => LANGUAGE_NEGOTIATION_DEFAULT,
'http_header' => $http_header_browser_fallback,
'message' => 'URL (PATH) > DEFAULT: no language prefix, UI language is default and the browser language preference setting is not used.',
),
// Language prefix.
array(
'language_negotiation' => array(LOCALE_LANGUAGE_NEGOTIATION_URL, LANGUAGE_NEGOTIATION_DEFAULT),
'path' => "$language/admin/config",
'expect' => $language_string,
'expected_provider' => LOCALE_LANGUAGE_NEGOTIATION_URL,
'http_header' => $http_header_browser_fallback,
'message' => 'URL (PATH) > DEFAULT: with language prefix, UI language is switched based on path prefix',
),
// Default, go by browser preference.
array(
'language_negotiation' => array(LOCALE_LANGUAGE_NEGOTIATION_URL, LOCALE_LANGUAGE_NEGOTIATION_BROWSER),
'path' => 'admin/config',
'expect' => $language_browser_fallback_string,
'expected_provider' => LOCALE_LANGUAGE_NEGOTIATION_BROWSER,
'http_header' => $http_header_browser_fallback,
'message' => 'URL (PATH) > BROWSER: no language prefix, UI language is determined by browser language preference',
),
// Prefix, switch to the language.
array(
'language_negotiation' => array(LOCALE_LANGUAGE_NEGOTIATION_URL, LOCALE_LANGUAGE_NEGOTIATION_BROWSER),
'path' => "$language/admin/config",
'expect' => $language_string,
'expected_provider' => LOCALE_LANGUAGE_NEGOTIATION_URL,
'http_header' => $http_header_browser_fallback,
'message' => 'URL (PATH) > BROWSER: with langage prefix, UI language is based on path prefix',
),
// Default, browser language preference is not one of site's lang.
array(
'language_negotiation' => array(LOCALE_LANGUAGE_NEGOTIATION_URL, LOCALE_LANGUAGE_NEGOTIATION_BROWSER, LANGUAGE_NEGOTIATION_DEFAULT),
'path' => 'admin/config',
'expect' => $default_string,
'expected_provider' => LANGUAGE_NEGOTIATION_DEFAULT,
'http_header' => $http_header_blah,
'message' => 'URL (PATH) > BROWSER > DEFAULT: no language prefix and browser language preference set to unknown language should use default language',
),
);
foreach ($tests as $test) {
$this->runTest($test);
}
// Unknown language prefix should return 404.
variable_set('language_negotiation_' . LANGUAGE_TYPE_INTERFACE, locale_language_negotiation_info());
$this->drupalGet("$language_unknown/admin/config", array(), $http_header_browser_fallback);
$this->assertResponse(404, "Unknown language path prefix should return 404");
// Setup for domain negotiation, first configure the language to have domain
// URL. We use HTTPS and a port to make sure that only the domain name is used.
$edit = array('prefix' => '', 'domain' => "https://$language_domain:99");
$this->drupalPost("admin/config/regional/language/edit/$language", $edit, t('Save language'));
// Set the site to use domain language negotiation.
$tests = array(
// Default domain, browser preference should have no influence.
array(
'language_negotiation' => array(LOCALE_LANGUAGE_NEGOTIATION_URL, LANGUAGE_NEGOTIATION_DEFAULT),
'locale_language_negotiation_url_part' => LOCALE_LANGUAGE_NEGOTIATION_URL_DOMAIN,
'path' => 'admin/config',
'expect' => $default_string,
'expected_provider' => LANGUAGE_NEGOTIATION_DEFAULT,
'http_header' => $http_header_browser_fallback,
'message' => 'URL (DOMAIN) > DEFAULT: default domain should get default language',
),
// Language domain specific URL, we set the $_SERVER['HTTP_HOST'] in
// locale_test.module hook_boot() to simulate this.
array(
'language_negotiation' => array(LOCALE_LANGUAGE_NEGOTIATION_URL, LANGUAGE_NEGOTIATION_DEFAULT),
'locale_language_negotiation_url_part' => LOCALE_LANGUAGE_NEGOTIATION_URL_DOMAIN,
'locale_test_domain' => $language_domain . ':88',
'path' => 'admin/config',
'expect' => $language_string,
'expected_provider' => LOCALE_LANGUAGE_NEGOTIATION_URL,
'http_header' => $http_header_browser_fallback,
'message' => 'URL (DOMAIN) > DEFAULT: domain example.cn should switch to Chinese',
),
);
foreach ($tests as $test) {
$this->runTest($test);
}
}
private function runTest($test) {
if (!empty($test['language_negotiation'])) {
$negotiation = array_flip($test['language_negotiation']);
language_negotiation_set(LANGUAGE_TYPE_INTERFACE, $negotiation);
}
if (!empty($test['locale_language_negotiation_url_part'])) {
variable_set('locale_language_negotiation_url_part', $test['locale_language_negotiation_url_part']);
}
if (!empty($test['locale_test_domain'])) {
variable_set('locale_test_domain', $test['locale_test_domain']);
}
$this->drupalGet($test['path'], array(), $test['http_header']);
$this->assertText($test['expect'], $test['message']);
$this->assertText(t('Language negotiation provider: @name', array('@name' => $test['expected_provider'])));
}
/**
* Test URL language detection when the requested URL has no language.
*/
function testUrlLanguageFallback() {
// Add the Italian language.
$language_browser_fallback = 'it';
locale_add_language($language_browser_fallback);
$languages = language_list();
// Enable the path prefix for the default language: this way any unprefixed
// URL must have a valid fallback value.
$edit = array('prefix' => 'en');
$this->drupalPost('admin/config/regional/language/edit/en', $edit, t('Save language'));
// Enable browser and URL language detection.
$edit = array(
'language[enabled][locale-browser]' => TRUE,
'language[enabled][locale-url]' => TRUE,
'language[weight][locale-browser]' => -8,
'language[weight][locale-url]' => -10,
);
$this->drupalPost('admin/config/regional/language/configure', $edit, t('Save settings'));
$this->drupalGet('admin/config/regional/language/configure');
// Enable the language switcher block.
$edit = array('blocks[locale_language][region]' => 'sidebar_first');
$this->drupalPost('admin/structure/block', $edit, t('Save blocks'));
// Access the front page without specifying any valid URL language prefix
// and having as browser language preference a non-default language.
$http_header = array("Accept-Language: $language_browser_fallback;q=1");
$this->drupalGet('', array(), $http_header);
// Check that the language switcher active link matches the given browser
// language.
$args = array(':url' => base_path() . (!empty($GLOBALS['conf']['clean_url']) ? $language_browser_fallback : "?q=$language_browser_fallback"));
$fields = $this->xpath('//div[@id="block-locale-language"]//a[@class="language-link active" and @href=:url]', $args);
$this->assertTrue($fields[0] == $languages[$language_browser_fallback]->native, 'The browser language is the URL active language');
// Check that URLs are rewritten using the given browser language.
$fields = $this->xpath('//div[@id="site-name"]//a[@rel="home" and @href=:url]//span', $args);
$this->assertTrue($fields[0] == 'Drupal', 'URLs are rewritten using the browser language.');
}
/**
* Tests url() when separate domains are used for multiple languages.
*/
function testLanguageDomain() {
// Add the Italian language, without protocol.
$langcode = 'it';
locale_add_language($langcode, 'Italian', 'Italian', LANGUAGE_LTR, 'it.example.com', '', TRUE, FALSE);
// Add the French language, with protocol.
$langcode = 'fr';
locale_add_language($langcode, 'French', 'French', LANGUAGE_LTR, 'http://fr.example.com', '', TRUE, FALSE);
// Enable language URL detection.
$negotiation = array_flip(array(LOCALE_LANGUAGE_NEGOTIATION_URL, LANGUAGE_NEGOTIATION_DEFAULT));
language_negotiation_set(LANGUAGE_TYPE_INTERFACE, $negotiation);
variable_set('locale_language_negotiation_url_part', 1);
global $is_https;
$languages = language_list();
foreach (array('it', 'fr') as $langcode) {
// Build the link we're going to test based on the clean URL setting.
$link = (!empty($GLOBALS['conf']['clean_url'])) ? $langcode . '.example.com/admin' : $langcode . '.example.com/?q=admin';
// Test URL in another language.
// Base path gives problems on the testbot, so $correct_link is hard-coded.
// @see UrlAlterFunctionalTest::assertUrlOutboundAlter (path.test).
$url = url('admin', array('language' => $languages[$langcode]));
$url_scheme = ($is_https) ? 'https://' : 'http://';
$correct_link = $url_scheme . $link;
$this->assertTrue($url == $correct_link, format_string('The url() function returns the right url (@url) in accordance with the chosen language', array('@url' => $url . " == " . $correct_link)));
// Test HTTPS via options.
variable_set('https', TRUE);
$url = url('admin', array('https' => TRUE, 'language' => $languages[$langcode]));
$correct_link = 'https://' . $link;
$this->assertTrue($url == $correct_link, format_string('The url() function returns the right https url (via options) (@url) in accordance with the chosen language', array('@url' => $url . " == " . $correct_link)));
variable_set('https', FALSE);
// Test HTTPS via current URL scheme.
$temp_https = $is_https;
$is_https = TRUE;
$url = url('admin', array('language' => $languages[$langcode]));
$correct_link = 'https://' . $link;
$this->assertTrue($url == $correct_link, format_string('The url() function returns the right url (via current url scheme) (@url) in accordance with the chosen language', array('@url' => $url . " == " . $correct_link)));
$is_https = $temp_https;
}
}
}
/**
* Test that URL rewriting works as expected.
*/
class LocaleUrlRewritingTest extends DrupalWebTestCase {
protected $web_user;
public static function getInfo() {
return array(
'name' => 'URL rewriting',
'description' => 'Test that URL rewriting works as expected.',
'group' => 'Locale',
);
}
function setUp() {
parent::setUp('locale');
// Create and login user.
$this->web_user = $this->drupalCreateUser(array('administer languages', 'access administration pages'));
$this->drupalLogin($this->web_user);
// Install French language.
$edit = array();
$edit['langcode'] = 'fr';
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add language'));
// Install Italian language.
$edit = array();
$edit['langcode'] = 'it';
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add language'));
// Disable Italian language.
$edit = array('enabled[it]' => FALSE);
$this->drupalPost('admin/config/regional/language', $edit, t('Save configuration'));
// Enable URL language detection and selection.
$edit = array('language[enabled][locale-url]' => 1);
$this->drupalPost('admin/config/regional/language/configure', $edit, t('Save settings'));
// Reset static caching.
drupal_static_reset('language_list');
drupal_static_reset('locale_url_outbound_alter');
drupal_static_reset('locale_language_url_rewrite_url');
}
/**
* Check that disabled or non-installed languages are not considered.
*/
function testUrlRewritingEdgeCases() {
// Check URL rewriting with a disabled language.
$languages = language_list();
$this->checkUrl($languages['it'], 'Path language is ignored if language is disabled.', 'URL language negotiation does not work with disabled languages');
// Check URL rewriting with a non-installed language.
$non_existing = language_default();
$non_existing->language = $this->randomName();
$non_existing->prefix = $this->randomName();
$this->checkUrl($non_existing, 'Path language is ignored if language is not installed.', 'URL language negotiation does not work with non-installed languages');
}
/**
* Check URL rewriting for the given language.
*
* The test is performed with a fixed URL (the default front page) to simply
* check that language prefixes are not added to it and that the prefixed URL
* is actually not working.
*
* @param string $language
* The language prefix, e.g. 'es'.
* @param string $message1
* Message to display in assertion that language prefixes are not added.
* @param string $message2
* The message to display confirming prefixed URL is not working.
*/
private function checkUrl($language, $message1, $message2) {
$options = array('language' => $language);
$base_path = trim(base_path(), '/');
$rewritten_path = trim(str_replace(array('?q=', $base_path), '', url('node', $options)), '/');
$segments = explode('/', $rewritten_path, 2);
$prefix = $segments[0];
$path = isset($segments[1]) ? $segments[1] : $prefix;
// If the rewritten URL has not a language prefix we pick the right one from
// the language object so we can always check the prefixed URL.
if ($this->assertNotEqual($language->prefix, $prefix, $message1)) {
$prefix = $language->prefix;
}
$this->drupalGet("$prefix/$path");
$this->assertResponse(404, $message2);
}
/**
* Check URL rewriting when using a domain name and a non-standard port.
*/
function testDomainNameNegotiationPort() {
$language_domain = 'example.fr';
$edit = array(
'locale_language_negotiation_url_part' => 1,
);
$this->drupalPost('admin/config/regional/language/configure/url', $edit, t('Save configuration'));
$edit = array(
'prefix' => '',
'domain' => $language_domain
);
$this->drupalPost('admin/config/regional/language/edit/fr', $edit, t('Save language'));
// Enable domain configuration.
variable_set('locale_language_negotiation_url_part', LOCALE_LANGUAGE_NEGOTIATION_URL_DOMAIN);
// Reset static caching.
drupal_static_reset('language_list');
drupal_static_reset('language_url_outbound_alter');
drupal_static_reset('language_url_rewrite_url');
// In case index.php is part of the URLs, we need to adapt the asserted
// URLs as well.
$index_php = strpos(url('', array('absolute' => TRUE)), 'index.php') !== FALSE;
// Remember current HTTP_HOST.
$http_host = $_SERVER['HTTP_HOST'];
// Fake a different port.
$_SERVER['HTTP_HOST'] .= ':88';
// Create an absolute French link.
$languages = language_list();
$language = $languages['fr'];
$url = url('', array(
'absolute' => TRUE,
'language' => $language
));
$expected = 'http://example.fr:88/';
$expected .= $index_php ? 'index.php/' : '';
$this->assertEqual($url, $expected, 'The right port is used.');
// If we set the port explicitly in url(), it should not be overriden.
$url = url('', array(
'absolute' => TRUE,
'language' => $language,
'base_url' => $GLOBALS['base_url'] . ':90',
));
$expected = 'http://example.fr:90/';
$expected .= $index_php ? 'index.php/' : '';
$this->assertEqual($url, $expected, 'A given port is not overriden.');
// Restore HTTP_HOST.
$_SERVER['HTTP_HOST'] = $http_host;
}
}
/**
* Functional test for multilingual fields.
*/
class LocaleMultilingualFieldsFunctionalTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Multilingual fields',
'description' => 'Test multilingual support for fields.',
'group' => 'Locale',
);
}
function setUp() {
parent::setUp('locale');
// Setup users.
$admin_user = $this->drupalCreateUser(array('administer languages', 'administer content types', 'access administration pages', 'create page content', 'edit own page content'));
$this->drupalLogin($admin_user);
// Add a new language.
require_once DRUPAL_ROOT . '/includes/locale.inc';
locale_add_language('it', 'Italian', 'Italiano', LANGUAGE_LTR, '', '', TRUE, FALSE);
// Enable URL language detection and selection.
$edit = array('language[enabled][locale-url]' => '1');
$this->drupalPost('admin/config/regional/language/configure', $edit, t('Save settings'));
// Set "Basic page" content type to use multilingual support.
$edit = array(
'language_content_type' => 1,
);
$this->drupalPost('admin/structure/types/manage/page', $edit, t('Save content type'));
$this->assertRaw(t('The content type %type has been updated.', array('%type' => 'Basic page')), 'Basic page content type has been updated.');
// Make node body translatable.
$field = field_info_field('body');
$field['translatable'] = TRUE;
field_update_field($field);
}
/**
* Test if field languages are correctly set through the node form.
*/
function testMultilingualNodeForm() {
// Create "Basic page" content.
$langcode = LANGUAGE_NONE;
$title_key = "title";
$title_value = $this->randomName(8);
$body_key = "body[$langcode][0][value]";
$body_value = $this->randomName(16);
// Create node to edit.
$edit = array();
$edit[$title_key] = $title_value;
$edit[$body_key] = $body_value;
$edit['language'] = 'en';
$this->drupalPost('node/add/page', $edit, t('Save'));
// Check that the node exists in the database.
$node = $this->drupalGetNodeByTitle($edit[$title_key]);
$this->assertTrue($node, 'Node found in database.');
$assert = isset($node->body['en']) && !isset($node->body[LANGUAGE_NONE]) && $node->body['en'][0]['value'] == $body_value;
$this->assertTrue($assert, 'Field language correctly set.');
// Change node language.
$this->drupalGet("node/$node->nid/edit");
$edit = array(
$title_key => $this->randomName(8),
'language' => 'it'
);
$this->drupalPost(NULL, $edit, t('Save'));
$node = $this->drupalGetNodeByTitle($edit[$title_key]);
$this->assertTrue($node, 'Node found in database.');
$assert = isset($node->body['it']) && !isset($node->body['en']) && $node->body['it'][0]['value'] == $body_value;
$this->assertTrue($assert, 'Field language correctly changed.');
// Enable content language URL detection.
language_negotiation_set(LANGUAGE_TYPE_CONTENT, array(LOCALE_LANGUAGE_NEGOTIATION_URL => 0));
// Test multilingual field language fallback logic.
$this->drupalGet("it/node/$node->nid");
$this->assertRaw($body_value, 'Body correctly displayed using Italian as requested language');
$this->drupalGet("node/$node->nid");
$this->assertRaw($body_value, 'Body correctly displayed using English as requested language');
}
/*
* Test multilingual field display settings.
*/
function testMultilingualDisplaySettings() {
// Create "Basic page" content.
$langcode = LANGUAGE_NONE;
$title_key = "title";
$title_value = $this->randomName(8);
$body_key = "body[$langcode][0][value]";
$body_value = $this->randomName(16);
// Create node to edit.
$edit = array();
$edit[$title_key] = $title_value;
$edit[$body_key] = $body_value;
$edit['language'] = 'en';
$this->drupalPost('node/add/page', $edit, t('Save'));
// Check that the node exists in the database.
$node = $this->drupalGetNodeByTitle($edit[$title_key]);
$this->assertTrue($node, 'Node found in database.');
// Check if node body is showed.
$this->drupalGet("node/$node->nid");
$body = $this->xpath('//div[@id=:id]//div[@property="content:encoded"]/p', array(':id' => 'node-' . $node->nid));
$this->assertEqual(current($body), $node->body['en'][0]['value'], 'Node body is correctly showed.');
}
}
/**
* Functional tests for comment language.
*/
class LocaleCommentLanguageFunctionalTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Comment language',
'description' => 'Tests for comment language.',
'group' => 'Locale',
);
}
function setUp() {
parent::setUp('locale', 'locale_test');
// Create and login user.
$admin_user = $this->drupalCreateUser(array('administer site configuration', 'administer languages', 'access administration pages', 'administer content types', 'administer comments', 'create article content'));
$this->drupalLogin($admin_user);
// Add language.
$edit = array('langcode' => 'fr');
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add language'));
// Set "Article" content type to use multilingual support.
$edit = array('language_content_type' => 1);
$this->drupalPost('admin/structure/types/manage/article', $edit, t('Save content type'));
// Enable content language negotiation UI.
variable_set('locale_test_content_language_type', TRUE);
// Set interface language detection to user and content language detection
// to URL. Disable inheritance from interface language to ensure content
// language will fall back to the default language if no URL language can be
// detected.
$edit = array(
'language[enabled][locale-user]' => TRUE,
'language_content[enabled][locale-url]' => TRUE,
'language_content[enabled][locale-interface]' => FALSE,
);
$this->drupalPost('admin/config/regional/language/configure', $edit, t('Save settings'));
// Change user language preference, this way interface language is always
// French no matter what path prefix the URLs have.
$edit = array('language' => 'fr');
$this->drupalPost("user/{$admin_user->uid}/edit", $edit, t('Save'));
// Make comment body translatable.
$field = field_info_field('comment_body');
$field['translatable'] = TRUE;
field_update_field($field);
$this->assertTrue(field_is_translatable('comment', $field), 'Comment body is translatable.');
}
/**
* Test that comment language is properly set.
*/
function testCommentLanguage() {
drupal_static_reset('language_list');
// Create two nodes, one for english and one for french, and comment each
// node using both english and french as content language by changing URL
// language prefixes. Meanwhile interface language is always French, which
// is the user language preference. This way we can ensure that node
// language and interface language do not influence comment language, as
// only content language has to.
foreach (language_list() as $node_langcode => $node_language) {
$language_none = LANGUAGE_NONE;
// Create "Article" content.
$title = $this->randomName();
$edit = array(
"title" => $title,
"body[$language_none][0][value]" => $this->randomName(),
"language" => $node_langcode,
);
$this->drupalPost("node/add/article", $edit, t('Save'));
$node = $this->drupalGetNodeByTitle($title);
foreach (language_list() as $langcode => $language) {
// Post a comment with content language $langcode.
$prefix = empty($language->prefix) ? '' : $language->prefix . '/';
$comment_values[$node_langcode][$langcode] = $this->randomName();
// Initially field form widgets have no language.
$edit = array(
'subject' => $this->randomName(),
"comment_body[$language_none][0][value]" => $comment_values[$node_langcode][$langcode],
);
$this->drupalPost("{$prefix}node/{$node->nid}", $edit, t('Preview'));
// After the first submit the submitted entity language is taken into
// account.
$edit = array(
'subject' => $edit['subject'],
"comment_body[$langcode][0][value]" => $comment_values[$node_langcode][$langcode],
);
$this->drupalPost(NULL, $edit, t('Save'));
// Check that comment language matches the current content language.
$cid = db_select('comment', 'c')
->fields('c', array('cid'))
->condition('nid', $node->nid)
->orderBy('cid', 'DESC')
->range(0, 1)
->execute()
->fetchField();
$comment = comment_load($cid);
$comment_langcode = entity_language('comment', $comment);
$args = array('%node_language' => $node_langcode, '%comment_language' => $comment_langcode, '%langcode' => $langcode);
$this->assertEqual($comment_langcode, $langcode, format_string('The comment posted with content language %langcode and belonging to the node with language %node_language has language %comment_language', $args));
$this->assertEqual($comment->comment_body[$langcode][0]['value'], $comment_values[$node_langcode][$langcode], 'Comment body correctly stored.');
}
}
// Check that comment bodies appear in the administration UI.
$this->drupalGet('admin/content/comment');
foreach ($comment_values as $node_values) {
foreach ($node_values as $value) {
$this->assertRaw($value);
}
}
}
}
/**
* Functional tests for localizing date formats.
*/
class LocaleDateFormatsFunctionalTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Localize date formats',
'description' => 'Tests for the localization of date formats.',
'group' => 'Locale',
);
}
function setUp() {
parent::setUp('locale');
// Create and login user.
$admin_user = $this->drupalCreateUser(array('administer site configuration', 'administer languages', 'access administration pages', 'create article content'));
$this->drupalLogin($admin_user);
}
/**
* Functional tests for localizing date formats.
*/
function testLocalizeDateFormats() {
// Add language.
$edit = array(
'langcode' => 'fr',
);
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add language'));
// Set language negotiation.
$language_type = LANGUAGE_TYPE_INTERFACE;
$edit = array(
"{$language_type}[enabled][locale-url]" => TRUE,
);
$this->drupalPost('admin/config/regional/language/configure', $edit, t('Save settings'));
// Configure date formats.
$this->drupalGet('admin/config/regional/date-time/locale');
$this->assertText('Français', 'Configured languages appear.');
$edit = array(
'date_format_long' => 'd.m.Y - H:i',
'date_format_medium' => 'd.m.Y - H:i',
'date_format_short' => 'd.m.Y - H:i',
);
$this->drupalPost('admin/config/regional/date-time/locale/fr/edit', $edit, t('Save configuration'));
$this->assertText(t('Configuration saved.'), 'French date formats updated.');
$edit = array(
'date_format_long' => 'j M Y - g:ia',
'date_format_medium' => 'j M Y - g:ia',
'date_format_short' => 'j M Y - g:ia',
);
$this->drupalPost('admin/config/regional/date-time/locale/en/edit', $edit, t('Save configuration'));
$this->assertText(t('Configuration saved.'), 'English date formats updated.');
// Create node content.
$node = $this->drupalCreateNode(array('type' => 'article'));
// Configure format for the node posted date changes with the language.
$this->drupalGet('node/' . $node->nid);
$english_date = format_date($node->created, 'custom', 'j M Y');
$this->assertText($english_date, 'English date format appears');
$this->drupalGet('fr/node/' . $node->nid);
$french_date = format_date($node->created, 'custom', 'd.m.Y');
$this->assertText($french_date, 'French date format appears');
}
}
/**
* Functional test for language types/negotiation info.
*/
class LocaleLanguageNegotiationInfoFunctionalTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Language negotiation info',
'description' => 'Tests alterations to language types/negotiation info.',
'group' => 'Locale',
);
}
function setUp() {
parent::setUp('locale');
require_once DRUPAL_ROOT .'/includes/language.inc';
$admin_user = $this->drupalCreateUser(array('administer languages', 'access administration pages', 'view the administration theme'));
$this->drupalLogin($admin_user);
$this->drupalPost('admin/config/regional/language/add', array('langcode' => 'it'), t('Add language'));
}
/**
* Tests alterations to language types/negotiation info.
*/
function testInfoAlterations() {
// Enable language type/negotiation info alterations.
variable_set('locale_test_language_types', TRUE);
variable_set('locale_test_language_negotiation_info', TRUE);
$this->languageNegotiationUpdate();
// Check that fixed language types are properly configured without the need
// of saving the language negotiation settings.
$this->checkFixedLanguageTypes();
// Make the content language type configurable by updating the language
// negotiation settings with the proper flag enabled.
variable_set('locale_test_content_language_type', TRUE);
$this->languageNegotiationUpdate();
$type = LANGUAGE_TYPE_CONTENT;
$language_types = variable_get('language_types', drupal_language_types());
$this->assertTrue($language_types[$type], 'Content language type is configurable.');
// Enable some core and custom language providers. The test language type is
// supposed to be configurable.
$test_type = 'test_language_type';
$provider = LOCALE_LANGUAGE_NEGOTIATION_INTERFACE;
$test_provider = 'test_language_provider';
$form_field = $type . '[enabled]['. $provider .']';
$edit = array(
$form_field => TRUE,
$type . '[enabled][' . $test_provider . ']' => TRUE,
$test_type . '[enabled][' . $test_provider . ']' => TRUE,
);
$this->drupalPost('admin/config/regional/language/configure', $edit, t('Save settings'));
// Remove the interface language provider by updating the language
// negotiation settings with the proper flag enabled.
variable_set('locale_test_language_negotiation_info_alter', TRUE);
$this->languageNegotiationUpdate();
$negotiation = variable_get("language_negotiation_$type", array());
$this->assertFalse(isset($negotiation[$provider]), 'Interface language provider removed from the stored settings.');
$this->assertNoFieldByXPath("//input[@name=\"$form_field\"]", NULL, 'Interface language provider unavailable.');
// Check that type-specific language providers can be assigned only to the
// corresponding language types.
foreach (language_types_configurable() as $type) {
$form_field = $type . '[enabled][test_language_provider_ts]';
if ($type == $test_type) {
$this->assertFieldByXPath("//input[@name=\"$form_field\"]", NULL, format_string('Type-specific test language provider available for %type.', array('%type' => $type)));
}
else {
$this->assertNoFieldByXPath("//input[@name=\"$form_field\"]", NULL, format_string('Type-specific test language provider unavailable for %type.', array('%type' => $type)));
}
}
// Check language negotiation results.
$this->drupalGet('');
$last = variable_get('locale_test_language_negotiation_last', array());
foreach (language_types() as $type) {
$langcode = $last[$type];
$value = $type == LANGUAGE_TYPE_CONTENT || strpos($type, 'test') !== FALSE ? 'it' : 'en';
$this->assertEqual($langcode, $value, format_string('The negotiated language for %type is %language', array('%type' => $type, '%language' => $langcode)));
}
// Disable locale_test and check that everything is set back to the original
// status.
$this->languageNegotiationUpdate('disable');
// Check that only the core language types are available.
foreach (language_types() as $type) {
$this->assertTrue(strpos($type, 'test') === FALSE, format_string('The %type language is still available', array('%type' => $type)));
}
// Check that fixed language types are properly configured, even those
// previously set to configurable.
$this->checkFixedLanguageTypes();
// Check that unavailable language providers are not present in the
// negotiation settings.
$negotiation = variable_get("language_negotiation_$type", array());
$this->assertFalse(isset($negotiation[$test_provider]), 'The disabled test language provider is not part of the content language negotiation settings.');
// Check that configuration page presents the correct options and settings.
$this->assertNoRaw(t('Test language detection'), 'No test language type configuration available.');
$this->assertNoRaw(t('This is a test language provider'), 'No test language provider available.');
}
/**
* Update language types/negotiation information.
*
* Manually invoke locale_modules_enabled()/locale_modules_disabled() since
* they would not be invoked after enabling/disabling locale_test the first
* time.
*/
private function languageNegotiationUpdate($op = 'enable') {
static $last_op = NULL;
$modules = array('locale_test');
// Enable/disable locale_test only if we did not already before.
if ($last_op != $op) {
$function = "module_{$op}";
$function($modules);
// Reset hook implementation cache.
module_implements(NULL, FALSE, TRUE);
}
drupal_static_reset('language_types_info');
drupal_static_reset('language_negotiation_info');
$function = "locale_modules_{$op}d";
if (function_exists($function)) {
$function($modules);
}
$this->drupalGet('admin/config/regional/language/configure');
}
/**
* Check that language negotiation for fixed types matches the stored one.
*/
private function checkFixedLanguageTypes() {
drupal_static_reset('language_types_info');
foreach (language_types_info() as $type => $info) {
if (isset($info['fixed'])) {
$negotiation = variable_get("language_negotiation_$type", array());
$equal = array_keys($negotiation) === array_values($info['fixed']);
$this->assertTrue($equal, format_string('language negotiation for %type is properly set up', array('%type' => $type)));
}
}
}
}
/**
* Functional tests for CSS alter functions.
*/
class LocaleCSSAlterTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'CSS altering',
'description' => 'Test CSS alter functions.',
'group' => 'Locale',
);
}
function setUp() {
parent::setUp('locale');
}
/**
* Verifies that -rtl.css file is added directly after LTR .css file.
*/
function testCSSFilesOrderInRTLMode() {
global $base_url;
// User to add and remove language.
$admin_user = $this->drupalCreateUser(array('administer languages', 'administer content types', 'access administration pages'));
// Log in as admin.
$this->drupalLogin($admin_user);
// Install the Arabic language (which is RTL) and configure as the default.
$edit = array();
$edit['langcode'] = 'ar';
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add language'));
$edit = array();
$edit['site_default'] = 'ar';
$this->drupalPost(NULL, $edit, t('Save configuration'));
// Verify that the -rtl.css file is added directly after LTR file.
$this->drupalGet('');
$query_string = '?' . variable_get('css_js_query_string', '0');
$this->assertRaw('@import url("' . $base_url . '/modules/system/system.base.css' . $query_string . '");' . "\n" . '@import url("' . $base_url . '/modules/system/system.base-rtl.css' . $query_string . '");' . "\n", 'CSS: system.base-rtl.css is added directly after system.base.css.');
$this->assertRaw('@import url("' . $base_url . '/modules/system/system.menus.css' . $query_string . '");' . "\n" . '@import url("' . $base_url . '/modules/system/system.menus-rtl.css' . $query_string . '");' . "\n", 'CSS: system.menus-rtl.css is added directly after system.menus.css.');
$this->assertRaw('@import url("' . $base_url . '/modules/system/system.messages.css' . $query_string . '");' . "\n" . '@import url("' . $base_url . '/modules/system/system.messages-rtl.css' . $query_string . '");' . "\n", 'CSS: system.messages-rtl.css is added directly after system.messages.css.');
}
}
/**
* Tests locale translation safe string handling.
*/
class LocaleStringIsSafeTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Test if a string is safe',
'description' => 'Tests locale translation safe string handling.',
'group' => 'Locale',
);
}
function setUp() {
parent::setUp('locale');
}
/**
* Tests for locale_string_is_safe().
*/
public function testLocaleStringIsSafe() {
// Check a translatable string without HTML.
$string = 'Hello world!';
$result = locale_string_is_safe($string);
$this->assertTrue($result);
// Check a translatable string which includes trustable HTML.
$string = 'Hello world !';
$result = locale_string_is_safe($string);
$this->assertTrue($result);
// Check an untranslatable string which includes untrustable HTML (according
// to the locale_string_is_safe() function definition).
$string = 'Hello user ';
$result = locale_string_is_safe($string);
$this->assertTrue($result);
}
}
name = "Locale Test"
description = "Support module for the locale layer tests."
core = 7.x
package = Testing
version = VERSION
hidden = TRUE
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
Drupal.t("Standard Call t");
Drupal
.
t
(
"Whitespace Call t"
)
;
Drupal.t('Single Quote t');
Drupal.t('Single Quote \'Escaped\' t');
Drupal.t('Single Quote ' + 'Concat ' + 'strings ' + 't');
Drupal.t("Double Quote t");
Drupal.t("Double Quote \"Escaped\" t");
Drupal.t("Double Quote " + "Concat " + "strings " + "t");
Drupal.t("Context Unquoted t", {}, {context: "Context string unquoted"});
Drupal.t("Context Single Quoted t", {}, {'context': "Context string single quoted"});
Drupal.t("Context Double Quoted t", {}, {"context": "Context string double quoted"});
Drupal.t("Context !key Args t", {'!key': 'value'}, {context: "Context string"});
Drupal.formatPlural(1, "Standard Call plural", "Standard Call @count plural");
Drupal
.
formatPlural
(
1,
"Whitespace Call plural",
"Whitespace Call @count plural"
)
;
Drupal.formatPlural(1, 'Single Quote plural', 'Single Quote @count plural');
Drupal.formatPlural(1, 'Single Quote \'Escaped\' plural', 'Single Quote \'Escaped\' @count plural');
Drupal.formatPlural(1, "Double Quote plural", "Double Quote @count plural");
Drupal.formatPlural(1, "Double Quote \"Escaped\" plural", "Double Quote \"Escaped\" @count plural");
Drupal.formatPlural(1, "Context Unquoted plural", "Context Unquoted @count plural", {}, {context: "Context string unquoted"});
Drupal.formatPlural(1, "Context Single Quoted plural", "Context Single Quoted @count plural", {}, {'context': "Context string single quoted"});
Drupal.formatPlural(1, "Context Double Quoted plural", "Context Double Quoted @count plural", {}, {"context": "Context string double quoted"});
Drupal.formatPlural(1, "Context !key Args plural", "Context !key Args @count plural", {'!key': 'value'}, {context: "Context string"});
t('Custom'));
}
}
/**
* Implements hook_boot().
*
* For testing domain language negotiation, we fake it by setting
* the HTTP_HOST here
*/
function locale_test_boot() {
if (variable_get('locale_test_domain')) {
$_SERVER['HTTP_HOST'] = variable_get('locale_test_domain');
}
}
/**
* Implements hook_init().
*/
function locale_test_init() {
locale_test_store_language_negotiation();
if (isset($GLOBALS['language']) && isset($GLOBALS['language']->provider)) {
drupal_set_message(t('Language negotiation provider: @name', array('@name' => $GLOBALS['language']->provider)));
}
}
/**
* Implements hook_language_types_info().
*/
function locale_test_language_types_info() {
if (variable_get('locale_test_language_types', FALSE)) {
return array(
'test_language_type' => array(
'name' => t('Test'),
'description' => t('A test language type.'),
),
'fixed_test_language_type' => array(
'fixed' => array('test_language_provider'),
),
);
}
}
/**
* Implements hook_menu().
*
* @return array
*/
function locale_test_menu() {
$items = array();
$items['locale_test_plural_format_page'] = array(
'page callback' => 'locale_test_plural_format_page',
'access callback' => TRUE,
'type' => MENU_CALLBACK,
);
return $items;
}
/**
* Implements hook_language_types_info_alter().
*/
function locale_test_language_types_info_alter(array &$language_types) {
if (variable_get('locale_test_content_language_type', FALSE)) {
unset($language_types[LANGUAGE_TYPE_CONTENT]['fixed']);
}
}
/**
* Implements hook_language_negotiation_info().
*/
function locale_test_language_negotiation_info() {
if (variable_get('locale_test_language_negotiation_info', FALSE)) {
$info = array(
'callbacks' => array(
'language' => 'locale_test_language_provider',
),
'file' => drupal_get_path('module', 'locale_test') .'/locale_test.module',
'weight' => -10,
'description' => t('This is a test language provider.'),
);
return array(
'test_language_provider' => array(
'name' => t('Test'),
'types' => array(LANGUAGE_TYPE_CONTENT, 'test_language_type', 'fixed_test_language_type'),
) + $info,
'test_language_provider_ts' => array(
'name' => t('Type-specific test'),
'types' => array('test_language_type'),
) + $info,
);
}
}
/**
* Implements hook_language_negotiation_info_alter().
*/
function locale_test_language_negotiation_info_alter(array &$language_providers) {
if (variable_get('locale_test_language_negotiation_info_alter', FALSE)) {
unset($language_providers[LOCALE_LANGUAGE_NEGOTIATION_INTERFACE]);
}
}
/**
* Store the last negotiated languages.
*/
function locale_test_store_language_negotiation() {
$last = array();
foreach (language_types() as $type) {
$last[$type] = $GLOBALS[$type]->language;
}
variable_set('locale_test_language_negotiation_last', $last);
}
/**
* Test language provider.
*/
function locale_test_language_provider($languages) {
return 'it';
}
/**
* Returns markup for locale_get_plural testing.
*
* @return array
*/
function locale_test_plural_format_page() {
$tests = _locale_test_plural_format_tests();
$result = array();
foreach ($tests as $test) {
$string_param = array(
'@lang' => $test['language'],
'@locale_get_plural' => locale_get_plural($test['count'], $test['language'])
);
$result[] = array(
'#prefix' => '' . filter_xss_admin($variables['description']) . '
';
return $output;
}
/**
* Form for editing an entire menu tree at once.
*
* Shows for one menu the menu links accessible to the current user and
* relevant operations.
*/
function menu_overview_form($form, &$form_state, $menu) {
global $menu_admin;
$form['#attached']['css'] = array(drupal_get_path('module', 'menu') . '/menu.css');
$sql = "
SELECT m.load_functions, m.to_arg_functions, m.access_callback, m.access_arguments, m.page_callback, m.page_arguments, m.delivery_callback, m.title, m.title_callback, m.title_arguments, m.type, m.description, ml.*
FROM {menu_links} ml LEFT JOIN {menu_router} m ON m.path = ml.router_path
WHERE ml.menu_name = :menu
ORDER BY p1 ASC, p2 ASC, p3 ASC, p4 ASC, p5 ASC, p6 ASC, p7 ASC, p8 ASC, p9 ASC";
$result = db_query($sql, array(':menu' => $menu['menu_name']), array('fetch' => PDO::FETCH_ASSOC));
$links = array();
foreach ($result as $item) {
$links[] = $item;
}
$link_count = db_query("SELECT COUNT(*) AS counter FROM {menu_links} WHERE menu_name = :menu AND link_path NOT LIKE :link_path", array(':menu' => $menu['menu_name'], ':link_path' => '%\%%'))->fetchObject();
$counter = intval($link_count->counter / 2 ) + 1;
$tree = menu_tree_data($links);
$node_links = array();
menu_tree_collect_node_links($tree, $node_links);
// We indicate that a menu administrator is running the menu access check.
$menu_admin = TRUE;
menu_tree_check_access($tree, $node_links);
$menu_admin = FALSE;
$delta = _menu_get_menu_weight_delta($menu['menu_name'], $counter);
$form = array_merge($form, _menu_overview_tree_form($tree, $delta));
$form['#menu'] = $menu;
if (element_children($form)) {
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Save configuration'),
);
}
else {
$form['#empty_text'] = t('There are no menu links yet. Add link .', array('@link' => url('admin/structure/menu/manage/'. $form['#menu']['menu_name'] .'/add')));
}
return $form;
}
/**
* Recursive helper function for menu_overview_form().
*
* @param $tree
* The menu_tree retrieved by menu_tree_data.
* @param $delta
* The number of items to use in the menu weight selector. Defaults to 50.
*/
function _menu_overview_tree_form($tree, $delta = 50) {
$form = &drupal_static(__FUNCTION__, array('#tree' => TRUE));
foreach ($tree as $data) {
$title = '';
$item = $data['link'];
// Don't show callbacks; these have $item['hidden'] < 0.
if ($item && $item['hidden'] >= 0) {
$mlid = 'mlid:' . $item['mlid'];
$form[$mlid]['#item'] = $item;
$form[$mlid]['#attributes'] = $item['hidden'] ? array('class' => array('menu-disabled')) : array('class' => array('menu-enabled'));
$form[$mlid]['title']['#markup'] = l($item['title'], $item['href'], $item['localized_options']);
menu_add_link_labels($form[$mlid]['title']['#markup'], $item);
$form[$mlid]['hidden'] = array(
'#type' => 'checkbox',
'#title' => t('Enable @title menu link', array('@title' => $item['title'])),
'#title_display' => 'invisible',
'#default_value' => !$item['hidden'],
);
$form[$mlid]['weight'] = array(
'#type' => 'weight',
'#delta' => $delta,
'#default_value' => $item['weight'],
'#title_display' => 'invisible',
'#title' => t('Weight for @title', array('@title' => $item['title'])),
);
$form[$mlid]['mlid'] = array(
'#type' => 'hidden',
'#value' => $item['mlid'],
);
$form[$mlid]['plid'] = array(
'#type' => 'hidden',
'#default_value' => $item['plid'],
);
// Build a list of operations.
$operations = array();
$operations['edit'] = array('#type' => 'link', '#title' => t('edit'), '#href' => 'admin/structure/menu/item/' . $item['mlid'] . '/edit');
// Only items created by the menu module can be deleted.
if ($item['module'] == 'menu' || $item['updated'] == 1) {
$operations['delete'] = array('#type' => 'link', '#title' => t('delete'), '#href' => 'admin/structure/menu/item/' . $item['mlid'] . '/delete');
}
// Set the reset column.
elseif ($item['module'] == 'system' && $item['customized']) {
$operations['reset'] = array('#type' => 'link', '#title' => t('reset'), '#href' => 'admin/structure/menu/item/' . $item['mlid'] . '/reset');
}
$form[$mlid]['operations'] = $operations;
}
if ($data['below']) {
_menu_overview_tree_form($data['below'], $delta);
}
}
return $form;
}
/**
* Submit handler for the menu overview form.
*
* This function takes great care in saving parent items first, then items
* underneath them. Saving items in the incorrect order can break the menu tree.
*
* @see menu_overview_form()
*/
function menu_overview_form_submit($form, &$form_state) {
// When dealing with saving menu items, the order in which these items are
// saved is critical. If a changed child item is saved before its parent,
// the child item could be saved with an invalid path past its immediate
// parent. To prevent this, save items in the form in the same order they
// are sent by $_POST, ensuring parents are saved first, then their children.
// See http://drupal.org/node/181126#comment-632270
$order = array_flip(array_keys($form_state['input'])); // Get the $_POST order.
$form = array_merge($order, $form); // Update our original form with the new order.
$updated_items = array();
$fields = array('weight', 'plid');
foreach (element_children($form) as $mlid) {
if (isset($form[$mlid]['#item'])) {
$element = $form[$mlid];
// Update any fields that have changed in this menu item.
foreach ($fields as $field) {
if ($element[$field]['#value'] != $element[$field]['#default_value']) {
$element['#item'][$field] = $element[$field]['#value'];
$updated_items[$mlid] = $element['#item'];
}
}
// Hidden is a special case, the value needs to be reversed.
if ($element['hidden']['#value'] != $element['hidden']['#default_value']) {
// Convert to integer rather than boolean due to PDO cast to string.
$element['#item']['hidden'] = $element['hidden']['#value'] ? 0 : 1;
$updated_items[$mlid] = $element['#item'];
}
}
}
// Save all our changed items to the database.
foreach ($updated_items as $item) {
$item['customized'] = 1;
menu_link_save($item);
}
drupal_set_message(t('Your configuration has been saved.'));
}
/**
* Returns HTML for the menu overview form into a table.
*
* @param $variables
* An associative array containing:
* - form: A render element representing the form.
*
* @ingroup themeable
*/
function theme_menu_overview_form($variables) {
$form = $variables['form'];
drupal_add_tabledrag('menu-overview', 'match', 'parent', 'menu-plid', 'menu-plid', 'menu-mlid', TRUE, MENU_MAX_DEPTH - 1);
drupal_add_tabledrag('menu-overview', 'order', 'sibling', 'menu-weight');
$header = array(
t('Menu link'),
array('data' => t('Enabled'), 'class' => array('checkbox')),
t('Weight'),
array('data' => t('Operations'), 'colspan' => '3'),
);
$rows = array();
foreach (element_children($form) as $mlid) {
if (isset($form[$mlid]['hidden'])) {
$element = &$form[$mlid];
// Build a list of operations.
$operations = array();
foreach (element_children($element['operations']) as $op) {
$operations[] = array('data' => drupal_render($element['operations'][$op]), 'class' => array('menu-operations'));
}
while (count($operations) < 2) {
$operations[] = '';
}
// Add special classes to be used for tabledrag.js.
$element['plid']['#attributes']['class'] = array('menu-plid');
$element['mlid']['#attributes']['class'] = array('menu-mlid');
$element['weight']['#attributes']['class'] = array('menu-weight');
// Change the parent field to a hidden. This allows any value but hides the field.
$element['plid']['#type'] = 'hidden';
$row = array();
$row[] = theme('indentation', array('size' => $element['#item']['depth'] - 1)) . drupal_render($element['title']);
$row[] = array('data' => drupal_render($element['hidden']), 'class' => array('checkbox', 'menu-enabled'));
$row[] = drupal_render($element['weight']) . drupal_render($element['plid']) . drupal_render($element['mlid']);
$row = array_merge($row, $operations);
$row = array_merge(array('data' => $row), $element['#attributes']);
$row['class'][] = 'draggable';
$rows[] = $row;
}
}
$output = '';
if (empty($rows)) {
$rows[] = array(array('data' => $form['#empty_text'], 'colspan' => '7'));
}
$output .= theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('id' => 'menu-overview')));
$output .= drupal_render_children($form);
return $output;
}
/**
* Menu callback; Build the menu link editing form.
*/
function menu_edit_item($form, &$form_state, $type, $item, $menu) {
if ($type == 'add' || empty($item)) {
// This is an add form, initialize the menu link.
$item = array('link_title' => '', 'mlid' => 0, 'plid' => 0, 'menu_name' => $menu['menu_name'], 'weight' => 0, 'link_path' => '', 'options' => array(), 'module' => 'menu', 'expanded' => 0, 'hidden' => 0, 'has_children' => 0);
}
else {
// Get the human-readable menu title from the given menu name.
$titles = menu_get_menus();
$current_title = $titles[$item['menu_name']];
// Get the current breadcrumb and add a link to that menu's overview page.
$breadcrumb = menu_get_active_breadcrumb();
$breadcrumb[] = l($current_title, 'admin/structure/menu/manage/' . $item['menu_name']);
drupal_set_breadcrumb($breadcrumb);
}
$form['actions'] = array('#type' => 'actions');
$form['link_title'] = array(
'#type' => 'textfield',
'#title' => t('Menu link title'),
'#maxlength' => 255,
'#default_value' => $item['link_title'],
'#description' => t('The text to be used for this link in the menu.'),
'#required' => TRUE,
);
foreach (array('link_path', 'mlid', 'module', 'has_children', 'options') as $key) {
$form[$key] = array('#type' => 'value', '#value' => $item[$key]);
}
// Any item created or edited via this interface is considered "customized".
$form['customized'] = array('#type' => 'value', '#value' => 1);
$form['original_item'] = array('#type' => 'value', '#value' => $item);
$path = $item['link_path'];
if (isset($item['options']['query'])) {
$path .= '?' . drupal_http_build_query($item['options']['query']);
}
if (isset($item['options']['fragment'])) {
$path .= '#' . $item['options']['fragment'];
}
if ($item['module'] == 'menu') {
$form['link_path'] = array(
'#type' => 'textfield',
'#title' => t('Path'),
'#maxlength' => 255,
'#default_value' => $path,
'#description' => t('The path for this menu link. This can be an internal path such as %add-node or an external URL such as %example. Enter %front to link to the front page.', array('%front' => '', '%add-node' => 'node/add', '%example' => 'http://example.com')),
'#required' => TRUE,
);
$form['actions']['delete'] = array(
'#type' => 'submit',
'#value' => t('Delete'),
'#access' => $item['mlid'],
'#submit' => array('menu_item_delete_submit'),
'#weight' => 10,
);
}
else {
$form['_path'] = array(
'#type' => 'item',
'#title' => t('Path'),
'#description' => l($item['link_title'], $item['href'], $item['options']),
);
}
$form['description'] = array(
'#type' => 'textarea',
'#title' => t('Description'),
'#default_value' => isset($item['options']['attributes']['title']) ? $item['options']['attributes']['title'] : '',
'#rows' => 1,
'#description' => t('Shown when hovering over the menu link.'),
);
$form['enabled'] = array(
'#type' => 'checkbox',
'#title' => t('Enabled'),
'#default_value' => !$item['hidden'],
'#description' => t('Menu links that are not enabled will not be listed in any menu.'),
);
$form['expanded'] = array(
'#type' => 'checkbox',
'#title' => t('Show as expanded'),
'#default_value' => $item['expanded'],
'#description' => t('If selected and this menu link has children, the menu will always appear expanded.'),
);
// Generate a list of possible parents (not including this link or descendants).
$options = menu_parent_options(menu_get_menus(), $item);
$default = $item['menu_name'] . ':' . $item['plid'];
if (!isset($options[$default])) {
$default = 'navigation:0';
}
$form['parent'] = array(
'#type' => 'select',
'#title' => t('Parent link'),
'#default_value' => $default,
'#options' => $options,
'#description' => t('The maximum depth for a link and all its children is fixed at !maxdepth. Some menu links may not be available as parents if selecting them would exceed this limit.', array('!maxdepth' => MENU_MAX_DEPTH)),
'#attributes' => array('class' => array('menu-title-select')),
);
// Get number of items in all possible parent menus so the weight selector is
// sized appropriately.
$menu_names = array_keys(menu_get_menus());
$menu_options = array();
foreach ($menu_names as $menu_name) {
if (isset($options[$menu_name . ':0'])) {
$menu_options[] = $menu_name;
}
}
// Make sure that we always have values in menu_options.
$menu_options = !empty($menu_options) ? $menu_options : $menu_names;
$form['weight'] = array(
'#type' => 'weight',
'#title' => t('Weight'),
'#delta' => _menu_get_menu_weight_delta($menu_options),
'#default_value' => $item['weight'],
'#description' => t('Optional. In the menu, the heavier links will sink and the lighter links will be positioned nearer the top.'),
);
$form['actions']['submit'] = array('#type' => 'submit', '#value' => t('Save'));
return $form;
}
/**
* Validate form values for a menu link being added or edited.
*/
function menu_edit_item_validate($form, &$form_state) {
$item = &$form_state['values'];
$normal_path = drupal_get_normal_path($item['link_path']);
if ($item['link_path'] != $normal_path) {
drupal_set_message(t('The menu system stores system paths only, but will use the URL alias for display. %link_path has been stored as %normal_path', array('%link_path' => $item['link_path'], '%normal_path' => $normal_path)));
$item['link_path'] = $normal_path;
}
if (!url_is_external($item['link_path'])) {
$parsed_link = parse_url($item['link_path']);
if (isset($parsed_link['query'])) {
$item['options']['query'] = drupal_get_query_array($parsed_link['query']);
}
else {
// Use unset() rather than setting to empty string
// to avoid redundant serialized data being stored.
unset($item['options']['query']);
}
if (isset($parsed_link['fragment'])) {
$item['options']['fragment'] = $parsed_link['fragment'];
}
else {
unset($item['options']['fragment']);
}
if (isset($parsed_link['path']) && $item['link_path'] != $parsed_link['path']) {
$item['link_path'] = $parsed_link['path'];
}
}
if (!trim($item['link_path']) || !drupal_valid_path($item['link_path'], TRUE)) {
form_set_error('link_path', t("The path '@link_path' is either invalid or you do not have access to it.", array('@link_path' => $item['link_path'])));
}
}
/**
* Submit function for the delete button on the menu item editing form.
*/
function menu_item_delete_submit($form, &$form_state) {
$form_state['redirect'] = 'admin/structure/menu/item/' . $form_state['values']['mlid'] . '/delete';
}
/**
* Process menu and menu item add/edit form submissions.
*/
function menu_edit_item_submit($form, &$form_state) {
$item = &$form_state['values'];
// The value of "hidden" is the opposite of the value
// supplied by the "enabled" checkbox.
$item['hidden'] = (int) !$item['enabled'];
unset($item['enabled']);
$item['options']['attributes']['title'] = $item['description'];
list($item['menu_name'], $item['plid']) = explode(':', $item['parent']);
if (!menu_link_save($item)) {
drupal_set_message(t('There was an error saving the menu link.'), 'error');
}
else {
drupal_set_message(t('Your configuration has been saved.'));
}
$form_state['redirect'] = 'admin/structure/menu/manage/' . $item['menu_name'];
}
/**
* Menu callback; Build the form that handles the adding/editing of a custom menu.
*/
function menu_edit_menu($form, &$form_state, $type, $menu = array()) {
$system_menus = menu_list_system_menus();
$menu += array(
'menu_name' => '',
'old_name' => !empty($menu['menu_name']) ? $menu['menu_name'] : '',
'title' => '',
'description' => '',
);
// Allow menu_edit_menu_submit() and other form submit handlers to determine
// whether the menu already exists.
$form['#insert'] = empty($menu['old_name']);
$form['old_name'] = array(
'#type' => 'value',
'#value' => $menu['old_name'],
);
$form['title'] = array(
'#type' => 'textfield',
'#title' => t('Title'),
'#default_value' => $menu['title'],
'#required' => TRUE,
// The title of a system menu cannot be altered.
'#access' => !isset($system_menus[$menu['menu_name']]),
);
$form['menu_name'] = array(
'#type' => 'machine_name',
'#title' => t('Menu name'),
'#default_value' => $menu['menu_name'],
'#maxlength' => MENU_MAX_MENU_NAME_LENGTH_UI,
'#description' => t('A unique name to construct the URL for the menu. It must only contain lowercase letters, numbers and hyphens.'),
'#field_prefix' => empty($menu['old_name']) ? 'menu-' : '',
'#machine_name' => array(
'exists' => 'menu_edit_menu_name_exists',
'source' => array('title'),
'replace_pattern' => '[^a-z0-9-]+',
'replace' => '-',
),
// A menu's machine name cannot be changed.
'#disabled' => !empty($menu['old_name']) || isset($system_menus[$menu['menu_name']]),
);
$form['description'] = array(
'#type' => 'textarea',
'#title' => t('Description'),
'#default_value' => $menu['description'],
);
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Save'),
);
// Only custom menus may be deleted.
$form['actions']['delete'] = array(
'#type' => 'submit',
'#value' => t('Delete'),
'#access' => $type == 'edit' && !isset($system_menus[$menu['menu_name']]),
'#submit' => array('menu_custom_delete_submit'),
);
return $form;
}
/**
* Submit function for the 'Delete' button on the menu editing form.
*/
function menu_custom_delete_submit($form, &$form_state) {
$form_state['redirect'] = 'admin/structure/menu/manage/' . $form_state['values']['menu_name'] . '/delete';
}
/**
* Menu callback; check access and get a confirm form for deletion of a custom menu.
*/
function menu_delete_menu_page($menu) {
// System-defined menus may not be deleted.
$system_menus = menu_list_system_menus();
if (isset($system_menus[$menu['menu_name']])) {
return MENU_ACCESS_DENIED;
}
return drupal_get_form('menu_delete_menu_confirm', $menu);
}
/**
* Build a confirm form for deletion of a custom menu.
*/
function menu_delete_menu_confirm($form, &$form_state, $menu) {
$form['#menu'] = $menu;
$caption = '';
$num_links = db_query("SELECT COUNT(*) FROM {menu_links} WHERE menu_name = :menu", array(':menu' => $menu['menu_name']))->fetchField();
if ($num_links) {
$caption .= '' . format_plural($num_links, 'Warning: There is currently 1 menu link in %title. It will be deleted (system-defined items will be reset).', 'Warning: There are currently @count menu links in %title. They will be deleted (system-defined links will be reset).', array('%title' => $menu['title'])) . '
';
}
$caption .= '' . t('This action cannot be undone.') . '
';
return confirm_form($form, t('Are you sure you want to delete the custom menu %title?', array('%title' => $menu['title'])), 'admin/structure/menu/manage/' . $menu['menu_name'], $caption, t('Delete'));
}
/**
* Delete a custom menu and all links in it.
*/
function menu_delete_menu_confirm_submit($form, &$form_state) {
$menu = $form['#menu'];
$form_state['redirect'] = 'admin/structure/menu';
// System-defined menus may not be deleted - only menus defined by this module.
$system_menus = menu_list_system_menus();
if (isset($system_menus[$menu['menu_name']]) || !(db_query("SELECT 1 FROM {menu_custom} WHERE menu_name = :menu", array(':menu' => $menu['menu_name']))->fetchField())) {
return;
}
// Reset all the menu links defined by the system via hook_menu().
$result = db_query("SELECT * FROM {menu_links} ml INNER JOIN {menu_router} m ON ml.router_path = m.path WHERE ml.menu_name = :menu AND ml.module = 'system' ORDER BY m.number_parts ASC", array(':menu' => $menu['menu_name']), array('fetch' => PDO::FETCH_ASSOC));
foreach ($result as $link) {
menu_reset_item($link);
}
// Delete all links to the overview page for this menu.
$result = db_query("SELECT mlid FROM {menu_links} ml WHERE ml.link_path = :link", array(':link' => 'admin/structure/menu/manage/' . $menu['menu_name']), array('fetch' => PDO::FETCH_ASSOC));
foreach ($result as $link) {
menu_link_delete($link['mlid']);
}
// Delete the custom menu and all its menu links.
menu_delete($menu);
$t_args = array('%title' => $menu['title']);
drupal_set_message(t('The custom menu %title has been deleted.', $t_args));
watchdog('menu', 'Deleted custom menu %title and all its menu links.', $t_args, WATCHDOG_NOTICE);
}
/**
* Returns whether a menu name already exists.
*
* @see menu_edit_menu()
* @see form_validate_machine_name()
*/
function menu_edit_menu_name_exists($value) {
// 'menu-' is added to the menu name to avoid name-space conflicts.
$value = 'menu-' . $value;
$custom_exists = db_query_range('SELECT 1 FROM {menu_custom} WHERE menu_name = :menu', 0, 1, array(':menu' => $value))->fetchField();
$link_exists = db_query_range("SELECT 1 FROM {menu_links} WHERE menu_name = :menu", 0, 1, array(':menu' => $value))->fetchField();
return $custom_exists || $link_exists;
}
/**
* Submit function for adding or editing a custom menu.
*/
function menu_edit_menu_submit($form, &$form_state) {
$menu = $form_state['values'];
$path = 'admin/structure/menu/manage/';
if ($form['#insert']) {
// Add 'menu-' to the menu name to help avoid name-space conflicts.
$menu['menu_name'] = 'menu-' . $menu['menu_name'];
$link['link_title'] = $menu['title'];
$link['link_path'] = $path . $menu['menu_name'];
$link['router_path'] = $path . '%';
$link['module'] = 'menu';
$link['plid'] = db_query("SELECT mlid FROM {menu_links} WHERE link_path = :link AND module = :module", array(
':link' => 'admin/structure/menu',
':module' => 'system'
))
->fetchField();
menu_link_save($link);
menu_save($menu);
}
else {
menu_save($menu);
$result = db_query("SELECT mlid FROM {menu_links} WHERE link_path = :path", array(':path' => $path . $menu['menu_name']), array('fetch' => PDO::FETCH_ASSOC));
foreach ($result as $m) {
$link = menu_link_load($m['mlid']);
$link['link_title'] = $menu['title'];
menu_link_save($link);
}
}
drupal_set_message(t('Your configuration has been saved.'));
$form_state['redirect'] = $path . $menu['menu_name'];
}
/**
* Menu callback; Check access and present a confirm form for deleting a menu link.
*/
function menu_item_delete_page($item) {
// Links defined via hook_menu may not be deleted. Updated items are an
// exception, as they can be broken.
if ($item['module'] == 'system' && !$item['updated']) {
return MENU_ACCESS_DENIED;
}
return drupal_get_form('menu_item_delete_form', $item);
}
/**
* Build a confirm form for deletion of a single menu link.
*/
function menu_item_delete_form($form, &$form_state, $item) {
$form['#item'] = $item;
return confirm_form($form, t('Are you sure you want to delete the custom menu link %item?', array('%item' => $item['link_title'])), 'admin/structure/menu/manage/' . $item['menu_name']);
}
/**
* Process menu delete form submissions.
*/
function menu_item_delete_form_submit($form, &$form_state) {
$item = $form['#item'];
menu_link_delete($item['mlid']);
$t_args = array('%title' => $item['link_title']);
drupal_set_message(t('The menu link %title has been deleted.', $t_args));
watchdog('menu', 'Deleted menu link %title.', $t_args, WATCHDOG_NOTICE);
$form_state['redirect'] = 'admin/structure/menu/manage/' . $item['menu_name'];
}
/**
* Menu callback; reset a single modified menu link.
*/
function menu_reset_item_confirm($form, &$form_state, $item) {
$form['item'] = array('#type' => 'value', '#value' => $item);
return confirm_form($form, t('Are you sure you want to reset the link %item to its default values?', array('%item' => $item['link_title'])), 'admin/structure/menu/manage/' . $item['menu_name'], t('Any customizations will be lost. This action cannot be undone.'), t('Reset'));
}
/**
* Process menu reset item form submissions.
*/
function menu_reset_item_confirm_submit($form, &$form_state) {
$item = $form_state['values']['item'];
$new_item = menu_reset_item($item);
drupal_set_message(t('The menu link was reset to its default settings.'));
$form_state['redirect'] = 'admin/structure/menu/manage/' . $new_item['menu_name'];
}
/**
* Menu callback; Build the form presenting menu configuration options.
*/
function menu_configure() {
$form['intro'] = array(
'#type' => 'item',
'#markup' => t('The menu module allows on-the-fly creation of menu links in the content authoring forms. To configure these settings for a particular content type, visit the Content types page, click the edit link for the content type, and go to the Menu settings section.', array('@content-types' => url('admin/structure/types'))),
);
$menu_options = menu_get_menus();
$main = variable_get('menu_main_links_source', 'main-menu');
$form['menu_main_links_source'] = array(
'#type' => 'select',
'#title' => t('Source for the Main links'),
'#default_value' => variable_get('menu_main_links_source', 'main-menu'),
'#empty_option' => t('No Main links'),
'#options' => $menu_options,
'#tree' => FALSE,
'#description' => t('Select what should be displayed as the Main links (typically at the top of the page).'),
);
$form['menu_secondary_links_source'] = array(
'#type' => 'select',
'#title' => t('Source for the Secondary links'),
'#default_value' => variable_get('menu_secondary_links_source', 'user-menu'),
'#empty_option' => t('No Secondary links'),
'#options' => $menu_options,
'#tree' => FALSE,
'#description' => t('Select the source for the Secondary links. An advanced option allows you to use the same source for both Main links (currently %main) and Secondary links: if your source menu has two levels of hierarchy, the top level menu links will appear in the Main links, and the children of the active link will appear in the Secondary links.', array('%main' => $main ? $menu_options[$main] : t('none'))),
);
return system_settings_form($form);
}
(function ($) {
Drupal.behaviors.menuChangeParentItems = {
attach: function (context, settings) {
$('fieldset#edit-menu input').each(function () {
$(this).change(function () {
// Update list of available parent menu items.
Drupal.menu_update_parent_list();
});
});
}
};
/**
* Function to set the options of the menu parent item dropdown.
*/
Drupal.menu_update_parent_list = function () {
var values = [];
$('input:checked', $('fieldset#edit-menu')).each(function () {
// Get the names of all checked menus.
values.push(Drupal.checkPlain($.trim($(this).val())));
});
var url = Drupal.settings.basePath + 'admin/structure/menu/parents';
$.ajax({
url: location.protocol + '//' + location.host + url,
type: 'POST',
data: {'menus[]' : values},
dataType: 'json',
success: function (options) {
// Save key of last selected element.
var selected = $('fieldset#edit-menu #edit-menu-parent :selected').val();
// Remove all exisiting options from dropdown.
$('fieldset#edit-menu #edit-menu-parent').children().remove();
// Add new options to dropdown.
jQuery.each(options, function(index, value) {
$('fieldset#edit-menu #edit-menu-parent').append(
$('Navigation menu contains links intended for site visitors. Links are added to the Navigation menu automatically by some modules.'),
'user-menu' => $t("The User menu contains links related to the user's account, as well as the 'Log out' link."),
'management' => $t('The Management menu contains links for administrative tasks.'),
'main-menu' => $t('The Main menu is used on many sites to show the major sections of the site, often in a top navigation bar.'),
);
foreach ($system_menus as $menu_name => $title) {
$menu = array(
'menu_name' => $menu_name,
'title' => $t($title),
'description' => $descriptions[$menu_name],
);
menu_save($menu);
}
}
/**
* Implements hook_uninstall().
*/
function menu_uninstall() {
menu_rebuild();
}
/**
* @addtogroup updates-7.x-extra
* @{
*/
/**
* Migrate the "Default menu for content" setting to individual node types.
*/
function menu_update_7000() {
// Act only on sites originally on Drupal 6 that have a custom "Default menu
// for content" setting.
$default_node_menu = variable_get('menu_default_node_menu');
if (isset($default_node_menu)) {
// Remove variable no longer used in Drupal 7.
variable_del('menu_default_node_menu');
// Make sure the menu chosen as the default still exists.
$defined_menus = db_query('SELECT * FROM {menu_custom}')->fetchAllAssoc('menu_name', PDO::FETCH_ASSOC);
// If the menu does not exist, do nothing; nodes will use the default D7
// node menu settings.
if (!isset($defined_menus[$default_node_menu])) {
return;
}
// Update the menu settings for each node type.
foreach (_update_7000_node_get_types() as $type => $type_object) {
$type_menus = variable_get('menu_options_' . $type);
// If the site already has a custom menu setting for this node type (set
// on the initial upgrade to Drupal 7.0), don't override it.
if (!isset($type_menus)) {
// Set up this node type so that the Drupal 6 "Default menu for content"
// is still available in the "Menu settings" section.
variable_set('menu_options_' . $type, array($default_node_menu));
variable_set('menu_parent_' . $type, $default_node_menu . ':0');
}
}
}
}
/**
* Rename "Primary Links" and "Secondary Links" to their Drupal 7 equivalents.
*/
function menu_update_7001() {
// Migrate D6 menu_primary_links_source to D7 menu_main_links_source (without
// renaming).
if (variable_get('menu_primary_links_source') !== NULL) {
variable_set('menu_main_links_source', variable_get('menu_primary_links_source'));
variable_del('menu_primary_links_source');
}
// Rename each menu, and any settings that refer to the old menu name.
// - "Primary Links" has become system menu "Main menu".
// - "Secondary Links" has become a new custom menu "Secondary menu".
$rename = array(
'primary-links' => array('main-menu', 'Main menu'),
'secondary-links' => array('secondary-menu', 'Secondary menu'),
);
foreach ($rename as $from_menu => $to) {
list($to_menu, $to_title) = $to;
// Rename the menu, and links in the menu.
db_update('menu_custom')
->fields(array('menu_name' => $to_menu, 'title' => $to_title))
->condition('menu_name', $from_menu)
->execute();
db_update('menu_links')
->fields(array('menu_name' => $to_menu))
->condition('menu_name', $from_menu)
->execute();
// Update any content type that used this menu as a default menu.
// Note: these variables may be unset/default, in which case we leave them
// alone. See menu_update_7000()
foreach (_update_7000_node_get_types() as $type => $type_object) {
$menu_options = variable_get('menu_options_' . $type);
if ($menu_options !== NULL) {
variable_set('menu_options_' . $type, str_replace($from_menu, $to_menu, $menu_options));
if (variable_get('menu_parent_' . $type) == $from_menu . ':0') {
variable_set('menu_parent_' . $type, $to_menu . ':0');
}
}
}
// Update the "source for primary links" and "source for secondary links" to
// follow.
if (variable_get('menu_main_links_source') == $from_menu) {
variable_set('menu_main_links_source', $to_menu);
}
if (variable_get('menu_secondary_links_source') == $from_menu) {
variable_set('menu_secondary_links_source', $to_menu);
}
}
}
/**
* Rename the primary/secondary menu blocks to match previously renamed menus.
*/
function menu_update_7002(&$sandbox) {
// Check for the presence of old or new table names.
if (db_table_exists('blocks') || db_table_exists('block')) {
$renamed_deltas = array(
'menu' => array(
'primary-links' => 'main-menu',
'secondary-links' => 'secondary-menu',
),
);
$moved_deltas = array(
'menu' => array('main-menu' => 'system'),
);
update_fix_d7_block_deltas($sandbox, $renamed_deltas, $moved_deltas);
}
}
/**
* Add missing custom menus to active menus list.
*/
function menu_update_7003(&$sandbox) {
// Make sure all custom menus are present in the active menus variable so that
// their items may appear in the active trail.
// @see menu_set_active_menu_names()
$active_menus = variable_get('menu_default_active_menus', array_keys(menu_list_system_menus()));
$update_variable = FALSE;
foreach (menu_get_names() as $menu_name) {
if (!in_array($menu_name, $active_menus) && (strpos($menu_name, 'menu-') === 0)) {
$active_menus[] = $menu_name;
$update_variable = TRUE;
}
}
if ($update_variable) {
variable_set('menu_default_active_menus', $active_menus);
}
// Clear the menu cache.
cache_clear_all(NULL, 'cache_menu');
}
/**
* @} End of "addtogroup updates-7.x-extra".
* The next series of updates should start at 8000.
*/
(function ($) {
Drupal.behaviors.menuFieldsetSummaries = {
attach: function (context) {
$('fieldset.menu-link-form', context).drupalSetSummary(function (context) {
if ($('.form-item-menu-enabled input', context).is(':checked')) {
return Drupal.checkPlain($('.form-item-menu-link-title input', context).val());
}
else {
return Drupal.t('Not in menu');
}
});
}
};
/**
* Automatically fill in a menu link title, if possible.
*/
Drupal.behaviors.menuLinkAutomaticTitle = {
attach: function (context) {
$('fieldset.menu-link-form', context).each(function () {
// Try to find menu settings widget elements as well as a 'title' field in
// the form, but play nicely with user permissions and form alterations.
var $checkbox = $('.form-item-menu-enabled input', this);
var $link_title = $('.form-item-menu-link-title input', context);
var $title = $(this).closest('form').find('.form-item-title input');
// Bail out if we do not have all required fields.
if (!($checkbox.length && $link_title.length && $title.length)) {
return;
}
// If there is a link title already, mark it as overridden. The user expects
// that toggling the checkbox twice will take over the node's title.
if ($checkbox.is(':checked') && $link_title.val().length) {
$link_title.data('menuLinkAutomaticTitleOveridden', true);
}
// Whenever the value is changed manually, disable this behavior.
$link_title.keyup(function () {
$link_title.data('menuLinkAutomaticTitleOveridden', true);
});
// Global trigger on checkbox (do not fill-in a value when disabled).
$checkbox.change(function () {
if ($checkbox.is(':checked')) {
if (!$link_title.data('menuLinkAutomaticTitleOveridden')) {
$link_title.val($title.val());
}
}
else {
$link_title.val('');
$link_title.removeData('menuLinkAutomaticTitleOveridden');
}
$checkbox.closest('fieldset.vertical-tabs-pane').trigger('summaryUpdated');
$checkbox.trigger('formUpdated');
});
// Take over any title change.
$title.keyup(function () {
if (!$link_title.data('menuLinkAutomaticTitleOveridden') && $checkbox.is(':checked')) {
$link_title.val($title.val());
$link_title.val($title.val()).trigger('formUpdated');
}
});
});
}
};
})(jQuery);
' . t('About') . '';
$output .= '' . t('The Menu module provides an interface for managing menus. A menu is a hierarchical collection of links, which can be within or external to the site, generally used for navigation. Each menu is rendered in a block that can be enabled and positioned through the Blocks administration page . You can view and manage menus on the Menus administration page . For more information, see the online handbook entry for the Menu module .', array('@blocks' => url('admin/structure/block'), '@menus' => url('admin/structure/menu'), '@menu' => 'http://drupal.org/documentation/modules/menu/')) . '
';
$output .= '' . t('Uses') . ' ';
$output .= '';
$output .= '' . t('Managing menus') . ' ';
$output .= '' . t('Users with the Administer menus and menu items permission can add, edit and delete custom menus on the Menus administration page . Custom menus can be special site menus, menus of external links, or any combination of internal and external links. You may create an unlimited number of additional menus, each of which will automatically have an associated block. By selecting list links , you can add, edit, or delete links for a given menu. The links listing page provides a drag-and-drop interface for controlling the order of links, and creating a hierarchy within the menu.', array('@menu' => url('admin/structure/menu'), '@add-menu' => url('admin/structure/menu/add'))) . ' ';
$output .= '' . t('Displaying menus') . ' ';
$output .= '' . t('After you have created a menu, you must enable and position the associated block on the Blocks administration page .', array('@blocks' => url('admin/structure/block'))) . ' ';
$output .= ' ';
return $output;
case 'admin/structure/menu/add':
return '' . t('You can enable the newly-created block for this menu on the Blocks administration page .', array('@blocks' => url('admin/structure/block'))) . '
';
}
if ($path == 'admin/structure/menu' && module_exists('block')) {
return '' . t('Each menu has a corresponding block that is managed on the Blocks administration page .', array('@blocks' => url('admin/structure/block'))) . '
';
}
}
/**
* Implements hook_permission().
*/
function menu_permission() {
return array(
'administer menu' => array(
'title' => t('Administer menus and menu items'),
),
);
}
/**
* Implements hook_menu().
*/
function menu_menu() {
$items['admin/structure/menu'] = array(
'title' => 'Menus',
'description' => 'Add new menus to your site, edit existing menus, and rename and reorganize menu links.',
'page callback' => 'menu_overview_page',
'access callback' => 'user_access',
'access arguments' => array('administer menu'),
'file' => 'menu.admin.inc',
);
$items['admin/structure/menu/parents'] = array(
'title' => 'Parent menu items',
'page callback' => 'menu_parent_options_js',
'type' => MENU_CALLBACK,
'access arguments' => array('administer menu'),
);
$items['admin/structure/menu/list'] = array(
'title' => 'List menus',
'type' => MENU_DEFAULT_LOCAL_TASK,
'weight' => -10,
);
$items['admin/structure/menu/add'] = array(
'title' => 'Add menu',
'page callback' => 'drupal_get_form',
'page arguments' => array('menu_edit_menu', 'add'),
'access arguments' => array('administer menu'),
'type' => MENU_LOCAL_ACTION,
'file' => 'menu.admin.inc',
);
$items['admin/structure/menu/settings'] = array(
'title' => 'Settings',
'page callback' => 'drupal_get_form',
'page arguments' => array('menu_configure'),
'access arguments' => array('administer menu'),
'type' => MENU_LOCAL_TASK,
'weight' => 5,
'file' => 'menu.admin.inc',
);
$items['admin/structure/menu/manage/%menu'] = array(
'title' => 'Customize menu',
'page callback' => 'drupal_get_form',
'page arguments' => array('menu_overview_form', 4),
'title callback' => 'menu_overview_title',
'title arguments' => array(4),
'access arguments' => array('administer menu'),
'file' => 'menu.admin.inc',
);
$items['admin/structure/menu/manage/%menu/list'] = array(
'title' => 'List links',
'weight' => -10,
'type' => MENU_DEFAULT_LOCAL_TASK,
'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
);
$items['admin/structure/menu/manage/%menu/add'] = array(
'title' => 'Add link',
'page callback' => 'drupal_get_form',
'page arguments' => array('menu_edit_item', 'add', NULL, 4),
'access arguments' => array('administer menu'),
'type' => MENU_LOCAL_ACTION,
'file' => 'menu.admin.inc',
);
$items['admin/structure/menu/manage/%menu/edit'] = array(
'title' => 'Edit menu',
'page callback' => 'drupal_get_form',
'page arguments' => array('menu_edit_menu', 'edit', 4),
'access arguments' => array('administer menu'),
'type' => MENU_LOCAL_TASK,
'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
'file' => 'menu.admin.inc',
);
$items['admin/structure/menu/manage/%menu/delete'] = array(
'title' => 'Delete menu',
'page callback' => 'menu_delete_menu_page',
'page arguments' => array(4),
'access arguments' => array('administer menu'),
'file' => 'menu.admin.inc',
);
$items['admin/structure/menu/item/%menu_link/edit'] = array(
'title' => 'Edit menu link',
'page callback' => 'drupal_get_form',
'page arguments' => array('menu_edit_item', 'edit', 4, NULL),
'access arguments' => array('administer menu'),
'file' => 'menu.admin.inc',
);
$items['admin/structure/menu/item/%menu_link/reset'] = array(
'title' => 'Reset menu link',
'page callback' => 'drupal_get_form',
'page arguments' => array('menu_reset_item_confirm', 4),
'access arguments' => array('administer menu'),
'file' => 'menu.admin.inc',
);
$items['admin/structure/menu/item/%menu_link/delete'] = array(
'title' => 'Delete menu link',
'page callback' => 'menu_item_delete_page',
'page arguments' => array(4),
'access arguments' => array('administer menu'),
'file' => 'menu.admin.inc',
);
return $items;
}
/**
* Implements hook_theme().
*/
function menu_theme() {
return array(
'menu_overview_form' => array(
'file' => 'menu.admin.inc',
'render element' => 'form',
),
'menu_admin_overview' => array(
'file' => 'menu.admin.inc',
'variables' => array('title' => NULL, 'name' => NULL, 'description' => NULL),
),
);
}
/**
* Implements hook_enable().
*
* Add a link for each custom menu.
*/
function menu_enable() {
menu_rebuild();
$base_link = db_query("SELECT mlid AS plid, menu_name FROM {menu_links} WHERE link_path = 'admin/structure/menu' AND module = 'system'")->fetchAssoc();
$base_link['router_path'] = 'admin/structure/menu/manage/%';
$base_link['module'] = 'menu';
$result = db_query("SELECT * FROM {menu_custom}", array(), array('fetch' => PDO::FETCH_ASSOC));
foreach ($result as $menu) {
// $link is passed by reference to menu_link_save(), so we make a copy of $base_link.
$link = $base_link;
$link['mlid'] = 0;
$link['link_title'] = $menu['title'];
$link['link_path'] = 'admin/structure/menu/manage/' . $menu['menu_name'];
$menu_link = db_query("SELECT mlid FROM {menu_links} WHERE link_path = :path AND plid = :plid", array(
':path' => $link['link_path'],
':plid' => $link['plid']
))
->fetchField();
if (!$menu_link) {
menu_link_save($link);
}
}
menu_cache_clear_all();
}
/**
* Title callback for the menu overview page and links.
*/
function menu_overview_title($menu) {
return $menu['title'];
}
/**
* Load the data for a single custom menu.
*
* @param $menu_name
* The unique name of a custom menu to load.
* @return
* Array defining the custom menu, or FALSE if the menu doesn't exist.
*/
function menu_load($menu_name) {
$all_menus = menu_load_all();
return isset($all_menus[$menu_name]) ? $all_menus[$menu_name] : FALSE;
}
/**
* Load all custom menu data.
*
* @return
* Array of custom menu data.
*/
function menu_load_all() {
$custom_menus = &drupal_static(__FUNCTION__);
if (!isset($custom_menus)) {
if ($cached = cache_get('menu_custom', 'cache_menu')) {
$custom_menus = $cached->data;
}
else {
$custom_menus = db_query('SELECT * FROM {menu_custom}')->fetchAllAssoc('menu_name', PDO::FETCH_ASSOC);
cache_set('menu_custom', $custom_menus, 'cache_menu');
}
}
return $custom_menus;
}
/**
* Save a custom menu.
*
* @param $menu
* An array representing a custom menu:
* - menu_name: The unique name of the custom menu (composed of lowercase
* letters, numbers, and hyphens).
* - title: The human readable menu title.
* - description: The custom menu description.
*
* Modules should always pass a fully populated $menu when saving a custom
* menu, so other modules are able to output proper status or watchdog messages.
*
* @see menu_load()
*/
function menu_save($menu) {
$status = db_merge('menu_custom')
->key(array('menu_name' => $menu['menu_name']))
->fields(array(
'title' => $menu['title'],
'description' => $menu['description'],
))
->execute();
menu_cache_clear_all();
switch ($status) {
case SAVED_NEW:
// Make sure the menu is present in the active menus variable so that its
// items may appear in the menu active trail.
// @see menu_set_active_menu_names()
$active_menus = variable_get('menu_default_active_menus', array_keys(menu_get_menus()));
if (!in_array($menu['menu_name'], $active_menus)) {
$active_menus[] = $menu['menu_name'];
variable_set('menu_default_active_menus', $active_menus);
}
module_invoke_all('menu_insert', $menu);
break;
case SAVED_UPDATED:
module_invoke_all('menu_update', $menu);
break;
}
}
/**
* Delete a custom menu and all contained links.
*
* Note that this function deletes all menu links in a custom menu. While menu
* links derived from router paths may be restored by rebuilding the menu, all
* customized and custom links will be irreversibly gone. Therefore, this
* function should usually be called from a user interface (form submit) handler
* only, which allows the user to confirm the action.
*
* @param $menu
* An array representing a custom menu:
* - menu_name: The unique name of the custom menu.
* - title: The human readable menu title.
* - description: The custom menu description.
*
* Modules should always pass a fully populated $menu when deleting a custom
* menu, so other modules are able to output proper status or watchdog messages.
*
* @see menu_load()
*
* menu_delete_links() will take care of clearing the page cache. Other modules
* should take care of their menu-related data by implementing
* hook_menu_delete().
*/
function menu_delete($menu) {
// Delete all links from the menu.
menu_delete_links($menu['menu_name']);
// Remove menu from active menus variable.
$active_menus = variable_get('menu_default_active_menus', array_keys(menu_get_menus()));
foreach ($active_menus as $i => $menu_name) {
if ($menu['menu_name'] == $menu_name) {
unset($active_menus[$i]);
variable_set('menu_default_active_menus', $active_menus);
}
}
// Delete the custom menu.
db_delete('menu_custom')
->condition('menu_name', $menu['menu_name'])
->execute();
menu_cache_clear_all();
module_invoke_all('menu_delete', $menu);
}
/**
* Return a list of menu items that are valid possible parents for the given menu item.
*
* @param $menus
* An array of menu names and titles, such as from menu_get_menus().
* @param $item
* The menu item or the node type for which to generate a list of parents.
* If $item['mlid'] == 0 then the complete tree is returned.
* @param $type
* The node type for which to generate a list of parents.
* If $item itself is a node type then $type is ignored.
* @return
* An array of menu link titles keyed on the a string containing the menu name
* and mlid. The list excludes the given item and its children.
*
* @todo This has to be turned into a #process form element callback. The
* 'menu_override_parent_selector' variable is entirely superfluous.
*/
function menu_parent_options($menus, $item, $type = '') {
// The menu_links table can be practically any size and we need a way to
// allow contrib modules to provide more scalable pattern choosers.
// hook_form_alter is too late in itself because all the possible parents are
// retrieved here, unless menu_override_parent_selector is set to TRUE.
if (variable_get('menu_override_parent_selector', FALSE)) {
return array();
}
$available_menus = array();
if (!is_array($item)) {
// If $item is not an array then it is a node type.
// Use it as $type and prepare a dummy menu item for _menu_get_options().
$type = $item;
$item = array('mlid' => 0);
}
if (empty($type)) {
// If no node type is set, use all menus given to this function.
$available_menus = $menus;
}
else {
// If a node type is set, use all available menus for this type.
$type_menus = variable_get('menu_options_' . $type, array('main-menu' => 'main-menu'));
foreach ($type_menus as $menu) {
$available_menus[$menu] = $menu;
}
}
return _menu_get_options($menus, $available_menus, $item);
}
/**
* Page callback.
* Get all the available menus and menu items as a JavaScript array.
*/
function menu_parent_options_js() {
$available_menus = array();
if (isset($_POST['menus']) && count($_POST['menus'])) {
foreach ($_POST['menus'] as $menu) {
$available_menus[$menu] = $menu;
}
}
$options = _menu_get_options(menu_get_menus(), $available_menus, array('mlid' => 0));
drupal_json_output($options);
}
/**
* Helper function to get the items of the given menu.
*/
function _menu_get_options($menus, $available_menus, $item) {
global $menu_admin;
$menu_admin = TRUE;
// If the item has children, there is an added limit to the depth of valid parents.
if (isset($item['parent_depth_limit'])) {
$limit = $item['parent_depth_limit'];
}
else {
$limit = _menu_parent_depth_limit($item);
}
$options = array();
foreach ($menus as $menu_name => $title) {
if (isset($available_menus[$menu_name])) {
$tree = menu_tree_all_data($menu_name, NULL);
$options[$menu_name . ':0'] = '<' . $title . '>';
_menu_parents_recurse($tree, $menu_name, '--', $options, $item['mlid'], $limit);
}
}
$menu_admin = FALSE;
return $options;
}
/**
* Recursive helper function for menu_parent_options().
*/
function _menu_parents_recurse($tree, $menu_name, $indent, &$options, $exclude, $depth_limit) {
foreach ($tree as $data) {
if ($data['link']['depth'] > $depth_limit) {
// Don't iterate through any links on this level.
break;
}
if ($data['link']['mlid'] != $exclude && $data['link']['hidden'] >= 0) {
$title = $indent . ' ' . truncate_utf8($data['link']['title'], 30, TRUE, FALSE);
menu_add_link_labels($title, $data['link']);
$options[$menu_name . ':' . $data['link']['mlid']] = $title;
if ($data['below']) {
_menu_parents_recurse($data['below'], $menu_name, $indent . '--', $options, $exclude, $depth_limit);
}
}
}
}
/**
* Adds labels to the title of a hidden, unpublished or logged-in menu link.
*
* @param string $title
* The title of the menu link. This will be modified as necessary to add the
* appropriate label in parentheses at the end.
* @param array $item
* An array representing the menu link item.
*/
function menu_add_link_labels(&$title, $item) {
if ($item['hidden']) {
$title .= ' (' . t('disabled') . ')';
}
elseif (!empty($item['node_unpublished'])) {
$title .= ' (' . t('unpublished') . ')';
}
elseif ($item['link_path'] == 'user' && $item['module'] == 'system') {
$title .= ' (' . t('logged in users only') . ')';
}
}
/**
* Reset a system-defined menu link.
*/
function menu_reset_item($link) {
// To reset the link to its original values, we need to retrieve its
// definition from hook_menu(). Otherwise, for example, the link's menu would
// not be reset, because properties like the original 'menu_name' are not
// stored anywhere else. Since resetting a link happens rarely and this is a
// one-time operation, retrieving the full menu router does no harm.
$menu = menu_get_router();
$router_item = $menu[$link['router_path']];
$new_link = _menu_link_build($router_item);
// Merge existing menu link's ID and 'has_children' property.
foreach (array('mlid', 'has_children') as $key) {
$new_link[$key] = $link[$key];
}
menu_link_save($new_link);
return $new_link;
}
/**
* Implements hook_block_info().
*/
function menu_block_info() {
$menus = menu_get_menus(FALSE);
$blocks = array();
foreach ($menus as $name => $title) {
$blocks[$name]['info'] = check_plain($title);
// Menu blocks can't be cached because each menu item can have
// a custom access callback. menu.inc manages its own caching.
$blocks[$name]['cache'] = DRUPAL_NO_CACHE;
}
return $blocks;
}
/**
* Implements hook_block_view().
*/
function menu_block_view($delta = '') {
$menus = menu_get_menus(FALSE);
$data['subject'] = check_plain($menus[$delta]);
$data['content'] = menu_tree($delta);
// Add contextual links for this block.
if (!empty($data['content'])) {
$data['content']['#contextual_links']['menu'] = array('admin/structure/menu/manage', array($delta));
}
return $data;
}
/**
* Implements hook_block_view_alter().
*/
function menu_block_view_alter(&$data, $block) {
// Add contextual links for system menu blocks.
if ($block->module == 'system' && !empty($data['content'])) {
$system_menus = menu_list_system_menus();
if (isset($system_menus[$block->delta])) {
$data['content']['#contextual_links']['menu'] = array('admin/structure/menu/manage', array($block->delta));
}
}
}
/**
* Implements hook_node_insert().
*/
function menu_node_insert($node) {
menu_node_save($node);
}
/**
* Implements hook_node_update().
*/
function menu_node_update($node) {
menu_node_save($node);
}
/**
* Helper for hook_node_insert() and hook_node_update().
*/
function menu_node_save($node) {
if (isset($node->menu)) {
$link = &$node->menu;
if (empty($link['enabled'])) {
if (!empty($link['mlid'])) {
menu_link_delete($link['mlid']);
}
}
elseif (trim($link['link_title'])) {
$link['link_title'] = trim($link['link_title']);
$link['link_path'] = "node/$node->nid";
if (trim($link['description'])) {
$link['options']['attributes']['title'] = trim($link['description']);
}
else {
// If the description field was left empty, remove the title attribute
// from the menu link.
unset($link['options']['attributes']['title']);
}
if (!menu_link_save($link)) {
drupal_set_message(t('There was an error saving the menu link.'), 'error');
}
}
}
}
/**
* Implements hook_node_delete().
*/
function menu_node_delete($node) {
// Delete all menu module links that point to this node.
$result = db_query("SELECT mlid FROM {menu_links} WHERE link_path = :path AND module = 'menu'", array(':path' => 'node/' . $node->nid), array('fetch' => PDO::FETCH_ASSOC));
foreach ($result as $m) {
menu_link_delete($m['mlid']);
}
}
/**
* Implements hook_node_prepare().
*/
function menu_node_prepare($node) {
if (empty($node->menu)) {
// Prepare the node for the edit form so that $node->menu always exists.
$menu_name = strtok(variable_get('menu_parent_' . $node->type, 'main-menu:0'), ':');
$item = array();
if (isset($node->nid)) {
$mlid = FALSE;
// Give priority to the default menu
$type_menus = variable_get('menu_options_' . $node->type, array('main-menu' => 'main-menu'));
if (in_array($menu_name, $type_menus)) {
$mlid = db_query_range("SELECT mlid FROM {menu_links} WHERE link_path = :path AND menu_name = :menu_name AND module = 'menu' ORDER BY mlid ASC", 0, 1, array(
':path' => 'node/' . $node->nid,
':menu_name' => $menu_name,
))->fetchField();
}
// Check all allowed menus if a link does not exist in the default menu.
if (!$mlid && !empty($type_menus)) {
$mlid = db_query_range("SELECT mlid FROM {menu_links} WHERE link_path = :path AND module = 'menu' AND menu_name IN (:type_menus) ORDER BY mlid ASC", 0, 1, array(
':path' => 'node/' . $node->nid,
':type_menus' => array_values($type_menus),
))->fetchField();
}
if ($mlid) {
$item = menu_link_load($mlid);
}
}
// Set default values.
$node->menu = $item + array(
'link_title' => '',
'mlid' => 0,
'plid' => 0,
'menu_name' => $menu_name,
'weight' => 0,
'options' => array(),
'module' => 'menu',
'expanded' => 0,
'hidden' => 0,
'has_children' => 0,
'customized' => 0,
);
}
// Find the depth limit for the parent select.
if (!isset($node->menu['parent_depth_limit'])) {
$node->menu['parent_depth_limit'] = _menu_parent_depth_limit($node->menu);
}
}
/**
* Find the depth limit for items in the parent select.
*/
function _menu_parent_depth_limit($item) {
return MENU_MAX_DEPTH - 1 - (($item['mlid'] && $item['has_children']) ? menu_link_children_relative_depth($item) : 0);
}
/**
* Calculate the delta for the weight element for a given set of menus.
*
* @param string|array $menu_names
* Menu name or an array of menu names.
* @param int $max_delta
* Optional maximum value.
*
* @return int
* Delta value.
*/
function _menu_get_menu_weight_delta($menu_names, $max_delta = NULL) {
if (is_string($menu_names)) {
$menu_names = array($menu_names);
}
$weight_info = db_query("SELECT MAX(weight) AS max_weight, MIN(weight) as min_weight FROM {menu_links} WHERE menu_name IN (:menu_names)", array(':menu_names' => $menu_names))->fetchObject();
$delta = max(abs((int) $weight_info->min_weight), abs((int) $weight_info->max_weight)) + 1;
// Honor max param, if given.
if (!is_null($max_delta) && $delta > $max_delta) {
$delta = $max_delta;
}
// Provide a minimum.
if ($delta < 50) {
$delta = 50;
}
return $delta;
}
/**
* Implements hook_form_BASE_FORM_ID_alter().
*
* Adds menu item fields to the node form.
*
* @see menu_node_submit()
*/
function menu_form_node_form_alter(&$form, $form_state) {
// Generate a list of possible parents (not including this link or descendants).
// @todo This must be handled in a #process handler.
$link = $form['#node']->menu;
$type = $form['#node']->type;
// menu_parent_options() is goofy and can actually handle either a menu link
// or a node type both as second argument. Pick based on whether there is
// a link already (menu_node_prepare() sets mlid default to 0).
$options = menu_parent_options(menu_get_menus(), $link['mlid'] ? $link : $type, $type);
// If no possible parent menu items were found, there is nothing to display.
if (empty($options)) {
return;
}
$form['menu'] = array(
'#type' => 'fieldset',
'#title' => t('Menu settings'),
'#access' => user_access('administer menu'),
'#collapsible' => TRUE,
'#collapsed' => !$link['link_title'],
'#group' => 'additional_settings',
'#attached' => array(
'js' => array(drupal_get_path('module', 'menu') . '/menu.js'),
),
'#tree' => TRUE,
'#weight' => -2,
'#attributes' => array('class' => array('menu-link-form')),
);
$form['menu']['enabled'] = array(
'#type' => 'checkbox',
'#title' => t('Provide a menu link'),
'#default_value' => (int) (bool) $link['mlid'],
);
$form['menu']['link'] = array(
'#type' => 'container',
'#parents' => array('menu'),
'#states' => array(
'invisible' => array(
'input[name="menu[enabled]"]' => array('checked' => FALSE),
),
),
);
// Populate the element with the link data.
foreach (array('mlid', 'module', 'hidden', 'has_children', 'customized', 'options', 'expanded', 'hidden', 'parent_depth_limit') as $key) {
$form['menu']['link'][$key] = array('#type' => 'value', '#value' => $link[$key]);
}
$form['menu']['link']['link_title'] = array(
'#type' => 'textfield',
'#title' => t('Menu link title'),
'#maxlength' => 255,
'#default_value' => $link['link_title'],
);
$form['menu']['link']['description'] = array(
'#type' => 'textarea',
'#title' => t('Description'),
'#default_value' => isset($link['options']['attributes']['title']) ? $link['options']['attributes']['title'] : '',
'#rows' => 1,
'#description' => t('Shown when hovering over the menu link.'),
);
$default = ($link['mlid'] ? $link['menu_name'] . ':' . $link['plid'] : variable_get('menu_parent_' . $type, 'main-menu:0'));
// If the current parent menu item is not present in options, use the first
// available option as default value.
// @todo User should not be allowed to access menu link settings in such a
// case.
if (!isset($options[$default])) {
$array = array_keys($options);
$default = reset($array);
}
$form['menu']['link']['parent'] = array(
'#type' => 'select',
'#title' => t('Parent item'),
'#default_value' => $default,
'#options' => $options,
'#attributes' => array('class' => array('menu-parent-select')),
);
// Get number of items in all possible parent menus so the weight selector is
// sized appropriately.
$menu_names = array_keys(menu_get_menus());
$menu_options = array();
foreach ($menu_names as $menu_name) {
if (isset($options[$menu_name . ':0'])) {
$menu_options[] = $menu_name;
}
}
// Make sure that we always have values in menu_options.
$menu_options = !empty($menu_options) ? $menu_options : $menu_names;
$form['menu']['link']['weight'] = array(
'#type' => 'weight',
'#title' => t('Weight'),
'#delta' => _menu_get_menu_weight_delta($menu_options),
'#default_value' => $link['weight'],
'#description' => t('Menu links with smaller weights are displayed before links with larger weights.'),
);
}
/**
* Implements hook_node_submit().
*
* @see menu_form_node_form_alter()
*/
function menu_node_submit($node, $form, $form_state) {
// Decompose the selected menu parent option into 'menu_name' and 'plid', if
// the form used the default parent selection widget.
if (!empty($form_state['values']['menu']['parent'])) {
list($node->menu['menu_name'], $node->menu['plid']) = explode(':', $form_state['values']['menu']['parent']);
}
}
/**
* Implements hook_form_FORM_ID_alter().
*
* Adds menu options to the node type form.
*/
function menu_form_node_type_form_alter(&$form, $form_state) {
$menu_options = menu_get_menus();
$type = $form['#node_type'];
$form['menu'] = array(
'#type' => 'fieldset',
'#title' => t('Menu settings'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#attached' => array(
'js' => array(drupal_get_path('module', 'menu') . '/menu.admin.js'),
),
'#group' => 'additional_settings',
);
$form['menu']['menu_options'] = array(
'#type' => 'checkboxes',
'#title' => t('Available menus'),
'#default_value' => variable_get('menu_options_' . $type->type, array('main-menu')),
'#options' => $menu_options,
'#description' => t('The menus available to place links in for this content type.'),
);
// To avoid an 'illegal option' error after saving the form we have to load
// all available menu items.
// Otherwise it is not possible to dynamically add options to the list.
// @todo Convert menu_parent_options() into a #process callback.
$options = menu_parent_options(menu_get_menus(), array('mlid' => 0));
$form['menu']['menu_parent'] = array(
'#type' => 'select',
'#title' => t('Default parent item'),
'#default_value' => variable_get('menu_parent_' . $type->type, 'main-menu:0'),
'#options' => $options,
'#description' => t('Choose the menu item to be the default parent for a new link in the content authoring form.'),
'#attributes' => array('class' => array('menu-title-select')),
);
// Call Drupal.menu_update_parent_list() to filter the list of
// available default parent menu items based on the selected menus.
drupal_add_js(
'(function ($) { Drupal.menu_update_parent_list(); })(jQuery);',
array('scope' => 'footer', 'type' => 'inline')
);
}
/**
* Return an associative array of the custom menus names.
*
* @param $all
* If FALSE return only user-added menus, or if TRUE also include
* the menus defined by the system.
* @return
* An array with the machine-readable names as the keys, and human-readable
* titles as the values.
*/
function menu_get_menus($all = TRUE) {
if ($custom_menus = menu_load_all()) {
if (!$all) {
$custom_menus = array_diff_key($custom_menus, menu_list_system_menus());
}
foreach ($custom_menus as $menu_name => $menu) {
$custom_menus[$menu_name] = t($menu['title']);
}
asort($custom_menus);
}
return $custom_menus;
}
'Menu link creation/deletion',
'description' => 'Add a custom menu, add menu links to the custom menu and Navigation menu, check their data, and delete them using the menu module UI.',
'group' => 'Menu'
);
}
function setUp() {
parent::setUp('menu');
// Create users.
$this->big_user = $this->drupalCreateUser(array('access administration pages', 'administer blocks', 'administer menu', 'create article content'));
$this->std_user = $this->drupalCreateUser(array());
}
/**
* Login users, add menus and menu links, and test menu functionality through the admin and user interfaces.
*/
function testMenu() {
// Login the user.
$this->drupalLogin($this->big_user);
$this->items = array();
// Do standard menu tests.
$this->doStandardMenuTests();
// Do custom menu tests.
$this->doCustomMenuTests();
// Do standard user tests.
// Login the user.
$this->drupalLogin($this->std_user);
$this->verifyAccess(403);
foreach ($this->items as $item) {
$node = node_load(substr($item['link_path'], 5)); // Paths were set as 'node/$nid'.
$this->verifyMenuLink($item, $node);
}
// Login the user.
$this->drupalLogin($this->big_user);
// Delete menu links.
foreach ($this->items as $item) {
$this->deleteMenuLink($item);
}
// Delete custom menu.
$this->deleteCustomMenu($this->menu);
// Modify and reset a standard menu link.
$item = $this->getStandardMenuLink();
$old_title = $item['link_title'];
$this->modifyMenuLink($item);
$item = menu_link_load($item['mlid']);
// Verify that a change to the description is saved.
$description = $this->randomName(16);
$item['options']['attributes']['title'] = $description;
menu_link_save($item);
$saved_item = menu_link_load($item['mlid']);
$this->assertEqual($description, $saved_item['options']['attributes']['title'], 'Saving an existing link updates the description (title attribute)');
$this->resetMenuLink($item, $old_title);
// Test that the page title is correct when a local task appears in a
// top-level menu item. See https://www.drupal.org/node/1973262.
$item = $this->addMenuLink(0, 'user/register', 'user-menu');
$this->drupalGet('user/password');
$this->assertNoTitle('Home | Drupal');
$this->drupalLogout();
$this->drupalGet('user/register');
$this->assertTitle($item['link_title'] . ' | Drupal');
$this->drupalGet('user');
$this->assertNoTitle('Home | Drupal');
}
/**
* Test standard menu functionality using navigation menu.
*
*/
function doStandardMenuTests() {
$this->doMenuTests();
$this->addInvalidMenuLink();
}
/**
* Test custom menu functionality using navigation menu.
*
*/
function doCustomMenuTests() {
$this->menu = $this->addCustomMenu();
$this->doMenuTests($this->menu['menu_name']);
$this->addInvalidMenuLink($this->menu['menu_name']);
$this->addCustomMenuCRUD();
}
/**
* Add custom menu using CRUD functions.
*/
function addCustomMenuCRUD() {
// Add a new custom menu.
$menu_name = substr(hash('sha256', $this->randomName(16)), 0, MENU_MAX_MENU_NAME_LENGTH_UI);
$title = $this->randomName(16);
$menu = array(
'menu_name' => $menu_name,
'title' => $title,
'description' => 'Description text',
);
menu_save($menu);
// Assert the new menu.
$this->drupalGet('admin/structure/menu/manage/' . $menu_name . '/edit');
$this->assertRaw($title, 'Custom menu was added.');
// Edit the menu.
$new_title = $this->randomName(16);
$menu['title'] = $new_title;
menu_save($menu);
$this->drupalGet('admin/structure/menu/manage/' . $menu_name . '/edit');
$this->assertRaw($new_title, 'Custom menu was edited.');
}
/**
* Add custom menu.
*/
function addCustomMenu() {
// Add custom menu.
// Try adding a menu using a menu_name that is too long.
$this->drupalGet('admin/structure/menu/add');
$menu_name = substr(hash('sha256', $this->randomName(16)), 0, MENU_MAX_MENU_NAME_LENGTH_UI + 1);
$title = $this->randomName(16);
$edit = array(
'menu_name' => $menu_name,
'description' => '',
'title' => $title,
);
$this->drupalPost('admin/structure/menu/add', $edit, t('Save'));
// Verify that using a menu_name that is too long results in a validation message.
$this->assertRaw(t('!name cannot be longer than %max characters but is currently %length characters long.', array(
'!name' => t('Menu name'),
'%max' => MENU_MAX_MENU_NAME_LENGTH_UI,
'%length' => drupal_strlen($menu_name),
)));
// Change the menu_name so it no longer exceeds the maximum length.
$menu_name = substr(hash('sha256', $this->randomName(16)), 0, MENU_MAX_MENU_NAME_LENGTH_UI);
$edit['menu_name'] = $menu_name;
$this->drupalPost('admin/structure/menu/add', $edit, t('Save'));
// Verify that no validation error is given for menu_name length.
$this->assertNoRaw(t('!name cannot be longer than %max characters but is currently %length characters long.', array(
'!name' => t('Menu name'),
'%max' => MENU_MAX_MENU_NAME_LENGTH_UI,
'%length' => drupal_strlen($menu_name),
)));
// Unlike most other modules, there is no confirmation message displayed.
$this->drupalGet('admin/structure/menu');
$this->assertText($title, 'Menu created');
// Enable the custom menu block.
$menu_name = 'menu-' . $menu_name; // Drupal prepends the name with 'menu-'.
$edit = array();
$edit['blocks[menu_' . $menu_name . '][region]'] = 'sidebar_first';
$this->drupalPost('admin/structure/block', $edit, t('Save blocks'));
$this->assertResponse(200);
$this->assertText(t('The block settings have been updated.'), 'Custom menu block was enabled');
return menu_load($menu_name);
}
/**
* Delete custom menu.
*
* @param string $menu_name Custom menu name.
*/
function deleteCustomMenu($menu) {
$menu_name = $this->menu['menu_name'];
$title = $this->menu['title'];
// Delete custom menu.
$this->drupalPost("admin/structure/menu/manage/$menu_name/delete", array(), t('Delete'));
$this->assertResponse(200);
$this->assertRaw(t('The custom menu %title has been deleted.', array('%title' => $title)), 'Custom menu was deleted');
$this->assertFalse(menu_load($menu_name), 'Custom menu was deleted');
// Test if all menu links associated to the menu were removed from database.
$result = db_query("SELECT menu_name FROM {menu_links} WHERE menu_name = :menu_name", array(':menu_name' => $menu_name))->fetchField();
$this->assertFalse($result, 'All menu links associated to the custom menu were deleted.');
}
/**
* Test menu functionality using navigation menu.
*
*/
function doMenuTests($menu_name = 'navigation') {
// Add nodes to use as links for menu links.
$node1 = $this->drupalCreateNode(array('type' => 'article'));
$node2 = $this->drupalCreateNode(array('type' => 'article'));
$node3 = $this->drupalCreateNode(array('type' => 'article'));
$node4 = $this->drupalCreateNode(array('type' => 'article'));
$node5 = $this->drupalCreateNode(array('type' => 'article'));
// Add menu links.
$item1 = $this->addMenuLink(0, 'node/' . $node1->nid, $menu_name);
$item2 = $this->addMenuLink($item1['mlid'], 'node/' . $node2->nid, $menu_name, FALSE);
$item3 = $this->addMenuLink($item2['mlid'], 'node/' . $node3->nid, $menu_name);
$this->assertMenuLink($item1['mlid'], array('depth' => 1, 'has_children' => 1, 'p1' => $item1['mlid'], 'p2' => 0));
$this->assertMenuLink($item2['mlid'], array('depth' => 2, 'has_children' => 1, 'p1' => $item1['mlid'], 'p2' => $item2['mlid'], 'p3' => 0));
$this->assertMenuLink($item3['mlid'], array('depth' => 3, 'has_children' => 0, 'p1' => $item1['mlid'], 'p2' => $item2['mlid'], 'p3' => $item3['mlid'], 'p4' => 0));
// Add 102 menu links with increasing weights, then make sure the last-added
// item's weight doesn't get changed because of the old hardcoded delta = 50
$items = array();
for ($i = -50; $i <= 51; $i++) {
$items[$i] = $this->addMenuLink(0, 'node/' . $node1->nid, $menu_name, TRUE, strval($i));
}
$this->assertMenuLink($items[51]['mlid'], array('weight' => '51'));
// Verify menu links.
$this->verifyMenuLink($item1, $node1);
$this->verifyMenuLink($item2, $node2, $item1, $node1);
$this->verifyMenuLink($item3, $node3, $item2, $node2);
// Add more menu links.
$item4 = $this->addMenuLink(0, 'node/' . $node4->nid, $menu_name);
$item5 = $this->addMenuLink($item4['mlid'], 'node/' . $node5->nid, $menu_name);
$this->assertMenuLink($item4['mlid'], array('depth' => 1, 'has_children' => 1, 'p1' => $item4['mlid'], 'p2' => 0));
$this->assertMenuLink($item5['mlid'], array('depth' => 2, 'has_children' => 0, 'p1' => $item4['mlid'], 'p2' => $item5['mlid'], 'p3' => 0));
// Modify menu links.
$this->modifyMenuLink($item1);
$this->modifyMenuLink($item2);
// Toggle menu links.
$this->toggleMenuLink($item1);
$this->toggleMenuLink($item2);
// Move link and verify that descendants are updated.
$this->moveMenuLink($item2, $item5['mlid'], $menu_name);
$this->assertMenuLink($item1['mlid'], array('depth' => 1, 'has_children' => 0, 'p1' => $item1['mlid'], 'p2' => 0));
$this->assertMenuLink($item4['mlid'], array('depth' => 1, 'has_children' => 1, 'p1' => $item4['mlid'], 'p2' => 0));
$this->assertMenuLink($item5['mlid'], array('depth' => 2, 'has_children' => 1, 'p1' => $item4['mlid'], 'p2' => $item5['mlid'], 'p3' => 0));
$this->assertMenuLink($item2['mlid'], array('depth' => 3, 'has_children' => 1, 'p1' => $item4['mlid'], 'p2' => $item5['mlid'], 'p3' => $item2['mlid'], 'p4' => 0));
$this->assertMenuLink($item3['mlid'], array('depth' => 4, 'has_children' => 0, 'p1' => $item4['mlid'], 'p2' => $item5['mlid'], 'p3' => $item2['mlid'], 'p4' => $item3['mlid'], 'p5' => 0));
// Enable a link via the overview form.
$this->disableMenuLink($item1);
$edit = array();
// Note in the UI the 'mlid:x[hidden]' form element maps to enabled, or
// NOT hidden.
$edit['mlid:' . $item1['mlid'] . '[hidden]'] = TRUE;
$this->drupalPost('admin/structure/menu/manage/' . $item1['menu_name'], $edit, t('Save configuration'));
// Verify in the database.
$this->assertMenuLink($item1['mlid'], array('hidden' => 0));
// Save menu links for later tests.
$this->items[] = $item1;
$this->items[] = $item2;
}
/**
* Add and remove a menu link with a query string and fragment.
*/
function testMenuQueryAndFragment() {
$this->drupalLogin($this->big_user);
// Make a path with query and fragment on.
$path = 'node?arg1=value1&arg2=value2';
$item = $this->addMenuLink(0, $path);
$this->drupalGet('admin/structure/menu/item/' . $item['mlid'] . '/edit');
$this->assertFieldByName('link_path', $path, 'Path is found with both query and fragment.');
// Now change the path to something without query and fragment.
$path = 'node';
$this->drupalPost('admin/structure/menu/item/' . $item['mlid'] . '/edit', array('link_path' => $path), t('Save'));
$this->drupalGet('admin/structure/menu/item/' . $item['mlid'] . '/edit');
$this->assertFieldByName('link_path', $path, 'Path no longer has query or fragment.');
}
/**
* Tries to use the navigation menu as the source for secondary links.
*/
function testNavigationAsSecondaryMenu() {
$this->drupalLogin($this->big_user);
// Go to the menu settings page and make the navigation the source for the
// secondary menu.
$edit = array(
'menu_main_links_source' => 'main-menu',
'menu_secondary_links_source' => 'navigation',
);
$this->drupalGet('admin/structure/menu/settings');
$this->drupalPost(NULL, $edit, t('Save configuration'));
// Now visit the user page. There should be an 'Add content' link in the
// navigation block and one in the secondary menu.
$this->drupalGet('user');
$this->assertNoUniqueText(t('Add content'));
}
/**
* Add a menu link using the menu module UI.
*
* @param integer $plid Parent menu link id.
* @param string $link Link path.
* @param string $menu_name Menu name.
* @param string $weight Menu link weight
* @return array Menu link created.
*/
function addMenuLink($plid = 0, $link = '', $menu_name = 'navigation', $expanded = TRUE, $weight = '0') {
// View add menu link page.
$this->drupalGet("admin/structure/menu/manage/$menu_name/add");
$this->assertResponse(200);
$title = '!link_' . $this->randomName(16);
$edit = array(
'link_path' => $link,
'link_title' => $title,
'description' => '',
'enabled' => TRUE, // Use this to disable the menu and test.
'expanded' => $expanded, // Setting this to true should test whether it works when we do the std_user tests.
'parent' => $menu_name . ':' . $plid,
'weight' => $weight,
);
// Add menu link.
$this->drupalPost(NULL, $edit, t('Save'));
$this->assertResponse(200);
// Unlike most other modules, there is no confirmation message displayed.
$this->assertText($title, 'Menu link was added');
$item = db_query('SELECT * FROM {menu_links} WHERE link_title = :title', array(':title' => $title))->fetchAssoc();
$this->assertTrue(t('Menu link was found in database.'));
$this->assertMenuLink($item['mlid'], array('menu_name' => $menu_name, 'link_path' => $link, 'has_children' => 0, 'plid' => $plid));
return $item;
}
/**
* Attempt to add menu link with invalid path or no access permission.
*
* @param string $menu_name Menu name.
*/
function addInvalidMenuLink($menu_name = 'navigation') {
foreach (array('-&-', 'admin/people/permissions', '#') as $link_path) {
$edit = array(
'link_path' => $link_path,
'link_title' => 'title',
);
$this->drupalPost("admin/structure/menu/manage/$menu_name/add", $edit, t('Save'));
$this->assertRaw(t("The path '@path' is either invalid or you do not have access to it.", array('@path' => $link_path)), 'Menu link was not created');
}
}
/**
* Verify a menu link using the menu module UI.
*
* @param array $item Menu link.
* @param object $item_node Menu link content node.
* @param array $parent Parent menu link.
* @param object $parent_node Parent menu link content node.
*/
function verifyMenuLink($item, $item_node, $parent = NULL, $parent_node = NULL) {
// View home page.
$this->drupalGet('');
$this->assertResponse(200);
// Verify parent menu link.
if (isset($parent)) {
// Verify menu link.
$title = $parent['link_title'];
$this->assertLink($title, 0, 'Parent menu link was displayed');
// Verify menu link link.
$this->clickLink($title);
$title = $parent_node->title;
$this->assertTitle(t("@title | Drupal", array('@title' => $title)), 'Parent menu link link target was correct');
}
// Verify menu link.
$title = $item['link_title'];
$this->assertLink($title, 0, 'Menu link was displayed');
// Verify menu link link.
$this->clickLink($title);
$title = $item_node->title;
$this->assertTitle(t("@title | Drupal", array('@title' => $title)), 'Menu link link target was correct');
}
/**
* Change the parent of a menu link using the menu module UI.
*/
function moveMenuLink($item, $plid, $menu_name) {
$mlid = $item['mlid'];
$edit = array(
'parent' => $menu_name . ':' . $plid,
);
$this->drupalPost("admin/structure/menu/item/$mlid/edit", $edit, t('Save'));
$this->assertResponse(200);
}
/**
* Modify a menu link using the menu module UI.
*
* @param array $item Menu link passed by reference.
*/
function modifyMenuLink(&$item) {
$item['link_title'] = $this->randomName(16);
$mlid = $item['mlid'];
$title = $item['link_title'];
// Edit menu link.
$edit = array();
$edit['link_title'] = $title;
$this->drupalPost("admin/structure/menu/item/$mlid/edit", $edit, t('Save'));
$this->assertResponse(200);
// Unlike most other modules, there is no confirmation message displayed.
// Verify menu link.
$this->drupalGet('admin/structure/menu/manage/' . $item['menu_name']);
$this->assertText($title, 'Menu link was edited');
}
/**
* Reset a standard menu link using the menu module UI.
*
* @param array $item Menu link.
* @param string $old_title Original title for menu link.
*/
function resetMenuLink($item, $old_title) {
$mlid = $item['mlid'];
$title = $item['link_title'];
// Reset menu link.
$this->drupalPost("admin/structure/menu/item/$mlid/reset", array(), t('Reset'));
$this->assertResponse(200);
$this->assertRaw(t('The menu link was reset to its default settings.'), 'Menu link was reset');
// Verify menu link.
$this->drupalGet('');
$this->assertNoText($title, 'Menu link was reset');
$this->assertText($old_title, 'Menu link was reset');
}
/**
* Delete a menu link using the menu module UI.
*
* @param array $item Menu link.
*/
function deleteMenuLink($item) {
$mlid = $item['mlid'];
$title = $item['link_title'];
// Delete menu link.
$this->drupalPost("admin/structure/menu/item/$mlid/delete", array(), t('Confirm'));
$this->assertResponse(200);
$this->assertRaw(t('The menu link %title has been deleted.', array('%title' => $title)), 'Menu link was deleted');
// Verify deletion.
$this->drupalGet('');
$this->assertNoText($title, 'Menu link was deleted');
}
/**
* Alternately disable and enable a menu link.
*
* @param $item
* Menu link.
*/
function toggleMenuLink($item) {
$this->disableMenuLink($item);
// Verify menu link is absent.
$this->drupalGet('');
$this->assertNoText($item['link_title'], 'Menu link was not displayed');
$this->enableMenuLink($item);
// Verify menu link is displayed.
$this->drupalGet('');
$this->assertText($item['link_title'], 'Menu link was displayed');
}
/**
* Disable a menu link.
*
* @param $item
* Menu link.
*/
function disableMenuLink($item) {
$mlid = $item['mlid'];
$edit['enabled'] = FALSE;
$this->drupalPost("admin/structure/menu/item/$mlid/edit", $edit, t('Save'));
// Unlike most other modules, there is no confirmation message displayed.
// Verify in the database.
$this->assertMenuLink($mlid, array('hidden' => 1));
}
/**
* Enable a menu link.
*
* @param $item
* Menu link.
*/
function enableMenuLink($item) {
$mlid = $item['mlid'];
$edit['enabled'] = TRUE;
$this->drupalPost("admin/structure/menu/item/$mlid/edit", $edit, t('Save'));
// Verify in the database.
$this->assertMenuLink($mlid, array('hidden' => 0));
}
/**
* Fetch the menu item from the database and compare it to the specified
* array.
*
* @param $mlid
* Menu item id.
* @param $item
* Array containing properties to verify.
*/
function assertMenuLink($mlid, array $expected_item) {
// Retrieve menu link.
$item = db_query('SELECT * FROM {menu_links} WHERE mlid = :mlid', array(':mlid' => $mlid))->fetchAssoc();
$options = unserialize($item['options']);
if (!empty($options['query'])) {
$item['link_path'] .= '?' . drupal_http_build_query($options['query']);
}
if (!empty($options['fragment'])) {
$item['link_path'] .= '#' . $options['fragment'];
}
foreach ($expected_item as $key => $value) {
$this->assertEqual($item[$key], $value, format_string('Parameter %key had expected value.', array('%key' => $key)));
}
}
/**
* Test administrative users other than user 1 can access the menu parents AJAX callback.
*/
public function testMenuParentsJsAccess() {
$admin = $this->drupalCreateUser(array('administer menu'));
$this->drupalLogin($admin);
// Just check access to the callback overall, the POST data is irrelevant.
$this->drupalGetAJAX('admin/structure/menu/parents');
$this->assertResponse(200);
// Do standard user tests.
// Login the user.
$this->drupalLogin($this->std_user);
$this->drupalGetAJAX('admin/structure/menu/parents');
$this->assertResponse(403);
}
/**
* Get standard menu link.
*/
private function getStandardMenuLink() {
// Retrieve menu link id of the Log out menu link, which will always be on the front page.
$mlid = db_query("SELECT mlid FROM {menu_links} WHERE module = 'system' AND router_path = 'user/logout'")->fetchField();
$this->assertTrue($mlid > 0, 'Standard menu link id was found');
// Load menu link.
// Use api function so that link is translated for rendering.
$item = menu_link_load($mlid);
$this->assertTrue((bool) $item, 'Standard menu link was loaded');
return $item;
}
/**
* Verify the logged in user has the desired access to the various menu nodes.
*
* @param integer $response HTTP response code.
*/
private function verifyAccess($response = 200) {
// View menu help node.
$this->drupalGet('admin/help/menu');
$this->assertResponse($response);
if ($response == 200) {
$this->assertText(t('Menu'), 'Menu help was displayed');
}
// View menu build overview node.
$this->drupalGet('admin/structure/menu');
$this->assertResponse($response);
if ($response == 200) {
$this->assertText(t('Menus'), 'Menu build overview node was displayed');
}
// View navigation menu customization node.
$this->drupalGet('admin/structure/menu/manage/navigation');
$this->assertResponse($response);
if ($response == 200) {
$this->assertText(t('Navigation'), 'Navigation menu node was displayed');
}
// View menu edit node.
$item = $this->getStandardMenuLink();
$this->drupalGet('admin/structure/menu/item/' . $item['mlid'] . '/edit');
$this->assertResponse($response);
if ($response == 200) {
$this->assertText(t('Edit menu item'), 'Menu edit node was displayed');
}
// View menu settings node.
$this->drupalGet('admin/structure/menu/settings');
$this->assertResponse($response);
if ($response == 200) {
$this->assertText(t('Menus'), 'Menu settings node was displayed');
}
// View add menu node.
$this->drupalGet('admin/structure/menu/add');
$this->assertResponse($response);
if ($response == 200) {
$this->assertText(t('Menus'), 'Add menu node was displayed');
}
}
/**
* Tests that menu admin lists can include menu items for unpublished nodes.
*/
function testUnpublishedNodeMenuItem() {
// Log in as an administrator who can view unpublished nodes.
$menu_and_node_admin_user = $this->drupalCreateUser(array(
'bypass node access',
'administer menu',
));
$this->drupalLogin($menu_and_node_admin_user);
// Create an unpublished node with a menu link.
$title = $this->randomName();
$node = $this->drupalCreateNode(array(
'type' => 'article',
'title' => $title,
'status' => NODE_NOT_PUBLISHED,
));
$edit = array(
'link_path' => 'node/' . $node->nid,
'link_title' => $title,
'description' => '',
'enabled' => TRUE,
'expanded' => TRUE,
'parent' => 'navigation:0',
'weight' => '0',
);
$this->drupalPost('admin/structure/menu/manage/navigation/add', $edit, t('Save'));
// Verify that the administrator can see the menu link (with a label
// indicating that it is unpublished) on the menu management page.
$this->drupalGet('admin/structure/menu/manage/navigation');
$this->assertText($title . ' (unpublished)', 'Menu link to unpublished node is visible to users with "bypass node access" permission.');
// Verify that a user who cannot view unpublished nodes does not see the
// menu link on the menu management page.
$menu_admin_user = $this->drupalCreateUser(array('administer menu'));
$this->drupalLogin($menu_admin_user);
$this->drupalGet('admin/structure/menu/manage/navigation');
$this->assertResponse(200);
$this->assertNoText($title, 'Menu link to unpublished node is not visible to users without the "bypass node access" permission.');
}
}
/**
* Test menu settings for nodes.
*/
class MenuNodeTestCase extends DrupalWebTestCase {
protected $admin_user;
public static function getInfo() {
return array(
'name' => 'Menu settings for nodes',
'description' => 'Add, edit, and delete a node with menu link.',
'group' => 'Menu',
);
}
function setUp() {
parent::setUp('menu');
$this->admin_user = $this->drupalCreateUser(array(
'access administration pages',
'administer content types',
'administer menu',
'create page content',
'edit any page content',
'delete any page content',
));
$this->drupalLogin($this->admin_user);
}
/**
* Test creating, editing, deleting menu links via node form widget.
*/
function testMenuNodeFormWidget() {
// Enable Navigation menu as available menu.
$edit = array(
'menu_options[navigation]' => 1,
);
$this->drupalPost('admin/structure/types/manage/page', $edit, t('Save content type'));
// Change default parent item to Navigation menu, so we can assert more
// easily.
$edit = array(
'menu_parent' => 'navigation:0',
);
$this->drupalPost('admin/structure/types/manage/page', $edit, t('Save content type'));
// Verify that the menu link title on the node add form has the correct
// maxlength.
$this->drupalGet('node/add/page');
$this->assertPattern('//', 'Menu link title field has correct maxlength in node add form.');
// Create a node with menu link disabled.
$node_title = $this->randomName();
$language = LANGUAGE_NONE;
$edit = array(
"title" => $node_title,
"body[$language][0][value]" => $this->randomString(),
);
$this->drupalPost('node/add/page', $edit, t('Save'));
$node = $this->drupalGetNodeByTitle($node_title);
// Assert that there is no link for the node.
$this->drupalGet('');
$this->assertNoLink($node_title);
// Edit the node, enable the menu link setting, but skip the link title.
$edit = array(
'menu[enabled]' => 1,
);
$this->drupalPost('node/' . $node->nid . '/edit', $edit, t('Save'));
// Assert that there is no link for the node.
$this->drupalGet('');
$this->assertNoLink($node_title);
// Edit the node and create a menu link.
$edit = array(
'menu[enabled]' => 1,
'menu[link_title]' => $node_title,
'menu[weight]' => 17,
);
$this->drupalPost('node/' . $node->nid . '/edit', $edit, t('Save'));
// Assert that the link exists.
$this->drupalGet('');
$this->assertLink($node_title);
$this->drupalGet('node/' . $node->nid . '/edit');
$this->assertOptionSelected('edit-menu-weight', 17, 'Menu weight correct in edit form');
// Verify that the menu link title on the node edit form has the correct
// maxlength.
$this->assertPattern('//', 'Menu link title field has correct maxlength in node edit form.');
// Edit the node and remove the menu link.
$edit = array(
'menu[enabled]' => FALSE,
);
$this->drupalPost('node/' . $node->nid . '/edit', $edit, t('Save'));
// Assert that there is no link for the node.
$this->drupalGet('');
$this->assertNoLink($node_title);
// Add a menu link to the Management menu.
$item = array(
'link_path' => 'node/' . $node->nid,
'link_title' => $this->randomName(16),
'menu_name' => 'management',
);
menu_link_save($item);
// Assert that disabled Management menu is not shown on the node/$nid/edit page.
$this->drupalGet('node/' . $node->nid . '/edit');
$this->assertText('Provide a menu link', 'Link in not allowed menu not shown in node edit form');
// Assert that the link is still in the management menu after save.
$this->drupalPost('node/' . $node->nid . '/edit', $edit, t('Save'));
$link = menu_link_load($item['mlid']);
$this->assertTrue($link, 'Link in not allowed menu still exists after saving node');
// Move the menu link back to the Navigation menu.
$item['menu_name'] = 'navigation';
menu_link_save($item);
// Create a second node.
$child_node = $this->drupalCreateNode(array('type' => 'article'));
// Assign a menu link to the second node, being a child of the first one.
$child_item = array(
'link_path' => 'node/'. $child_node->nid,
'link_title' => $this->randomName(16),
'plid' => $item['mlid'],
);
menu_link_save($child_item);
// Edit the first node.
$this->drupalGet('node/'. $node->nid .'/edit');
// Assert that it is not possible to set the parent of the first node to itself or the second node.
$this->assertNoOption('edit-menu-parent', 'navigation:'. $item['mlid']);
$this->assertNoOption('edit-menu-parent', 'navigation:'. $child_item['mlid']);
// Assert that unallowed Management menu is not available in options.
$this->assertNoOption('edit-menu-parent', 'management:0');
}
/**
* Asserts that a select option in the current page does not exist.
*
* @param $id
* Id of select field to assert.
* @param $option
* Option to assert.
* @param $message
* Message to display.
* @return
* TRUE on pass, FALSE on fail.
*
* @todo move to simpletest drupal_web_test_case.php.
*/
protected function assertNoOption($id, $option, $message = '') {
$selects = $this->xpath('//select[@id=:id]', array(':id' => $id));
$options = $this->xpath('//select[@id=:id]//option[@value=:option]', array(':id' => $id, ':option' => $option));
return $this->assertTrue(isset($selects[0]) && !isset($options[0]), $message ? $message : t('Option @option for field @id does not exist.', array('@option' => $option, '@id' => $id)), t('Browser'));
}
}
t('Operations'), 'colspan' => $field_ui ? '4' : '2'));
$rows = array();
foreach ($names as $key => $name) {
$type = $types[$key];
if (node_hook($type->type, 'form')) {
$type_url_str = str_replace('_', '-', $type->type);
$row = array(theme('node_admin_overview', array('name' => $name, 'type' => $type)));
// Set the edit column.
$row[] = array('data' => l(t('edit'), 'admin/structure/types/manage/' . $type_url_str));
if ($field_ui) {
// Manage fields.
$row[] = array('data' => l(t('manage fields'), 'admin/structure/types/manage/' . $type_url_str . '/fields'));
// Display fields.
$row[] = array('data' => l(t('manage display'), 'admin/structure/types/manage/' . $type_url_str . '/display'));
}
// Set the delete column.
if ($type->custom) {
$row[] = array('data' => l(t('delete'), 'admin/structure/types/manage/' . $type_url_str . '/delete'));
}
else {
$row[] = array('data' => '');
}
$rows[] = $row;
}
}
$build['node_table'] = array(
'#theme' => 'table',
'#header' => $header,
'#rows' => $rows,
'#empty' => t('No content types available. Add content type .', array('@link' => url('admin/structure/types/add'))),
);
return $build;
}
/**
* Returns HTML for a node type description for the content type admin overview page.
*
* @param $variables
* An associative array containing:
* - name: The human-readable name of the content type.
* - type: An object containing the 'type' (machine name) and 'description' of
* the content type.
*
* @ingroup themeable
*/
function theme_node_admin_overview($variables) {
$name = $variables['name'];
$type = $variables['type'];
$output = check_plain($name);
$output .= ' ' . t('(Machine name: @type)', array('@type' => $type->type)) . ' ';
$output .= '' . filter_xss_admin($type->description) . '
';
return $output;
}
/**
* Form constructor for the node type editing form.
*
* @param $type
* (optional) An object representing the node type, when editing an existing
* node type.
*
* @see node_type_form_validate()
* @see node_type_form_submit()
* @ingroup forms
*/
function node_type_form($form, &$form_state, $type = NULL) {
if (!isset($type->type)) {
// This is a new type. Node module managed types are custom and unlocked.
$type = node_type_set_defaults(array('custom' => 1, 'locked' => 0));
}
// Make the type object available to implementations of hook_form_alter.
$form['#node_type'] = $type;
$form['name'] = array(
'#title' => t('Name'),
'#type' => 'textfield',
'#default_value' => $type->name,
'#description' => t('The human-readable name of this content type. This text will be displayed as part of the list on the Add new content page. It is recommended that this name begin with a capital letter and contain only letters, numbers, and spaces. This name must be unique.'),
'#required' => TRUE,
'#size' => 30,
);
$form['type'] = array(
'#type' => 'machine_name',
'#default_value' => $type->type,
'#maxlength' => 32,
'#disabled' => $type->locked,
'#machine_name' => array(
'exists' => 'node_type_load',
),
'#description' => t('A unique machine-readable name for this content type. It must only contain lowercase letters, numbers, and underscores. This name will be used for constructing the URL of the %node-add page, in which underscores will be converted into hyphens.', array(
'%node-add' => t('Add new content'),
)),
);
$form['description'] = array(
'#title' => t('Description'),
'#type' => 'textarea',
'#default_value' => $type->description,
'#description' => t('Describe this content type. The text will be displayed on the Add new content page.'),
);
$form['additional_settings'] = array(
'#type' => 'vertical_tabs',
'#attached' => array(
'js' => array(drupal_get_path('module', 'node') . '/content_types.js'),
),
);
$form['submission'] = array(
'#type' => 'fieldset',
'#title' => t('Submission form settings'),
'#collapsible' => TRUE,
'#group' => 'additional_settings',
);
$form['submission']['title_label'] = array(
'#title' => t('Title field label'),
'#type' => 'textfield',
'#default_value' => $type->title_label,
'#required' => TRUE,
);
if (!$type->has_title) {
// Avoid overwriting a content type that intentionally does not have a
// title field.
$form['submission']['title_label']['#attributes'] = array('disabled' => 'disabled');
$form['submission']['title_label']['#description'] = t('This content type does not have a title field.');
$form['submission']['title_label']['#required'] = FALSE;
}
$form['submission']['node_preview'] = array(
'#type' => 'radios',
'#title' => t('Preview before submitting'),
'#default_value' => variable_get('node_preview_' . $type->type, DRUPAL_OPTIONAL),
'#options' => array(
DRUPAL_DISABLED => t('Disabled'),
DRUPAL_OPTIONAL => t('Optional'),
DRUPAL_REQUIRED => t('Required'),
),
);
$form['submission']['help'] = array(
'#type' => 'textarea',
'#title' => t('Explanation or submission guidelines'),
'#default_value' => $type->help,
'#description' => t('This text will be displayed at the top of the page when creating or editing content of this type.'),
);
$form['workflow'] = array(
'#type' => 'fieldset',
'#title' => t('Publishing options'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#group' => 'additional_settings',
);
$form['workflow']['node_options'] = array('#type' => 'checkboxes',
'#title' => t('Default options'),
'#default_value' => variable_get('node_options_' . $type->type, array('status', 'promote')),
'#options' => array(
'status' => t('Published'),
'promote' => t('Promoted to front page'),
'sticky' => t('Sticky at top of lists'),
'revision' => t('Create new revision'),
),
'#description' => t('Users with the Administer content permission will be able to override these options.'),
);
$form['display'] = array(
'#type' => 'fieldset',
'#title' => t('Display settings'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#group' => 'additional_settings',
);
$form['display']['node_submitted'] = array(
'#type' => 'checkbox',
'#title' => t('Display author and date information.'),
'#default_value' => variable_get('node_submitted_' . $type->type, TRUE),
'#description' => t('Author username and publish date will be displayed.'),
);
$form['old_type'] = array(
'#type' => 'value',
'#value' => $type->type,
);
$form['orig_type'] = array(
'#type' => 'value',
'#value' => isset($type->orig_type) ? $type->orig_type : '',
);
$form['base'] = array(
'#type' => 'value',
'#value' => $type->base,
);
$form['custom'] = array(
'#type' => 'value',
'#value' => $type->custom,
);
$form['modified'] = array(
'#type' => 'value',
'#value' => $type->modified,
);
$form['locked'] = array(
'#type' => 'value',
'#value' => $type->locked,
);
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Save content type'),
'#weight' => 40,
);
if ($type->custom) {
if (!empty($type->type)) {
$form['actions']['delete'] = array(
'#type' => 'submit',
'#value' => t('Delete content type'),
'#weight' => 45,
);
}
}
return $form;
}
/**
* Helper function for teaser length choices.
*/
function _node_characters($length) {
return ($length == 0) ? t('Unlimited') : format_plural($length, '1 character', '@count characters');
}
/**
* Form validation handler for node_type_form().
*
* @see node_type_form_submit()
*/
function node_type_form_validate($form, &$form_state) {
$type = new stdClass();
$type->type = $form_state['values']['type'];
$type->name = trim($form_state['values']['name']);
// Work out what the type was before the user submitted this form
$old_type = $form_state['values']['old_type'];
$types = node_type_get_names();
if (!$form_state['values']['locked']) {
// 'theme' conflicts with theme_node_form().
// '0' is invalid, since elsewhere we check it using empty().
if (in_array($type->type, array('0', 'theme'))) {
form_set_error('type', t("Invalid machine-readable name. Enter a name other than %invalid.", array('%invalid' => $type->type)));
}
}
$names = array_flip($types);
if (isset($names[$type->name]) && $names[$type->name] != $old_type) {
form_set_error('name', t('The human-readable name %name is already taken.', array('%name' => $type->name)));
}
}
/**
* Form submission handler for node_type_form().
*
* @see node_type_form_validate()
*/
function node_type_form_submit($form, &$form_state) {
$op = isset($form_state['values']['op']) ? $form_state['values']['op'] : '';
$type = node_type_set_defaults();
$type->type = $form_state['values']['type'];
$type->name = trim($form_state['values']['name']);
$type->orig_type = trim($form_state['values']['orig_type']);
$type->old_type = isset($form_state['values']['old_type']) ? $form_state['values']['old_type'] : $type->type;
$type->description = $form_state['values']['description'];
$type->help = $form_state['values']['help'];
$type->title_label = $form_state['values']['title_label'];
// title_label is required in core; has_title will always be true, unless a
// module alters the title field.
$type->has_title = ($type->title_label != '');
$type->base = !empty($form_state['values']['base']) ? $form_state['values']['base'] : 'node_content';
$type->custom = $form_state['values']['custom'];
$type->modified = TRUE;
$type->locked = $form_state['values']['locked'];
if (isset($form['#node_type']->module)) {
$type->module = $form['#node_type']->module;
}
if ($op == t('Delete content type')) {
$form_state['redirect'] = 'admin/structure/types/manage/' . str_replace('_', '-', $type->old_type) . '/delete';
return;
}
$variables = $form_state['values'];
// Remove everything that's been saved already - whatever's left is assumed
// to be a persistent variable.
foreach ($variables as $key => $value) {
if (isset($type->$key)) {
unset($variables[$key]);
}
}
unset($variables['form_token'], $variables['op'], $variables['submit'], $variables['delete'], $variables['reset'], $variables['form_id'], $variables['form_build_id']);
// Save or reset persistent variable values.
foreach ($variables as $key => $value) {
$variable_new = $key . '_' . $type->type;
$variable_old = $key . '_' . $type->old_type;
if (is_array($value)) {
$value = array_keys(array_filter($value));
}
variable_set($variable_new, $value);
if ($variable_new != $variable_old) {
variable_del($variable_old);
}
}
// Saving the content type after saving the variables allows modules to act
// on those variables via hook_node_type_insert().
$status = node_type_save($type);
node_types_rebuild();
menu_rebuild();
$t_args = array('%name' => $type->name);
if ($status == SAVED_UPDATED) {
drupal_set_message(t('The content type %name has been updated.', $t_args));
}
elseif ($status == SAVED_NEW) {
node_add_body_field($type);
drupal_set_message(t('The content type %name has been added.', $t_args));
watchdog('node', 'Added content type %name.', $t_args, WATCHDOG_NOTICE, l(t('view'), 'admin/structure/types'));
}
$form_state['redirect'] = 'admin/structure/types';
return;
}
/**
* Implements hook_node_type_insert().
*/
function node_node_type_insert($info) {
if (!empty($info->old_type) && $info->old_type != $info->type) {
$update_count = node_type_update_nodes($info->old_type, $info->type);
if ($update_count) {
drupal_set_message(format_plural($update_count, 'Changed the content type of 1 post from %old-type to %type.', 'Changed the content type of @count posts from %old-type to %type.', array('%old-type' => $info->old_type, '%type' => $info->type)));
}
}
}
/**
* Implements hook_node_type_update().
*/
function node_node_type_update($info) {
if (!empty($info->old_type) && $info->old_type != $info->type) {
$update_count = node_type_update_nodes($info->old_type, $info->type);
if ($update_count) {
drupal_set_message(format_plural($update_count, 'Changed the content type of 1 post from %old-type to %type.', 'Changed the content type of @count posts from %old-type to %type.', array('%old-type' => $info->old_type, '%type' => $info->type)));
}
}
}
/**
* Resets relevant fields of a module-defined node type to their default values.
*
* @param $type
* The node type to reset. The node type is passed back by reference with its
* resetted values. If there is no module-defined info for this node type,
* then nothing happens.
*/
function node_type_reset($type) {
$info_array = module_invoke_all('node_info');
if (isset($info_array[$type->orig_type])) {
$info_array[$type->orig_type]['type'] = $type->orig_type;
$info = node_type_set_defaults($info_array[$type->orig_type]);
foreach ($info as $field => $value) {
$type->$field = $value;
}
}
}
/**
* Menu callback; delete a single content type.
*
* @ingroup forms
*/
function node_type_delete_confirm($form, &$form_state, $type) {
$form['type'] = array('#type' => 'value', '#value' => $type->type);
$form['name'] = array('#type' => 'value', '#value' => $type->name);
$message = t('Are you sure you want to delete the content type %type?', array('%type' => $type->name));
$num_nodes = db_query("SELECT COUNT(*) FROM {node} WHERE type = :type", array(':type' => $type->type))->fetchField();
if ($num_nodes) {
drupal_set_title($message, PASS_THROUGH);
$caption = '' . format_plural($num_nodes, '%type is used by 1 piece of content on your site. You cannot remove this content type until you have removed all of the %type content.', '%type is used by @count pieces of content on your site. You cannot remove this content type until you have removed all of the %type content.', array('%type' => $type->name)) . '
';
$form['description'] = array('#markup' => $caption);
return $form;
}
$caption = '' . t('This action cannot be undone.') . '
';
return confirm_form($form, $message, 'admin/structure/types', $caption, t('Delete'));
}
/**
* Process content type delete confirm submissions.
*
* @see node_type_delete_confirm()
*/
function node_type_delete_confirm_submit($form, &$form_state) {
node_type_delete($form_state['values']['type']);
variable_del('node_preview_' . $form_state['values']['type']);
$t_args = array('%name' => $form_state['values']['name']);
drupal_set_message(t('The content type %name has been deleted.', $t_args));
watchdog('node', 'Deleted content type %name.', $t_args, WATCHDOG_NOTICE);
node_types_rebuild();
menu_rebuild();
$form_state['redirect'] = 'admin/structure/types';
return;
}
(function ($) {
Drupal.behaviors.contentTypes = {
attach: function (context) {
// Provide the vertical tab summaries.
$('fieldset#edit-submission', context).drupalSetSummary(function(context) {
var vals = [];
vals.push(Drupal.checkPlain($('#edit-title-label', context).val()) || Drupal.t('Requires a title'));
return vals.join(', ');
});
$('fieldset#edit-workflow', context).drupalSetSummary(function(context) {
var vals = [];
$("input[name^='node_options']:checked", context).parent().each(function() {
vals.push(Drupal.checkPlain($(this).text()));
});
if (!$('#edit-node-options-status', context).is(':checked')) {
vals.unshift(Drupal.t('Not published'));
}
return vals.join(', ');
});
$('fieldset#edit-display', context).drupalSetSummary(function(context) {
var vals = [];
$('input:checked', context).next('label').each(function() {
vals.push(Drupal.checkPlain($(this).text()));
});
if (!$('#edit-node-submitted', context).is(':checked')) {
vals.unshift(Drupal.t("Don't display post information"));
}
return vals.join(', ');
});
}
};
})(jQuery);
array(
'label' => t('Publish selected content'),
'callback' => 'node_mass_update',
'callback arguments' => array('updates' => array('status' => NODE_PUBLISHED)),
),
'unpublish' => array(
'label' => t('Unpublish selected content'),
'callback' => 'node_mass_update',
'callback arguments' => array('updates' => array('status' => NODE_NOT_PUBLISHED)),
),
'promote' => array(
'label' => t('Promote selected content to front page'),
'callback' => 'node_mass_update',
'callback arguments' => array('updates' => array('status' => NODE_PUBLISHED, 'promote' => NODE_PROMOTED)),
),
'demote' => array(
'label' => t('Demote selected content from front page'),
'callback' => 'node_mass_update',
'callback arguments' => array('updates' => array('promote' => NODE_NOT_PROMOTED)),
),
'sticky' => array(
'label' => t('Make selected content sticky'),
'callback' => 'node_mass_update',
'callback arguments' => array('updates' => array('status' => NODE_PUBLISHED, 'sticky' => NODE_STICKY)),
),
'unsticky' => array(
'label' => t('Make selected content not sticky'),
'callback' => 'node_mass_update',
'callback arguments' => array('updates' => array('sticky' => NODE_NOT_STICKY)),
),
'delete' => array(
'label' => t('Delete selected content'),
'callback' => NULL,
),
);
return $operations;
}
/**
* List node administration filters that can be applied.
*
* @return
* An associative array of filters.
*/
function node_filters() {
// Regular filters
$filters['status'] = array(
'title' => t('status'),
'options' => array(
'[any]' => t('any'),
'status-1' => t('published'),
'status-0' => t('not published'),
'promote-1' => t('promoted'),
'promote-0' => t('not promoted'),
'sticky-1' => t('sticky'),
'sticky-0' => t('not sticky'),
),
);
// Include translation states if we have this module enabled
if (module_exists('translation')) {
$filters['status']['options'] += array(
'translate-0' => t('Up to date translation'),
'translate-1' => t('Outdated translation'),
);
}
$filters['type'] = array(
'title' => t('type'),
'options' => array(
'[any]' => t('any'),
) + node_type_get_names(),
);
// Language filter if there is a list of languages
if ($languages = module_invoke('locale', 'language_list')) {
$languages = array(LANGUAGE_NONE => t('Language neutral')) + $languages;
$filters['language'] = array(
'title' => t('language'),
'options' => array(
'[any]' => t('any'),
) + $languages,
);
}
return $filters;
}
/**
* Applies filters for node administration filters based on session.
*
* @param $query
* A SelectQuery to which the filters should be applied.
*/
function node_build_filter_query(SelectQueryInterface $query) {
// Build query
$filter_data = isset($_SESSION['node_overview_filter']) ? $_SESSION['node_overview_filter'] : array();
foreach ($filter_data as $index => $filter) {
list($key, $value) = $filter;
switch ($key) {
case 'status':
// Note: no exploitable hole as $key/$value have already been checked when submitted
list($key, $value) = explode('-', $value, 2);
case 'type':
case 'language':
$query->condition('n.' . $key, $value);
break;
}
}
}
/**
* Returns the node administration filters form array to node_admin_content().
*
* @see node_admin_nodes()
* @see node_admin_nodes_submit()
* @see node_admin_nodes_validate()
* @see node_filter_form_submit()
* @see node_multiple_delete_confirm()
* @see node_multiple_delete_confirm_submit()
*
* @ingroup forms
*/
function node_filter_form() {
$session = isset($_SESSION['node_overview_filter']) ? $_SESSION['node_overview_filter'] : array();
$filters = node_filters();
$i = 0;
$form['filters'] = array(
'#type' => 'fieldset',
'#title' => t('Show only items where'),
'#theme' => 'exposed_filters__node',
);
foreach ($session as $filter) {
list($type, $value) = $filter;
if ($type == 'term') {
// Load term name from DB rather than search and parse options array.
$value = module_invoke('taxonomy', 'term_load', $value);
$value = $value->name;
}
elseif ($type == 'language') {
$value = $value == LANGUAGE_NONE ? t('Language neutral') : module_invoke('locale', 'language_name', $value);
}
else {
$value = $filters[$type]['options'][$value];
}
$t_args = array('%property' => $filters[$type]['title'], '%value' => $value);
if ($i++) {
$form['filters']['current'][] = array('#markup' => t('and where %property is %value', $t_args));
}
else {
$form['filters']['current'][] = array('#markup' => t('where %property is %value', $t_args));
}
if (in_array($type, array('type', 'language'))) {
// Remove the option if it is already being filtered on.
unset($filters[$type]);
}
}
$form['filters']['status'] = array(
'#type' => 'container',
'#attributes' => array('class' => array('clearfix')),
'#prefix' => ($i ? '' . t('and where') . '
' : ''),
);
$form['filters']['status']['filters'] = array(
'#type' => 'container',
'#attributes' => array('class' => array('filters')),
);
foreach ($filters as $key => $filter) {
$form['filters']['status']['filters'][$key] = array(
'#type' => 'select',
'#options' => $filter['options'],
'#title' => $filter['title'],
'#default_value' => '[any]',
);
}
$form['filters']['status']['actions'] = array(
'#type' => 'actions',
'#attributes' => array('class' => array('container-inline')),
);
$form['filters']['status']['actions']['submit'] = array(
'#type' => 'submit',
'#value' => count($session) ? t('Refine') : t('Filter'),
);
if (count($session)) {
$form['filters']['status']['actions']['undo'] = array('#type' => 'submit', '#value' => t('Undo'));
$form['filters']['status']['actions']['reset'] = array('#type' => 'submit', '#value' => t('Reset'));
}
drupal_add_js('misc/form.js');
return $form;
}
/**
* Form submission handler for node_filter_form().
*
* @see node_admin_content()
* @see node_admin_nodes()
* @see node_admin_nodes_submit()
* @see node_admin_nodes_validate()
* @see node_filter_form()
* @see node_multiple_delete_confirm()
* @see node_multiple_delete_confirm_submit()
*/
function node_filter_form_submit($form, &$form_state) {
$filters = node_filters();
switch ($form_state['values']['op']) {
case t('Filter'):
case t('Refine'):
// Apply every filter that has a choice selected other than 'any'.
foreach ($filters as $filter => $options) {
if (isset($form_state['values'][$filter]) && $form_state['values'][$filter] != '[any]') {
// Flatten the options array to accommodate hierarchical/nested options.
$flat_options = form_options_flatten($filters[$filter]['options']);
// Only accept valid selections offered on the dropdown, block bad input.
if (isset($flat_options[$form_state['values'][$filter]])) {
$_SESSION['node_overview_filter'][] = array($filter, $form_state['values'][$filter]);
}
}
}
break;
case t('Undo'):
array_pop($_SESSION['node_overview_filter']);
break;
case t('Reset'):
$_SESSION['node_overview_filter'] = array();
break;
}
}
/**
* Make mass update of nodes, changing all nodes in the $nodes array
* to update them with the field values in $updates.
*
* IMPORTANT NOTE: This function is intended to work when called from a form
* submission handler. Calling it outside of the form submission process may not
* work correctly.
*
* @param array $nodes
* Array of node nids to update.
* @param array $updates
* Array of key/value pairs with node field names and the value to update that
* field to.
*/
function node_mass_update($nodes, $updates) {
// We use batch processing to prevent timeout when updating a large number
// of nodes.
if (count($nodes) > 10) {
$batch = array(
'operations' => array(
array('_node_mass_update_batch_process', array($nodes, $updates))
),
'finished' => '_node_mass_update_batch_finished',
'title' => t('Processing'),
// We use a single multi-pass operation, so the default
// 'Remaining x of y operations' message will be confusing here.
'progress_message' => '',
'error_message' => t('The update has encountered an error.'),
// The operations do not live in the .module file, so we need to
// tell the batch engine which file to load before calling them.
'file' => drupal_get_path('module', 'node') . '/node.admin.inc',
);
batch_set($batch);
}
else {
foreach ($nodes as $nid) {
_node_mass_update_helper($nid, $updates);
}
drupal_set_message(t('The update has been performed.'));
}
}
/**
* Updates individual nodes when fewer than 10 are queued.
*
* @param $nid
* ID of node to update.
* @param $updates
* Associative array of updates.
*
* @return object
* An updated node object.
*
* @see node_mass_update()
*/
function _node_mass_update_helper($nid, $updates) {
$node = node_load($nid, NULL, TRUE);
// For efficiency manually save the original node before applying any changes.
$node->original = clone $node;
foreach ($updates as $name => $value) {
$node->$name = $value;
}
node_save($node);
return $node;
}
/**
* Implements callback_batch_operation().
*
* Executes a batch operation for node_mass_update().
*
* @param array $nodes
* An array of node IDs.
* @param array $updates
* Associative array of updates.
* @param array $context
* An array of contextual key/values.
*/
function _node_mass_update_batch_process($nodes, $updates, &$context) {
if (!isset($context['sandbox']['progress'])) {
$context['sandbox']['progress'] = 0;
$context['sandbox']['max'] = count($nodes);
$context['sandbox']['nodes'] = $nodes;
}
// Process nodes by groups of 5.
$count = min(5, count($context['sandbox']['nodes']));
for ($i = 1; $i <= $count; $i++) {
// For each nid, load the node, reset the values, and save it.
$nid = array_shift($context['sandbox']['nodes']);
$node = _node_mass_update_helper($nid, $updates);
// Store result for post-processing in the finished callback.
$context['results'][] = l($node->title, 'node/' . $node->nid);
// Update our progress information.
$context['sandbox']['progress']++;
}
// Inform the batch engine that we are not finished,
// and provide an estimation of the completion level we reached.
if ($context['sandbox']['progress'] != $context['sandbox']['max']) {
$context['finished'] = $context['sandbox']['progress'] / $context['sandbox']['max'];
}
}
/**
* Implements callback_batch_finished().
*
* Reports the status of batch operation for node_mass_update().
*
* @param bool $success
* A boolean indicating whether the batch mass update operation successfully
* concluded.
* @param int $results
* The number of nodes updated via the batch mode process.
* @param array $operations
* An array of function calls (not used in this function).
*/
function _node_mass_update_batch_finished($success, $results, $operations) {
if ($success) {
drupal_set_message(t('The update has been performed.'));
}
else {
drupal_set_message(t('An error occurred and processing did not complete.'), 'error');
$message = format_plural(count($results), '1 item successfully processed:', '@count items successfully processed:');
$message .= theme('item_list', array('items' => $results));
drupal_set_message($message);
}
}
/**
* Page callback: Form constructor for the content administration form.
*
* @see node_admin_nodes()
* @see node_admin_nodes_submit()
* @see node_admin_nodes_validate()
* @see node_filter_form()
* @see node_filter_form_submit()
* @see node_menu()
* @see node_multiple_delete_confirm()
* @see node_multiple_delete_confirm_submit()
* @ingroup forms
*/
function node_admin_content($form, $form_state) {
if (isset($form_state['values']['operation']) && $form_state['values']['operation'] == 'delete') {
return node_multiple_delete_confirm($form, $form_state, array_filter($form_state['values']['nodes']));
}
$form['filter'] = node_filter_form();
$form['#submit'][] = 'node_filter_form_submit';
$form['admin'] = node_admin_nodes();
return $form;
}
/**
* Form builder: Builds the node administration overview.
*
* @see node_admin_nodes_submit()
* @see node_admin_nodes_validate()
* @see node_filter_form()
* @see node_filter_form_submit()
* @see node_multiple_delete_confirm()
* @see node_multiple_delete_confirm_submit()
*
* @ingroup forms
*/
function node_admin_nodes() {
$admin_access = user_access('administer nodes');
// Build the 'Update options' form.
$form['options'] = array(
'#type' => 'fieldset',
'#title' => t('Update options'),
'#attributes' => array('class' => array('container-inline')),
'#access' => $admin_access,
);
$options = array();
foreach (module_invoke_all('node_operations') as $operation => $array) {
$options[$operation] = $array['label'];
}
$form['options']['operation'] = array(
'#type' => 'select',
'#title' => t('Operation'),
'#title_display' => 'invisible',
'#options' => $options,
'#default_value' => 'approve',
);
$form['options']['submit'] = array(
'#type' => 'submit',
'#value' => t('Update'),
'#validate' => array('node_admin_nodes_validate'),
'#submit' => array('node_admin_nodes_submit'),
);
// Enable language column if translation module is enabled or if we have any
// node with language.
$multilanguage = (module_exists('translation') || db_query_range("SELECT 1 FROM {node} WHERE language <> :language", 0, 1, array(':language' => LANGUAGE_NONE))->fetchField());
// Build the sortable table header.
$header = array(
'title' => array('data' => t('Title'), 'field' => 'n.title'),
'type' => array('data' => t('Type'), 'field' => 'n.type'),
'author' => t('Author'),
'status' => array('data' => t('Status'), 'field' => 'n.status'),
'changed' => array('data' => t('Updated'), 'field' => 'n.changed', 'sort' => 'desc')
);
if ($multilanguage) {
$header['language'] = array('data' => t('Language'), 'field' => 'n.language');
}
$header['operations'] = array('data' => t('Operations'));
$query = db_select('node', 'n')->extend('PagerDefault')->extend('TableSort');
$query->addTag('node_admin_filter');
node_build_filter_query($query);
if (!user_access('bypass node access')) {
// If the user is able to view their own unpublished nodes, allow them
// to see these in addition to published nodes. Check that they actually
// have some unpublished nodes to view before adding the condition.
if (user_access('view own unpublished content') && $own_unpublished = db_query('SELECT nid FROM {node} WHERE uid = :uid AND status = :status', array(':uid' => $GLOBALS['user']->uid, ':status' => 0))->fetchCol()) {
$query->condition(db_or()
->condition('n.status', 1)
->condition('n.nid', $own_unpublished, 'IN')
);
}
else {
// If not, restrict the query to published nodes.
$query->condition('n.status', 1);
}
}
$nids = $query
->fields('n',array('nid'))
->limit(50)
->orderByHeader($header)
->addTag('node_access')
->execute()
->fetchCol();
$nodes = node_load_multiple($nids);
// Prepare the list of nodes.
$languages = language_list();
$destination = drupal_get_destination();
$options = array();
foreach ($nodes as $node) {
$langcode = entity_language('node', $node);
$uri = entity_uri('node', $node);
if ($langcode != LANGUAGE_NONE && isset($languages[$langcode])) {
$uri['options']['language'] = $languages[$langcode];
}
$options[$node->nid] = array(
'title' => array(
'data' => array(
'#type' => 'link',
'#title' => $node->title,
'#href' => $uri['path'],
'#options' => $uri['options'],
'#suffix' => ' ' . theme('mark', array('type' => node_mark($node->nid, $node->changed))),
),
),
'type' => check_plain(node_type_get_name($node)),
'author' => theme('username', array('account' => $node)),
'status' => $node->status ? t('published') : t('not published'),
'changed' => format_date($node->changed, 'short'),
);
if ($multilanguage) {
if ($langcode == LANGUAGE_NONE || isset($languages[$langcode])) {
$options[$node->nid]['language'] = $langcode == LANGUAGE_NONE ? t('Language neutral') : t($languages[$langcode]->name);
}
else {
$options[$node->nid]['language'] = t('Undefined language (@langcode)', array('@langcode' => $langcode));
}
}
// Build a list of all the accessible operations for the current node.
$operations = array();
if (node_access('update', $node)) {
$operations['edit'] = array(
'title' => t('edit'),
'href' => 'node/' . $node->nid . '/edit',
'query' => $destination,
);
}
if (node_access('delete', $node)) {
$operations['delete'] = array(
'title' => t('delete'),
'href' => 'node/' . $node->nid . '/delete',
'query' => $destination,
);
}
$options[$node->nid]['operations'] = array();
if (count($operations) > 1) {
// Render an unordered list of operations links.
$options[$node->nid]['operations'] = array(
'data' => array(
'#theme' => 'links__node_operations',
'#links' => $operations,
'#attributes' => array('class' => array('links', 'inline')),
),
);
}
elseif (!empty($operations)) {
// Render the first and only operation as a link.
$link = reset($operations);
$options[$node->nid]['operations'] = array(
'data' => array(
'#type' => 'link',
'#title' => $link['title'],
'#href' => $link['href'],
'#options' => array('query' => $link['query']),
),
);
}
}
// Only use a tableselect when the current user is able to perform any
// operations.
if ($admin_access) {
$form['nodes'] = array(
'#type' => 'tableselect',
'#header' => $header,
'#options' => $options,
'#empty' => t('No content available.'),
);
}
// Otherwise, use a simple table.
else {
$form['nodes'] = array(
'#theme' => 'table',
'#header' => $header,
'#rows' => $options,
'#empty' => t('No content available.'),
);
}
$form['pager'] = array('#markup' => theme('pager'));
return $form;
}
/**
* Validate node_admin_nodes form submissions.
*
* Checks whether any nodes have been selected to perform the chosen 'Update
* option' on.
*
* @see node_admin_nodes()
* @see node_admin_nodes_submit()
* @see node_filter_form()
* @see node_filter_form_submit()
* @see node_multiple_delete_confirm()
* @see node_multiple_delete_confirm_submit()
*/
function node_admin_nodes_validate($form, &$form_state) {
// Error if there are no items to select.
if (!is_array($form_state['values']['nodes']) || !count(array_filter($form_state['values']['nodes']))) {
form_set_error('', t('No items selected.'));
}
}
/**
* Process node_admin_nodes form submissions.
*
* Executes the chosen 'Update option' on the selected nodes.
*
* @see node_admin_nodes()
* @see node_admin_nodes_validate()
* @see node_filter_form()
* @see node_filter_form_submit()
* @see node_multiple_delete_confirm()
* @see node_multiple_delete_confirm_submit()
*/
function node_admin_nodes_submit($form, &$form_state) {
$operations = module_invoke_all('node_operations');
$operation = $operations[$form_state['values']['operation']];
// Filter out unchecked nodes
$nodes = array_filter($form_state['values']['nodes']);
if ($function = $operation['callback']) {
// Add in callback arguments if present.
if (isset($operation['callback arguments'])) {
$args = array_merge(array($nodes), $operation['callback arguments']);
}
else {
$args = array($nodes);
}
call_user_func_array($function, $args);
cache_clear_all();
}
else {
// We need to rebuild the form to go to a second step. For example, to
// show the confirmation form for the deletion of nodes.
$form_state['rebuild'] = TRUE;
}
}
/**
* Multiple node deletion confirmation form for node_admin_content().
*
* @see node_admin_nodes()
* @see node_admin_nodes_submit()
* @see node_admin_nodes_validate()
* @see node_filter_form()
* @see node_filter_form_submit()
* @see node_multiple_delete_confirm_submit()
* @ingroup forms
*/
function node_multiple_delete_confirm($form, &$form_state, $nodes) {
$form['nodes'] = array('#prefix' => '', '#tree' => TRUE);
// array_filter returns only elements with TRUE values
foreach ($nodes as $nid => $value) {
$title = db_query('SELECT title FROM {node} WHERE nid = :nid', array(':nid' => $nid))->fetchField();
$form['nodes'][$nid] = array(
'#type' => 'hidden',
'#value' => $nid,
'#prefix' => '',
'#suffix' => check_plain($title) . " \n",
);
}
$form['operation'] = array('#type' => 'hidden', '#value' => 'delete');
$form['#submit'][] = 'node_multiple_delete_confirm_submit';
$confirm_question = format_plural(count($nodes),
'Are you sure you want to delete this item?',
'Are you sure you want to delete these items?');
return confirm_form($form,
$confirm_question,
'admin/content', t('This action cannot be undone.'),
t('Delete'), t('Cancel'));
}
/**
* Form submission handler for node_multiple_delete_confirm().
*
* @see node_admin_nodes()
* @see node_admin_nodes_submit()
* @see node_admin_nodes_validate()
* @see node_filter_form()
* @see node_filter_form_submit()
* @see node_multiple_delete_confirm()
*/
function node_multiple_delete_confirm_submit($form, &$form_state) {
if ($form_state['values']['confirm']) {
node_delete_multiple(array_keys($form_state['values']['nodes']));
cache_clear_all();
$count = count($form_state['values']['nodes']);
watchdog('content', 'Deleted @count posts.', array('@count' => $count));
drupal_set_message(format_plural($count, 'Deleted 1 post.', 'Deleted @count posts.'));
}
$form_state['redirect'] = 'admin/content';
}
0,
* 'gid' => 888,
* 'realm' => 'example_realm',
* 'grant_view' => 1,
* 'grant_update' => 0,
* 'grant_delete' => 0,
* );
* drupal_write_record('node_access', $record);
* @endcode
* And then in its hook_node_grants() implementation, it would need to return:
* @code
* if ($op == 'view') {
* $grants['example_realm'] = array(888);
* }
* @endcode
* If you decide to do this, be aware that the node_access_rebuild() function
* will erase any node ID 0 entry when it is called, so you will need to make
* sure to restore your {node_access} record after node_access_rebuild() is
* called.
*
* @see node_access_view_all_nodes()
* @see node_access_rebuild()
*
* @param $account
* The user object whose grants are requested.
* @param $op
* The node operation to be performed, such as 'view', 'update', or 'delete'.
*
* @return
* An array whose keys are "realms" of grants, and whose values are arrays of
* the grant IDs within this realm that this user is being granted.
*
* For a detailed example, see node_access_example.module.
*
* @ingroup node_access
*/
function hook_node_grants($account, $op) {
if (user_access('access private content', $account)) {
$grants['example'] = array(1);
}
$grants['example_author'] = array($account->uid);
return $grants;
}
/**
* Set permissions for a node to be written to the database.
*
* When a node is saved, a module implementing hook_node_access_records() will
* be asked if it is interested in the access permissions for a node. If it is
* interested, it must respond with an array of permissions arrays for that
* node.
*
* Node access grants apply regardless of the published or unpublished status
* of the node. Implementations must make sure not to grant access to
* unpublished nodes if they don't want to change the standard access control
* behavior. Your module may need to create a separate access realm to handle
* access to unpublished nodes.
*
* Note that the grant values in the return value from your hook must be
* integers and not boolean TRUE and FALSE.
*
* Each permissions item in the array is an array with the following elements:
* - 'realm': The name of a realm that the module has defined in
* hook_node_grants().
* - 'gid': A 'grant ID' from hook_node_grants().
* - 'grant_view': If set to 1 a user that has been identified as a member
* of this gid within this realm can view this node. This should usually be
* set to $node->status. Failure to do so may expose unpublished content
* to some users.
* - 'grant_update': If set to 1 a user that has been identified as a member
* of this gid within this realm can edit this node.
* - 'grant_delete': If set to 1 a user that has been identified as a member
* of this gid within this realm can delete this node.
* - 'priority': If multiple modules seek to set permissions on a node, the
* realms that have the highest priority will win out, and realms with a lower
* priority will not be written. If there is any doubt, it is best to
* leave this 0.
*
*
* When an implementation is interested in a node but want to deny access to
* everyone, it may return a "deny all" grant:
*
* @code
* $grants[] = array(
* 'realm' => 'all',
* 'gid' => 0,
* 'grant_view' => 0,
* 'grant_update' => 0,
* 'grant_delete' => 0,
* 'priority' => 1,
* );
* @endcode
*
* Setting the priority should cancel out other grants. In the case of a
* conflict between modules, it is safer to use hook_node_access_records_alter()
* to return only the deny grant.
*
* Note: a deny all grant is not written to the database; denies are implicit.
*
* @see node_access_write_grants()
*
* @param $node
* The node that has just been saved.
*
* @return
* An array of grants as defined above.
*
* @see hook_node_access_records_alter()
* @ingroup node_access
*/
function hook_node_access_records($node) {
// We only care about the node if it has been marked private. If not, it is
// treated just like any other node and we completely ignore it.
if ($node->private) {
$grants = array();
// Only published nodes should be viewable to all users. If we allow access
// blindly here, then all users could view an unpublished node.
if ($node->status) {
$grants[] = array(
'realm' => 'example',
'gid' => 1,
'grant_view' => 1,
'grant_update' => 0,
'grant_delete' => 0,
'priority' => 0,
);
}
// For the example_author array, the GID is equivalent to a UID, which
// means there are many groups of just 1 user.
// Note that an author can always view his or her nodes, even if they
// have status unpublished.
$grants[] = array(
'realm' => 'example_author',
'gid' => $node->uid,
'grant_view' => 1,
'grant_update' => 1,
'grant_delete' => 1,
'priority' => 0,
);
return $grants;
}
}
/**
* Alter permissions for a node before it is written to the database.
*
* Node access modules establish rules for user access to content. Node access
* records are stored in the {node_access} table and define which permissions
* are required to access a node. This hook is invoked after node access modules
* returned their requirements via hook_node_access_records(); doing so allows
* modules to modify the $grants array by reference before it is stored, so
* custom or advanced business logic can be applied.
*
* @see hook_node_access_records()
*
* Upon viewing, editing or deleting a node, hook_node_grants() builds a
* permissions array that is compared against the stored access records. The
* user must have one or more matching permissions in order to complete the
* requested operation.
*
* A module may deny all access to a node by setting $grants to an empty array.
*
* @see hook_node_grants()
* @see hook_node_grants_alter()
*
* @param $grants
* The $grants array returned by hook_node_access_records().
* @param $node
* The node for which the grants were acquired.
*
* The preferred use of this hook is in a module that bridges multiple node
* access modules with a configurable behavior, as shown in the example with the
* 'is_preview' field.
*
* @ingroup node_access
*/
function hook_node_access_records_alter(&$grants, $node) {
// Our module allows editors to mark specific articles with the 'is_preview'
// field. If the node being saved has a TRUE value for that field, then only
// our grants are retained, and other grants are removed. Doing so ensures
// that our rules are enforced no matter what priority other grants are given.
if ($node->is_preview) {
// Our module grants are set in $grants['example'].
$temp = $grants['example'];
// Now remove all module grants but our own.
$grants = array('example' => $temp);
}
}
/**
* Alter user access rules when trying to view, edit or delete a node.
*
* Node access modules establish rules for user access to content.
* hook_node_grants() defines permissions for a user to view, edit or delete
* nodes by building a $grants array that indicates the permissions assigned to
* the user by each node access module. This hook is called to allow modules to
* modify the $grants array by reference, so the interaction of multiple node
* access modules can be altered or advanced business logic can be applied.
*
* @see hook_node_grants()
*
* The resulting grants are then checked against the records stored in the
* {node_access} table to determine if the operation may be completed.
*
* A module may deny all access to a user by setting $grants to an empty array.
*
* @see hook_node_access_records()
* @see hook_node_access_records_alter()
*
* @param $grants
* The $grants array returned by hook_node_grants().
* @param $account
* The user account requesting access to content.
* @param $op
* The operation being performed, 'view', 'update' or 'delete'.
*
* Developers may use this hook to either add additional grants to a user or to
* remove existing grants. These rules are typically based on either the
* permissions assigned to a user role, or specific attributes of a user
* account.
*
* @ingroup node_access
*/
function hook_node_grants_alter(&$grants, $account, $op) {
// Our sample module never allows certain roles to edit or delete
// content. Since some other node access modules might allow this
// permission, we expressly remove it by returning an empty $grants
// array for roles specified in our variable setting.
// Get our list of banned roles.
$restricted = variable_get('example_restricted_roles', array());
if ($op != 'view' && !empty($restricted)) {
// Now check the roles for this account against the restrictions.
foreach ($restricted as $role_id) {
if (isset($account->roles[$role_id])) {
$grants = array();
}
}
}
}
/**
* Add mass node operations.
*
* This hook enables modules to inject custom operations into the mass
* operations dropdown found at admin/content, by associating a callback
* function with the operation, which is called when the form is submitted. The
* callback function receives one initial argument, which is an array of the
* checked nodes.
*
* @return
* An array of operations. Each operation is an associative array that may
* contain the following key-value pairs:
* - label: (required) The label for the operation, displayed in the dropdown
* menu.
* - callback: (required) The function to call for the operation.
* - callback arguments: (optional) An array of additional arguments to pass
* to the callback function.
*/
function hook_node_operations() {
$operations = array(
'publish' => array(
'label' => t('Publish selected content'),
'callback' => 'node_mass_update',
'callback arguments' => array('updates' => array('status' => NODE_PUBLISHED)),
),
'unpublish' => array(
'label' => t('Unpublish selected content'),
'callback' => 'node_mass_update',
'callback arguments' => array('updates' => array('status' => NODE_NOT_PUBLISHED)),
),
'promote' => array(
'label' => t('Promote selected content to front page'),
'callback' => 'node_mass_update',
'callback arguments' => array('updates' => array('status' => NODE_PUBLISHED, 'promote' => NODE_PROMOTED)),
),
'demote' => array(
'label' => t('Demote selected content from front page'),
'callback' => 'node_mass_update',
'callback arguments' => array('updates' => array('promote' => NODE_NOT_PROMOTED)),
),
'sticky' => array(
'label' => t('Make selected content sticky'),
'callback' => 'node_mass_update',
'callback arguments' => array('updates' => array('status' => NODE_PUBLISHED, 'sticky' => NODE_STICKY)),
),
'unsticky' => array(
'label' => t('Make selected content not sticky'),
'callback' => 'node_mass_update',
'callback arguments' => array('updates' => array('sticky' => NODE_NOT_STICKY)),
),
'delete' => array(
'label' => t('Delete selected content'),
'callback' => NULL,
),
);
return $operations;
}
/**
* Respond to node deletion.
*
* This hook is invoked from node_delete_multiple() after the type-specific
* hook_delete() has been invoked, but before hook_entity_delete and
* field_attach_delete() are called, and before the node is removed from the
* node table in the database.
*
* @param $node
* The node that is being deleted.
*
* @ingroup node_api_hooks
*/
function hook_node_delete($node) {
db_delete('mytable')
->condition('nid', $node->nid)
->execute();
}
/**
* Respond to deletion of a node revision.
*
* This hook is invoked from node_revision_delete() after the revision has been
* removed from the node_revision table, and before
* field_attach_delete_revision() is called.
*
* @param $node
* The node revision (node object) that is being deleted.
*
* @ingroup node_api_hooks
*/
function hook_node_revision_delete($node) {
db_delete('mytable')
->condition('vid', $node->vid)
->execute();
}
/**
* Respond to creation of a new node.
*
* This hook is invoked from node_save() after the database query that will
* insert the node into the node table is scheduled for execution, after the
* type-specific hook_insert() is invoked, and after field_attach_insert() is
* called.
*
* Note that when this hook is invoked, the changes have not yet been written to
* the database, because a database transaction is still in progress. The
* transaction is not finalized until the save operation is entirely completed
* and node_save() goes out of scope. You should not rely on data in the
* database at this time as it is not updated yet. You should also note that any
* write/update database queries executed from this hook are also not committed
* immediately. Check node_save() and db_transaction() for more info.
*
* @param $node
* The node that is being created.
*
* @ingroup node_api_hooks
*/
function hook_node_insert($node) {
db_insert('mytable')
->fields(array(
'nid' => $node->nid,
'extra' => $node->extra,
))
->execute();
}
/**
* Act on arbitrary nodes being loaded from the database.
*
* This hook should be used to add information that is not in the node or node
* revisions table, not to replace information that is in these tables (which
* could interfere with the entity cache). For performance reasons, information
* for all available nodes should be loaded in a single query where possible.
*
* This hook is invoked during node loading, which is handled by entity_load(),
* via classes NodeController and DrupalDefaultEntityController. After the node
* information is read from the database or the entity cache, hook_load() is
* invoked on the node's content type module, then field_attach_load_revision()
* or field_attach_load() is called, then hook_entity_load() is invoked on all
* implementing modules, and finally hook_node_load() is invoked on all
* implementing modules.
*
* @param $nodes
* An array of the nodes being loaded, keyed by nid.
* @param $types
* An array containing the node types present in $nodes. Allows for an early
* return for modules that only support certain node types. However, if your
* module defines a content type, you can use hook_load() to respond to
* loading of just that content type.
*
* For a detailed usage example, see nodeapi_example.module.
*
* @ingroup node_api_hooks
*/
function hook_node_load($nodes, $types) {
// Decide whether any of $types are relevant to our purposes.
if (count(array_intersect($types_we_want_to_process, $types))) {
// Gather our extra data for each of these nodes.
$result = db_query('SELECT nid, foo FROM {mytable} WHERE nid IN(:nids)', array(':nids' => array_keys($nodes)));
// Add our extra data to the node objects.
foreach ($result as $record) {
$nodes[$record->nid]->foo = $record->foo;
}
}
}
/**
* Control access to a node.
*
* Modules may implement this hook if they want to have a say in whether or not
* a given user has access to perform a given operation on a node.
*
* The administrative account (user ID #1) always passes any access check, so
* this hook is not called in that case. Users with the "bypass node access"
* permission may always view and edit content through the administrative
* interface.
*
* Note that not all modules will want to influence access on all node types. If
* your module does not want to actively grant or block access, return
* NODE_ACCESS_IGNORE or simply return nothing. Blindly returning FALSE will
* break other node access modules.
*
* Also note that this function isn't called for node listings (e.g., RSS feeds,
* the default home page at path 'node', a recent content block, etc.) See
* @link node_access Node access rights @endlink for a full explanation.
*
* @param $node
* Either a node object or the machine name of the content type on which to
* perform the access check.
* @param $op
* The operation to be performed. Possible values:
* - "create"
* - "delete"
* - "update"
* - "view"
* @param $account
* The user object to perform the access check operation on.
*
* @return
* - NODE_ACCESS_ALLOW: if the operation is to be allowed.
* - NODE_ACCESS_DENY: if the operation is to be denied.
* - NODE_ACCESS_IGNORE: to not affect this operation at all.
*
* @ingroup node_access
*/
function hook_node_access($node, $op, $account) {
$type = is_string($node) ? $node : $node->type;
if (in_array($type, node_permissions_get_configured_types())) {
if ($op == 'create' && user_access('create ' . $type . ' content', $account)) {
return NODE_ACCESS_ALLOW;
}
if ($op == 'update') {
if (user_access('edit any ' . $type . ' content', $account) || (user_access('edit own ' . $type . ' content', $account) && ($account->uid == $node->uid))) {
return NODE_ACCESS_ALLOW;
}
}
if ($op == 'delete') {
if (user_access('delete any ' . $type . ' content', $account) || (user_access('delete own ' . $type . ' content', $account) && ($account->uid == $node->uid))) {
return NODE_ACCESS_ALLOW;
}
}
}
// Returning nothing from this function would have the same effect.
return NODE_ACCESS_IGNORE;
}
/**
* Act on a node object about to be shown on the add/edit form.
*
* This hook is invoked from node_object_prepare() after the type-specific
* hook_prepare() is invoked.
*
* @param $node
* The node that is about to be shown on the add/edit form.
*
* @ingroup node_api_hooks
*/
function hook_node_prepare($node) {
if (!isset($node->comment)) {
$node->comment = variable_get("comment_$node->type", COMMENT_NODE_OPEN);
}
}
/**
* Act on a node being displayed as a search result.
*
* This hook is invoked from node_search_execute(), after node_load() and
* node_view() have been called.
*
* @param $node
* The node being displayed in a search result.
*
* @return array
* Extra information to be displayed with search result. This information
* should be presented as an associative array. It will be concatenated with
* the post information (last updated, author) in the default search result
* theming.
*
* @see template_preprocess_search_result()
* @see search-result.tpl.php
*
* @ingroup node_api_hooks
*/
function hook_node_search_result($node) {
$comments = db_query('SELECT comment_count FROM {node_comment_statistics} WHERE nid = :nid', array('nid' => $node->nid))->fetchField();
return array('comment' => format_plural($comments, '1 comment', '@count comments'));
}
/**
* Act on a node being inserted or updated.
*
* This hook is invoked from node_save() before the node is saved to the
* database.
*
* @param $node
* The node that is being inserted or updated.
*
* @ingroup node_api_hooks
*/
function hook_node_presave($node) {
if ($node->nid && $node->moderate) {
// Reset votes when node is updated:
$node->score = 0;
$node->users = '';
$node->votes = 0;
}
}
/**
* Respond to updates to a node.
*
* This hook is invoked from node_save() after the database query that will
* update node in the node table is scheduled for execution, after the
* type-specific hook_update() is invoked, and after field_attach_update() is
* called.
*
* Note that when this hook is invoked, the changes have not yet been written to
* the database, because a database transaction is still in progress. The
* transaction is not finalized until the save operation is entirely completed
* and node_save() goes out of scope. You should not rely on data in the
* database at this time as it is not updated yet. You should also note that any
* write/update database queries executed from this hook are also not committed
* immediately. Check node_save() and db_transaction() for more info.
*
* @param $node
* The node that is being updated.
*
* @ingroup node_api_hooks
*/
function hook_node_update($node) {
db_update('mytable')
->fields(array('extra' => $node->extra))
->condition('nid', $node->nid)
->execute();
}
/**
* Act on a node being indexed for searching.
*
* This hook is invoked during search indexing, after node_load(), and after the
* result of node_view() is added as $node->rendered to the node object.
*
* @param $node
* The node being indexed.
*
* @return string
* Additional node information to be indexed.
*
* @ingroup node_api_hooks
*/
function hook_node_update_index($node) {
$text = '';
$comments = db_query('SELECT subject, comment, format FROM {comment} WHERE nid = :nid AND status = :status', array(':nid' => $node->nid, ':status' => COMMENT_PUBLISHED));
foreach ($comments as $comment) {
$text .= '' . check_plain($comment->subject) . ' ' . check_markup($comment->comment, $comment->format, '', TRUE);
}
return $text;
}
/**
* Perform node validation before a node is created or updated.
*
* This hook is invoked from node_validate(), after a user has finished editing
* the node and is previewing or submitting it. It is invoked at the end of all
* the standard validation steps, and after the type-specific hook_validate() is
* invoked.
*
* To indicate a validation error, use form_set_error().
*
* Note: Changes made to the $node object within your hook implementation will
* have no effect. The preferred method to change a node's content is to use
* hook_node_presave() instead. If it is really necessary to change the node at
* the validate stage, you can use form_set_value().
*
* @param $node
* The node being validated.
* @param $form
* The form being used to edit the node.
* @param $form_state
* The form state array.
*
* @ingroup node_api_hooks
*/
function hook_node_validate($node, $form, &$form_state) {
if (isset($node->end) && isset($node->start)) {
if ($node->start > $node->end) {
form_set_error('time', t('An event may not end before it starts.'));
}
}
}
/**
* Act on a node after validated form values have been copied to it.
*
* This hook is invoked when a node form is submitted with either the "Save" or
* "Preview" button, after form values have been copied to the form state's node
* object, but before the node is saved or previewed. It is a chance for modules
* to adjust the node's properties from what they are simply after a copy from
* $form_state['values']. This hook is intended for adjusting non-field-related
* properties. See hook_field_attach_submit() for customizing field-related
* properties.
*
* @param $node
* The node object being updated in response to a form submission.
* @param $form
* The form being used to edit the node.
* @param $form_state
* The form state array.
*
* @ingroup node_api_hooks
*/
function hook_node_submit($node, $form, &$form_state) {
// Decompose the selected menu parent option into 'menu_name' and 'plid', if
// the form used the default parent selection widget.
if (!empty($form_state['values']['menu']['parent'])) {
list($node->menu['menu_name'], $node->menu['plid']) = explode(':', $form_state['values']['menu']['parent']);
}
}
/**
* Act on a node that is being assembled before rendering.
*
* The module may add elements to $node->content prior to rendering. This hook
* will be called after hook_view(). The structure of $node->content is a
* renderable array as expected by drupal_render().
*
* When $view_mode is 'rss', modules can also add extra RSS elements and
* namespaces to $node->rss_elements and $node->rss_namespaces respectively for
* the RSS item generated for this node.
* For details on how this is used, see node_feed().
*
* @see blog_node_view()
* @see forum_node_view()
* @see comment_node_view()
*
* @param $node
* The node that is being assembled for rendering.
* @param $view_mode
* The $view_mode parameter from node_view().
* @param $langcode
* The language code used for rendering.
*
* @see hook_entity_view()
*
* @ingroup node_api_hooks
*/
function hook_node_view($node, $view_mode, $langcode) {
$node->content['my_additional_field'] = array(
'#markup' => $additional_field,
'#weight' => 10,
'#theme' => 'mymodule_my_additional_field',
);
}
/**
* Alter the results of node_view().
*
* This hook is called after the content has been assembled in a structured
* array and may be used for doing processing which requires that the complete
* node content structure has been built.
*
* If the module wishes to act on the rendered HTML of the node rather than the
* structured content array, it may use this hook to add a #post_render
* callback. Alternatively, it could also implement hook_preprocess_node(). See
* drupal_render() and theme() documentation respectively for details.
*
* @param $build
* A renderable array representing the node content.
*
* @see node_view()
* @see hook_entity_view_alter()
*
* @ingroup node_api_hooks
*/
function hook_node_view_alter(&$build) {
if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) {
// Change its weight.
$build['an_additional_field']['#weight'] = -10;
}
// Add a #post_render callback to act on the rendered HTML of the node.
$build['#post_render'][] = 'my_module_node_post_render';
}
/**
* Define module-provided node types.
*
* This hook allows a module to define one or more of its own node types. For
* example, the blog module uses it to define a blog node-type named "Blog
* entry." The name and attributes of each desired node type are specified in an
* array returned by the hook.
*
* Only module-provided node types should be defined through this hook. User-
* provided (or 'custom') node types should be defined only in the 'node_type'
* database table, and should be maintained by using the node_type_save() and
* node_type_delete() functions.
*
* @return
* An array of information defining the module's node types. The array
* contains a sub-array for each node type, with the machine-readable type
* name as the key. Each sub-array has up to 10 attributes. Possible
* attributes:
* - name: (required) The human-readable name of the node type.
* - base: (required) The base name for implementations of node-type-specific
* hooks that respond to this node type. Base is usually the name of the
* module or 'node_content', but not always. See
* @link node_api_hooks Node API hooks @endlink for more information.
* - description: (required) A brief description of the node type.
* - help: (optional) Help information shown to the user when creating a node
* of this type.
* - has_title: (optional) A Boolean indicating whether or not this node type
* has a title field.
* - title_label: (optional) The label for the title field of this content
* type.
* - locked: (optional) A Boolean indicating whether the administrator can
* change the machine name of this type. FALSE = changeable (not locked),
* TRUE = unchangeable (locked).
*
* The machine name of a node type should contain only letters, numbers, and
* underscores. Underscores will be converted into hyphens for the purpose of
* constructing URLs.
*
* All attributes of a node type that are defined through this hook (except for
* 'locked') can be edited by a site administrator. This includes the
* machine-readable name of a node type, if 'locked' is set to FALSE.
*
* @ingroup node_api_hooks
*/
function hook_node_info() {
return array(
'blog' => array(
'name' => t('Blog entry'),
'base' => 'blog',
'description' => t('Use for multi-user blogs. Every user gets a personal blog.'),
)
);
}
/**
* Provide additional methods of scoring for core search results for nodes.
*
* A node's search score is used to rank it among other nodes matched by the
* search, with the highest-ranked nodes appearing first in the search listing.
*
* For example, a module allowing users to vote on content could expose an
* option to allow search results' rankings to be influenced by the average
* voting score of a node.
*
* All scoring mechanisms are provided as options to site administrators, and
* may be tweaked based on individual sites or disabled altogether if they do
* not make sense. Individual scoring mechanisms, if enabled, are assigned a
* weight from 1 to 10. The weight represents the factor of magnification of
* the ranking mechanism, with higher-weighted ranking mechanisms having more
* influence. In order for the weight system to work, each scoring mechanism
* must return a value between 0 and 1 for every node. That value is then
* multiplied by the administrator-assigned weight for the ranking mechanism,
* and then the weighted scores from all ranking mechanisms are added, which
* brings about the same result as a weighted average.
*
* @return
* An associative array of ranking data. The keys should be strings,
* corresponding to the internal name of the ranking mechanism, such as
* 'recent', or 'comments'. The values should be arrays themselves, with the
* following keys available:
* - title: (required) The human readable name of the ranking mechanism.
* - join: (optional) An array with information to join any additional
* necessary table. This is not necessary if the table required is already
* joined to by the base query, such as for the {node} table. Other tables
* should use the full table name as an alias to avoid naming collisions.
* - score: (required) The part of a query string to calculate the score for
* the ranking mechanism based on values in the database. This does not need
* to be wrapped in parentheses, as it will be done automatically; it also
* does not need to take the weighted system into account, as it will be
* done automatically. It does, however, need to calculate a decimal between
* 0 and 1; be careful not to cast the entire score to an integer by
* inadvertently introducing a variable argument.
* - arguments: (optional) If any arguments are required for the score, they
* can be specified in an array here.
*
* @ingroup node_api_hooks
*/
function hook_ranking() {
// If voting is disabled, we can avoid returning the array, no hard feelings.
if (variable_get('vote_node_enabled', TRUE)) {
return array(
'vote_average' => array(
'title' => t('Average vote'),
// Note that we use i.sid, the search index's search item id, rather than
// n.nid.
'join' => array(
'type' => 'LEFT',
'table' => 'vote_node_data',
'alias' => 'vote_node_data',
'on' => 'vote_node_data.nid = i.sid',
),
// The highest possible score should be 1, and the lowest possible score,
// always 0, should be 0.
'score' => 'vote_node_data.average / CAST(%f AS DECIMAL)',
// Pass in the highest possible voting score as a decimal argument.
'arguments' => array(variable_get('vote_score_max', 5)),
),
);
}
}
/**
* Respond to node type creation.
*
* This hook is invoked from node_type_save() after the node type is added to
* the database.
*
* @param $info
* The node type object that is being created.
*/
function hook_node_type_insert($info) {
drupal_set_message(t('You have just created a content type with a machine name %type.', array('%type' => $info->type)));
}
/**
* Respond to node type updates.
*
* This hook is invoked from node_type_save() after the node type is updated in
* the database.
*
* @param $info
* The node type object that is being updated.
*/
function hook_node_type_update($info) {
if (!empty($info->old_type) && $info->old_type != $info->type) {
$setting = variable_get('comment_' . $info->old_type, COMMENT_NODE_OPEN);
variable_del('comment_' . $info->old_type);
variable_set('comment_' . $info->type, $setting);
}
}
/**
* Respond to node type deletion.
*
* This hook is invoked from node_type_delete() after the node type is removed
* from the database.
*
* @param $info
* The node type object that is being deleted.
*/
function hook_node_type_delete($info) {
variable_del('comment_' . $info->type);
}
/**
* Respond to node deletion.
*
* This is a node-type-specific hook, which is invoked only for the node type
* being affected. See
* @link node_api_hooks Node API hooks @endlink for more information.
*
* Use hook_node_delete() to respond to node deletion of all node types.
*
* This hook is invoked from node_delete_multiple() before hook_node_delete()
* is invoked and before field_attach_delete() is called.
*
* Note that when this hook is invoked, the changes have not yet been written
* to the database, because a database transaction is still in progress. The
* transaction is not finalized until the delete operation is entirely
* completed and node_delete_multiple() goes out of scope. You should not rely
* on data in the database at this time as it is not updated yet. You should
* also note that any write/update database queries executed from this hook are
* also not committed immediately. Check node_delete_multiple() and
* db_transaction() for more info.
*
* @param $node
* The node that is being deleted.
*
* @ingroup node_api_hooks
*/
function hook_delete($node) {
db_delete('mytable')
->condition('nid', $node->nid)
->execute();
}
/**
* Act on a node object about to be shown on the add/edit form.
*
* This is a node-type-specific hook, which is invoked only for the node type
* being affected. See
* @link node_api_hooks Node API hooks @endlink for more information.
*
* Use hook_node_prepare() to respond to node preparation of all node types.
*
* This hook is invoked from node_object_prepare() before the general
* hook_node_prepare() is invoked.
*
* @param $node
* The node that is about to be shown on the add/edit form.
*
* @ingroup node_api_hooks
*/
function hook_prepare($node) {
if (!isset($node->mymodule_value)) {
$node->mymodule_value = 'foo';
}
}
/**
* Display a node editing form.
*
* This is a node-type-specific hook, which is invoked only for the node type
* being affected. See
* @link node_api_hooks Node API hooks @endlink for more information.
*
* Use hook_form_BASE_FORM_ID_alter(), with base form ID 'node_form', to alter
* node forms for all node types.
*
* This hook, implemented by node modules, is called to retrieve the form
* that is displayed to create or edit a node. This form is displayed at path
* node/add/[node type] or node/[node ID]/edit.
*
* The submit and preview buttons, administrative and display controls, and
* sections added by other modules (such as path settings, menu settings,
* comment settings, and fields managed by the Field UI module) are
* displayed automatically by the node module. This hook just needs to
* return the node title and form editing fields specific to the node type.
*
* @param $node
* The node being added or edited.
* @param $form_state
* The form state array.
*
* @return
* An array containing the title and any custom form elements to be displayed
* in the node editing form.
*
* @ingroup node_api_hooks
*/
function hook_form($node, &$form_state) {
$type = node_type_get_type($node);
$form['title'] = array(
'#type' => 'textfield',
'#title' => check_plain($type->title_label),
'#default_value' => !empty($node->title) ? $node->title : '',
'#required' => TRUE, '#weight' => -5
);
$form['field1'] = array(
'#type' => 'textfield',
'#title' => t('Custom field'),
'#default_value' => $node->field1,
'#maxlength' => 127,
);
$form['selectbox'] = array(
'#type' => 'select',
'#title' => t('Select box'),
'#default_value' => $node->selectbox,
'#options' => array(
1 => 'Option A',
2 => 'Option B',
3 => 'Option C',
),
'#description' => t('Choose an option.'),
);
return $form;
}
/**
* Respond to creation of a new node.
*
* This is a node-type-specific hook, which is invoked only for the node type
* being affected. See
* @link node_api_hooks Node API hooks @endlink for more information.
*
* Use hook_node_insert() to respond to node insertion of all node types.
*
* This hook is invoked from node_save() after the node is inserted into the
* node table in the database, before field_attach_insert() is called, and
* before hook_node_insert() is invoked.
*
* @param $node
* The node that is being created.
*
* @ingroup node_api_hooks
*/
function hook_insert($node) {
db_insert('mytable')
->fields(array(
'nid' => $node->nid,
'extra' => $node->extra,
))
->execute();
}
/**
* Act on nodes being loaded from the database.
*
* This is a node-type-specific hook, which is invoked only for the node type
* being affected. See
* @link node_api_hooks Node API hooks @endlink for more information.
*
* Use hook_node_load() to respond to node load of all node types.
*
* This hook is invoked during node loading, which is handled by entity_load(),
* via classes NodeController and DrupalDefaultEntityController. After the node
* information is read from the database or the entity cache, hook_load() is
* invoked on the node's content type module, then field_attach_node_revision()
* or field_attach_load() is called, then hook_entity_load() is invoked on all
* implementing modules, and finally hook_node_load() is invoked on all
* implementing modules.
*
* This hook should only be used to add information that is not in the node or
* node revisions table, not to replace information that is in these tables
* (which could interfere with the entity cache). For performance reasons,
* information for all available nodes should be loaded in a single query where
* possible.
*
* @param $nodes
* An array of the nodes being loaded, keyed by nid.
*
* For a detailed usage example, see node_example.module.
*
* @ingroup node_api_hooks
*/
function hook_load($nodes) {
$result = db_query('SELECT nid, foo FROM {mytable} WHERE nid IN (:nids)', array(':nids' => array_keys($nodes)));
foreach ($result as $record) {
$nodes[$record->nid]->foo = $record->foo;
}
}
/**
* Respond to updates to a node.
*
* This is a node-type-specific hook, which is invoked only for the node type
* being affected. See
* @link node_api_hooks Node API hooks @endlink for more information.
*
* Use hook_node_update() to respond to node update of all node types.
*
* This hook is invoked from node_save() after the node is updated in the
* node table in the database, before field_attach_update() is called, and
* before hook_node_update() is invoked.
*
* @param $node
* The node that is being updated.
*
* @ingroup node_api_hooks
*/
function hook_update($node) {
db_update('mytable')
->fields(array('extra' => $node->extra))
->condition('nid', $node->nid)
->execute();
}
/**
* Perform node validation before a node is created or updated.
*
* This is a node-type-specific hook, which is invoked only for the node type
* being affected. See
* @link node_api_hooks Node API hooks @endlink for more information.
*
* Use hook_node_validate() to respond to node validation of all node types.
*
* This hook is invoked from node_validate(), after a user has finished
* editing the node and is previewing or submitting it. It is invoked at the end
* of all the standard validation steps, and before hook_node_validate() is
* invoked.
*
* To indicate a validation error, use form_set_error().
*
* Note: Changes made to the $node object within your hook implementation will
* have no effect. The preferred method to change a node's content is to use
* hook_node_presave() instead.
*
* @param $node
* The node being validated.
* @param $form
* The form being used to edit the node.
* @param $form_state
* The form state array.
*
* @ingroup node_api_hooks
*/
function hook_validate($node, $form, &$form_state) {
if (isset($node->end) && isset($node->start)) {
if ($node->start > $node->end) {
form_set_error('time', t('An event may not end before it starts.'));
}
}
}
/**
* Display a node.
*
* This is a node-type-specific hook, which is invoked only for the node type
* being affected. See
* @link node_api_hooks Node API hooks @endlink for more information.
*
* Use hook_node_view() to respond to node view of all node types.
*
* This hook is invoked during node viewing after the node is fully loaded, so
* that the node type module can define a custom method for display, or add to
* the default display.
*
* @param $node
* The node to be displayed, as returned by node_load().
* @param $view_mode
* View mode, e.g. 'full', 'teaser', ...
* @param $langcode
* (optional) A language code to use for rendering. Defaults to the global
* content language of the current request.
*
* @return
* The passed $node parameter should be modified as necessary and returned so
* it can be properly presented. Nodes are prepared for display by assembling
* a structured array, formatted as in the Form API, in $node->content. As
* with Form API arrays, the #weight property can be used to control the
* relative positions of added elements. After this hook is invoked,
* node_view() calls field_attach_view() to add field views to $node->content,
* and then invokes hook_node_view() and hook_node_view_alter(), so if you
* want to affect the final view of the node, you might consider implementing
* one of these hooks instead.
*
* @ingroup node_api_hooks
*/
function hook_view($node, $view_mode, $langcode = NULL) {
if ($view_mode == 'full' && node_is_page($node)) {
$breadcrumb = array();
$breadcrumb[] = l(t('Home'), NULL);
$breadcrumb[] = l(t('Example'), 'example');
$breadcrumb[] = l($node->field1, 'example/' . $node->field1);
drupal_set_breadcrumb($breadcrumb);
}
$node->content['myfield'] = array(
'#markup' => theme('mymodule_myfield', $node->myfield),
'#weight' => 1,
);
return $node;
}
/**
* @} End of "addtogroup hooks".
*/
.node-unpublished {
background-color: #fff4f4;
}
.preview .node {
background-color: #ffffea;
}
td.revision-current {
background: #ffc;
}
name = Node
description = Allows content to be submitted to the site and displayed on pages.
package = Core
version = VERSION
core = 7.x
files[] = node.module
files[] = node.test
required = TRUE
configure = admin/structure/types
stylesheets[all][] = node.css
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
'The base table for nodes.',
'fields' => array(
'nid' => array(
'description' => 'The primary identifier for a node.',
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
),
// Defaults to NULL in order to avoid a brief period of potential
// deadlocks on the index.
'vid' => array(
'description' => 'The current {node_revision}.vid version identifier.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => FALSE,
'default' => NULL,
),
'type' => array(
'description' => 'The {node_type}.type of this node.',
'type' => 'varchar',
'length' => 32,
'not null' => TRUE,
'default' => '',
),
'language' => array(
'description' => 'The {languages}.language of this node.',
'type' => 'varchar',
'length' => 12,
'not null' => TRUE,
'default' => '',
),
'title' => array(
'description' => 'The title of this node, always treated as non-markup plain text.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'uid' => array(
'description' => 'The {users}.uid that owns this node; initially, this is the user that created it.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'status' => array(
'description' => 'Boolean indicating whether the node is published (visible to non-administrators).',
'type' => 'int',
'not null' => TRUE,
'default' => 1,
),
'created' => array(
'description' => 'The Unix timestamp when the node was created.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'changed' => array(
'description' => 'The Unix timestamp when the node was most recently saved.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'comment' => array(
'description' => 'Whether comments are allowed on this node: 0 = no, 1 = closed (read only), 2 = open (read/write).',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'promote' => array(
'description' => 'Boolean indicating whether the node should be displayed on the front page.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'sticky' => array(
'description' => 'Boolean indicating whether the node should be displayed at the top of lists in which it appears.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'tnid' => array(
'description' => 'The translation set id for this node, which equals the node id of the source post in each set.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
),
'translate' => array(
'description' => 'A boolean indicating whether this translation page needs to be updated.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
),
'indexes' => array(
'node_changed' => array('changed'),
'node_created' => array('created'),
'node_frontpage' => array('promote', 'status', 'sticky', 'created'),
'node_status_type' => array('status', 'type', 'nid'),
'node_title_type' => array('title', array('type', 4)),
'node_type' => array(array('type', 4)),
'uid' => array('uid'),
'tnid' => array('tnid'),
'translate' => array('translate'),
'language' => array('language'),
),
'unique keys' => array(
'vid' => array('vid'),
),
'foreign keys' => array(
'node_revision' => array(
'table' => 'node_revision',
'columns' => array('vid' => 'vid'),
),
'node_author' => array(
'table' => 'users',
'columns' => array('uid' => 'uid'),
),
),
'primary key' => array('nid'),
);
$schema['node_access'] = array(
'description' => 'Identifies which realm/grant pairs a user must possess in order to view, update, or delete specific nodes.',
'fields' => array(
'nid' => array(
'description' => 'The {node}.nid this record affects.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
),
'gid' => array(
'description' => "The grant ID a user must possess in the specified realm to gain this row's privileges on the node.",
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
),
'realm' => array(
'description' => 'The realm in which the user must possess the grant ID. Each node access node can define one or more realms.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'grant_view' => array(
'description' => 'Boolean indicating whether a user with the realm/grant pair can view this node.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'size' => 'tiny',
),
'grant_update' => array(
'description' => 'Boolean indicating whether a user with the realm/grant pair can edit this node.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'size' => 'tiny',
),
'grant_delete' => array(
'description' => 'Boolean indicating whether a user with the realm/grant pair can delete this node.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'size' => 'tiny',
),
),
'primary key' => array('nid', 'gid', 'realm'),
'foreign keys' => array(
'affected_node' => array(
'table' => 'node',
'columns' => array('nid' => 'nid'),
),
),
);
$schema['node_revision'] = array(
'description' => 'Stores information about each saved version of a {node}.',
'fields' => array(
'nid' => array(
'description' => 'The {node} this version belongs to.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
),
'vid' => array(
'description' => 'The primary identifier for this version.',
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
),
'uid' => array(
'description' => 'The {users}.uid that created this version.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'title' => array(
'description' => 'The title of this version.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
'log' => array(
'description' => 'The log entry explaining the changes in this version.',
'type' => 'text',
'not null' => TRUE,
'size' => 'big',
),
'timestamp' => array(
'description' => 'A Unix timestamp indicating when this version was created.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'status' => array(
'description' => 'Boolean indicating whether the node (at the time of this revision) is published (visible to non-administrators).',
'type' => 'int',
'not null' => TRUE,
'default' => 1,
),
'comment' => array(
'description' => 'Whether comments are allowed on this node (at the time of this revision): 0 = no, 1 = closed (read only), 2 = open (read/write).',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'promote' => array(
'description' => 'Boolean indicating whether the node (at the time of this revision) should be displayed on the front page.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'sticky' => array(
'description' => 'Boolean indicating whether the node (at the time of this revision) should be displayed at the top of lists in which it appears.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
),
'indexes' => array(
'nid' => array('nid'),
'uid' => array('uid'),
),
'primary key' => array('vid'),
'foreign keys' => array(
'versioned_node' => array(
'table' => 'node',
'columns' => array('nid' => 'nid'),
),
'version_author' => array(
'table' => 'users',
'columns' => array('uid' => 'uid'),
),
),
);
$schema['node_type'] = array(
'description' => 'Stores information about all defined {node} types.',
'fields' => array(
'type' => array(
'description' => 'The machine-readable name of this type.',
'type' => 'varchar',
'length' => 32,
'not null' => TRUE,
),
'name' => array(
'description' => 'The human-readable name of this type.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
'translatable' => TRUE,
),
'base' => array(
'description' => 'The base string used to construct callbacks corresponding to this node type.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
),
'module' => array(
'description' => 'The module defining this node type.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
),
'description' => array(
'description' => 'A brief description of this type.',
'type' => 'text',
'not null' => TRUE,
'size' => 'medium',
'translatable' => TRUE,
),
'help' => array(
'description' => 'Help information shown to the user when creating a {node} of this type.',
'type' => 'text',
'not null' => TRUE,
'size' => 'medium',
'translatable' => TRUE,
),
'has_title' => array(
'description' => 'Boolean indicating whether this type uses the {node}.title field.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'size' => 'tiny',
),
'title_label' => array(
'description' => 'The label displayed for the title field on the edit form.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
'translatable' => TRUE,
),
'custom' => array(
'description' => 'A boolean indicating whether this type is defined by a module (FALSE) or by a user via Add content type (TRUE).',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'size' => 'tiny',
),
'modified' => array(
'description' => 'A boolean indicating whether this type has been modified by an administrator; currently not used in any way.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'size' => 'tiny',
),
'locked' => array(
'description' => 'A boolean indicating whether the administrator can change the machine name of this type.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'size' => 'tiny',
),
'disabled' => array(
'description' => 'A boolean indicating whether the node type is disabled.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'size' => 'tiny'
),
'orig_type' => array(
'description' => 'The original machine-readable name of this node type. This may be different from the current type name if the locked field is 0.',
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
),
),
'primary key' => array('type'),
);
$schema['block_node_type'] = array(
'description' => 'Sets up display criteria for blocks based on content types',
'fields' => array(
'module' => array(
'type' => 'varchar',
'length' => 64,
'not null' => TRUE,
'description' => "The block's origin module, from {block}.module.",
),
'delta' => array(
'type' => 'varchar',
'length' => 32,
'not null' => TRUE,
'description' => "The block's unique delta within module, from {block}.delta.",
),
'type' => array(
'type' => 'varchar',
'length' => 32,
'not null' => TRUE,
'description' => "The machine-readable name of this type from {node_type}.type.",
),
),
'primary key' => array('module', 'delta', 'type'),
'indexes' => array(
'type' => array('type'),
),
);
$schema['history'] = array(
'description' => 'A record of which {users} have read which {node}s.',
'fields' => array(
'uid' => array(
'description' => 'The {users}.uid that read the {node} nid.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
'nid' => array(
'description' => 'The {node}.nid that was read.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
),
'timestamp' => array(
'description' => 'The Unix timestamp at which the read occurred.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
),
'primary key' => array('uid', 'nid'),
'indexes' => array(
'nid' => array('nid'),
),
);
return $schema;
}
/**
* Implements hook_install().
*/
function node_install() {
// Populate the node access table.
db_insert('node_access')
->fields(array(
'nid' => 0,
'gid' => 0,
'realm' => 'all',
'grant_view' => 1,
'grant_update' => 0,
'grant_delete' => 0,
))
->execute();
}
/**
* Implements hook_update_dependencies().
*/
function node_update_dependencies() {
// node_update_7006() migrates node data to fields and therefore must run
// after all Field modules have been enabled, which happens in
// system_update_7027(). It also needs to query the {filter_format} table to
// get a list of existing text formats, so it must run after
// filter_update_7000(), which creates that table.
$dependencies['node'][7006] = array(
'system' => 7027,
'filter' => 7000,
);
// node_update_7008() migrates role permissions and therefore must run after
// the {role} and {role_permission} tables are properly set up, which happens
// in user_update_7007().
$dependencies['node'][7008] = array(
'user' => 7007,
);
return $dependencies;
}
/**
* Utility function: fetch the node types directly from the database.
*
* This function is valid for a database schema version 7000.
*
* @ingroup update_api
*/
function _update_7000_node_get_types() {
$node_types = db_query('SELECT * FROM {node_type}')->fetchAllAssoc('type', PDO::FETCH_OBJ);
// Create default settings for orphan nodes.
$all_types = db_query('SELECT DISTINCT type FROM {node}')->fetchCol();
$extra_types = array_diff($all_types, array_keys($node_types));
foreach ($extra_types as $type) {
$type_object = new stdClass();
$type_object->type = $type;
// In Drupal 6, whether you have a body field or not is a flag in the node
// type table. If it's enabled, nodes may or may not have an empty string
// for the bodies. As we can't detect what this setting should be in
// Drupal 7 without access to the Drupal 6 node type settings, we assume
// the default, which is to enable the body field.
$type_object->has_body = 1;
$type_object->body_label = 'Body';
$node_types[$type_object->type] = $type_object;
}
return $node_types;
}
/**
* @addtogroup updates-6.x-to-7.x
* @{
*/
/**
* Upgrade the node type table and fix node type 'module' attribute to avoid name-space conflicts.
*/
function node_update_7000() {
// Rename the module column to base.
db_change_field('node_type', 'module', 'base', array('type' => 'varchar', 'length' => 255, 'not null' => TRUE));
db_add_field('node_type', 'module', array(
'description' => 'The module defining this node type.',
'type' => 'varchar',
'default' => '',
'length' => 255,
'not null' => TRUE,
));
db_add_field('node_type', 'disabled', array(
'description' => 'A boolean indicating whether the node type is disabled.',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'size' => 'tiny'
));
$modules = db_select('system', 's')
->fields('s', array('name'))
->condition('type', 'module');
db_update('node_type')
->expression('module', 'base')
->condition('base', $modules, 'IN')
->execute();
db_update('node_type')
->fields(array('base' => 'node_content'))
->condition('base', 'node')
->execute();
}
/**
* Rename {node_revisions} table to {node_revision}.
*/
function node_update_7001() {
db_rename_table('node_revisions', 'node_revision');
}
/**
* Extend the node_promote_status index to include all fields required for the node page query.
*/
function node_update_7002() {
db_drop_index('node', 'node_promote_status');
db_add_index('node', 'node_frontpage', array('promote', 'status', 'sticky', 'created'));
}
/**
* Remove the node_counter if the statistics module is uninstalled.
*/
function node_update_7003() {
if (drupal_get_installed_schema_version('statistics') == SCHEMA_UNINSTALLED) {
db_drop_table('node_counter');
}
}
/**
* Extend the existing default preview and teaser settings to all node types.
*/
function node_update_7004() {
// Get original settings and all types.
$original_length = variable_get('teaser_length', 600);
$original_preview = variable_get('node_preview', 0);
// Map old preview setting to new values order.
$original_preview ? $original_preview = 2 : $original_preview = 1;
node_type_cache_reset();
// Apply original settings to all types.
foreach (_update_7000_node_get_types() as $type => $type_object) {
variable_set('teaser_length_' . $type, $original_length);
variable_set('node_preview_' . $type, $original_preview);
}
// Delete old variable but leave 'teaser_length' for aggregator module upgrade.
variable_del('node_preview');
}
/**
* Add status/comment/promote and sticky columns to the {node_revision} table.
*/
function node_update_7005() {
foreach (array('status', 'comment', 'promote', 'sticky') as $column) {
db_add_field('node_revision', $column, array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
));
}
}
/**
* Convert body and teaser from node properties to fields, and migrate status/comment/promote and sticky columns to the {node_revision} table.
*/
function node_update_7006(&$sandbox) {
$sandbox['#finished'] = 0;
// Get node type info for every invocation.
node_type_cache_reset();
if (!isset($sandbox['total'])) {
// Initial invocation.
// First, create the body field.
$body_field = array(
'field_name' => 'body',
'type' => 'text_with_summary',
'module' => 'text',
'cardinality' => 1,
'entity_types' => array('node'),
'translatable' => TRUE,
);
_update_7000_field_create_field($body_field);
$default_trim_length = variable_get('teaser_length', 600);
// Get node type info, specifically the body field settings.
$node_types = _update_7000_node_get_types();
// Add body field instances for existing node types.
foreach ($node_types as $node_type) {
if ($node_type->has_body) {
$trim_length = variable_get('teaser_length_' . $node_type->type, $default_trim_length);
$instance = array(
'entity_type' => 'node',
'bundle' => $node_type->type,
'label' => $node_type->body_label,
'description' => isset($node_type->description) ? $node_type->description : '',
'required' => (isset($node_type->min_word_count) && $node_type->min_word_count > 0) ? 1 : 0,
'widget' => array(
'type' => 'text_textarea_with_summary',
'settings' => array(
'rows' => 20,
'summary_rows' => 5,
),
'weight' => -4,
'module' => 'text',
),
'settings' => array('display_summary' => TRUE),
'display' => array(
'default' => array(
'label' => 'hidden',
'type' => 'text_default',
),
'teaser' => array(
'label' => 'hidden',
'type' => 'text_summary_or_trimmed',
'trim_length' => $trim_length,
),
),
);
_update_7000_field_create_instance($body_field, $instance);
variable_del('teaser_length_' . $node_type->type);
}
// Leave 'teaser_length' variable for aggregator module upgrade.
$sandbox['node_types_info'][$node_type->type] = array(
'has_body' => $node_type->has_body,
);
}
// Used below when updating the stored text format of each node body.
$sandbox['existing_text_formats'] = db_query("SELECT format FROM {filter_format}")->fetchCol();
// Initialize state for future calls.
$sandbox['last'] = 0;
$sandbox['count'] = 0;
$query = db_select('node', 'n');
$query->join('node_revision', 'nr', 'n.nid = nr.nid');
$sandbox['total'] = $query->countQuery()->execute()->fetchField();
$sandbox['body_field_id'] = $body_field['id'];
}
else {
// Subsequent invocations.
$found = FALSE;
if ($sandbox['total']) {
// Operate on every revision of every node (whee!), in batches.
$batch_size = 200;
$query = db_select('node_revision', 'nr');
$query->innerJoin('node', 'n', 'n.nid = nr.nid');
$query
->fields('nr', array('nid', 'vid', 'body', 'teaser', 'format'))
->fields('n', array('type', 'status', 'comment', 'promote', 'sticky', 'language'))
->condition('nr.vid', $sandbox['last'], '>')
->orderBy('nr.vid', 'ASC')
->range(0, $batch_size);
$revisions = $query->execute();
// Load each revision of each node, set up 'body'
// appropriately, and save the node's field data. Note that
// node_load() will not return the body or teaser values from
// {node_revision} because those columns have been removed from the
// schema structure in memory (but not yet from the database),
// so we get the values from the explicit query of the table
// instead.
foreach ($revisions as $revision) {
$found = TRUE;
if ($sandbox['node_types_info'][$revision->type]['has_body']) {
$node = (object) array(
'nid' => $revision->nid,
'vid' => $revision->vid,
'type' => $revision->type,
);
// After node_update_7009() we will always have LANGUAGE_NONE as
// language neutral language code, but here we still have empty
// strings.
$langcode = empty($revision->language) ? LANGUAGE_NONE : $revision->language;
if (!empty($revision->teaser) && $revision->teaser != text_summary($revision->body)) {
$node->body[$langcode][0]['summary'] = $revision->teaser;
}
// Do this after text_summary() above.
$break = '';
if (substr($revision->body, 0, strlen($break)) == $break) {
$revision->body = substr($revision->body, strlen($break));
}
$node->body[$langcode][0]['value'] = $revision->body;
// Update the revision's text format for the changes to the Drupal 7
// filter system. This uses the same kind of logic that occurs, for
// example, in user_update_7010(), but we do this here rather than
// via a separate set of database queries, since we are already
// migrating the data.
if (empty($revision->body) && empty($revision->format)) {
$node->body[$langcode][0]['format'] = NULL;
}
elseif (!in_array($revision->format, $sandbox['existing_text_formats'])) {
$node->body[$langcode][0]['format'] = variable_get('filter_default_format', 1);
}
else {
$node->body[$langcode][0]['format'] = $revision->format;
}
// This is a core update and no contrib modules are enabled yet, so
// we can assume default field storage for a faster update.
_update_7000_field_sql_storage_write('node', $node->type, $node->nid, $node->vid, 'body', $node->body);
}
// Migrate the status columns to the {node_revision} table.
db_update('node_revision')
->fields(array(
'status' => $revision->status,
'comment' => $revision->comment,
'promote' => $revision->promote,
'sticky' => $revision->sticky,
))
->condition('vid', $revision->vid)
->execute();
$sandbox['last'] = $revision->vid;
$sandbox['count'] += 1;
}
$sandbox['#finished'] = min(0.99, $sandbox['count'] / $sandbox['total']);
}
if (!$found) {
// All nodes are processed.
// Remove the now-obsolete body info from node_revision.
db_drop_field('node_revision', 'body');
db_drop_field('node_revision', 'teaser');
db_drop_field('node_revision', 'format');
// Remove node_type properties related to the former 'body'.
db_drop_field('node_type', 'has_body');
db_drop_field('node_type', 'body_label');
// We're done.
$sandbox['#finished'] = 1;
}
}
}
/**
* Remove column min_word_count.
*/
function node_update_7007() {
db_drop_field('node_type', 'min_word_count');
}
/**
* Split the 'administer nodes' permission from 'access content overview'.
*/
function node_update_7008() {
$roles = user_roles(FALSE, 'administer nodes');
foreach ($roles as $rid => $role) {
_update_7000_user_role_grant_permissions($rid, array('access content overview'), 'node');
}
}
/**
* Convert node languages from the empty string to LANGUAGE_NONE.
*/
function node_update_7009() {
db_update('node')
->fields(array('language' => LANGUAGE_NONE))
->condition('language', '')
->execute();
}
/**
* Add the {block_node_type} table.
*/
function node_update_7010() {
$schema['block_node_type'] = array(
'description' => 'Sets up display criteria for blocks based on content types',
'fields' => array(
'module' => array(
'type' => 'varchar',
'length' => 64,
'not null' => TRUE,
'description' => "The block's origin module, from {block}.module.",
),
'delta' => array(
'type' => 'varchar',
'length' => 32,
'not null' => TRUE,
'description' => "The block's unique delta within module, from {block}.delta.",
),
'type' => array(
'type' => 'varchar',
'length' => 32,
'not null' => TRUE,
'description' => "The machine-readable name of this type from {node_type}.type.",
),
),
'primary key' => array('module', 'delta', 'type'),
'indexes' => array(
'type' => array('type'),
),
);
db_create_table('block_node_type', $schema['block_node_type']);
}
/**
* @} End of "addtogroup updates-6.x-to-7.x".
*/
/**
* @addtogroup updates-7.x-extra
* @{
*/
/**
* Update the database from Drupal 6 to match the schema.
*/
function node_update_7011() {
// Drop node moderation field.
db_drop_field('node', 'moderate');
db_drop_index('node', 'node_moderate');
// Change {node_revision}.status field to default to 1.
db_change_field('node_revision', 'status', 'status', array(
'type' => 'int',
'not null' => TRUE,
'default' => 1,
));
// Change {node_type}.module field default.
db_change_field('node_type', 'module', 'module', array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
));
}
/**
* Switches body fields to untranslatable while upgrading from D6 and makes them language neutral.
*/
function node_update_7012() {
// If we are upgrading from D6, then body fields should be set back to
// untranslatable, as D6 did not know about the idea of translating fields,
// but only nodes. If a D7 > D7 update is running we need to skip this update,
// as it is a valid use case to have translatable body fields in this context.
if (variable_get('update_d6', FALSE)) {
// Make node bodies untranslatable: field_update_field() cannot be used
// throughout the upgrade process and we do not have an update counterpart
// for _update_7000_field_create_field(). Hence we are forced to update the
// 'field_config' table directly. This is a safe operation since it is
// being performed while upgrading from D6. Perfoming the same operation
// during a D7 update is highly discouraged.
db_update('field_config')
->fields(array('translatable' => 0))
->condition('field_name', 'body')
->execute();
// Switch field languages to LANGUAGE_NONE, since initially they were
// assigned the node language.
foreach (array('field_data_body', 'field_revision_body') as $table) {
db_update($table)
->fields(array('language' => LANGUAGE_NONE))
->execute();
}
node_type_cache_reset();
}
}
/**
* Change {node}.vid default value from 0 to NULL to avoid deadlock issues on MySQL.
*/
function node_update_7013() {
db_drop_unique_key('node', 'vid');
db_change_field('node', 'vid', 'vid', array(
'description' => 'The current {node_revision}.vid version identifier.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => FALSE,
'default' => NULL,
));
db_add_unique_key('node', 'vid', array('vid'));
}
/**
* Add an index on {node}.language.
*/
function node_update_7014() {
db_add_index('node', 'language', array('language'));
}
/**
* Enable node types that may have been erroneously disabled in Drupal 7.36.
*/
function node_update_7015() {
db_update('node_type')
->fields(array('disabled' => 0))
->condition('base', 'node_content')
->execute();
}
/**
* Change {history}.nid to an unsigned int in order to match {node}.nid.
*/
function node_update_7016() {
db_drop_primary_key('history');
db_drop_index('history', 'nid');
db_change_field('history', 'nid', 'nid', array(
'description' => 'The {node}.nid that was read.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
));
db_add_primary_key('history', array('uid', 'nid'));
db_add_index('history', 'nid', array('nid'));
}
/**
* @} End of "addtogroup updates-7.x-extra".
*/
(function ($) {
Drupal.behaviors.nodeFieldsetSummaries = {
attach: function (context) {
$('fieldset.node-form-revision-information', context).drupalSetSummary(function (context) {
var revisionCheckbox = $('.form-item-revision input', context);
// Return 'New revision' if the 'Create new revision' checkbox is checked,
// or if the checkbox doesn't exist, but the revision log does. For users
// without the "Administer content" permission the checkbox won't appear,
// but the revision log will if the content type is set to auto-revision.
if (revisionCheckbox.is(':checked') || (!revisionCheckbox.length && $('.form-item-log textarea', context).length)) {
return Drupal.t('New revision');
}
return Drupal.t('No revision');
});
$('fieldset.node-form-author', context).drupalSetSummary(function (context) {
var name = $('.form-item-name input', context).val() || Drupal.settings.anonymous,
date = $('.form-item-date input', context).val();
return date ?
Drupal.t('By @name on @date', { '@name': name, '@date': date }) :
Drupal.t('By @name', { '@name': name });
});
$('fieldset.node-form-options', context).drupalSetSummary(function (context) {
var vals = [];
$('input:checked', context).parent().each(function () {
vals.push(Drupal.checkPlain($.trim($(this).text())));
});
if (!$('.form-item-status input', context).is(':checked')) {
vals.unshift(Drupal.t('Not published'));
}
return vals.join(', ');
});
}
};
})(jQuery);
Rebuild permissions .', array('@node_access_rebuild' => url('admin/reports/status/rebuild')));
}
drupal_set_message($message, 'error');
}
switch ($path) {
case 'admin/help#node':
$output = '';
$output .= '
' . t('About') . ' ';
$output .= '' . t('The Node module manages the creation, editing, deletion, settings, and display of the main site content. Content items managed by the Node module are typically displayed as pages on your site, and include a title, some meta-data (author, creation time, content type, etc.), and optional fields containing text or other data (fields are managed by the Field module ). For more information, see the online handbook entry for Node module .', array('@node' => 'http://drupal.org/documentation/modules/node', '@field' => url('admin/help/field'))) . '
';
$output .= '' . t('Uses') . ' ';
$output .= '';
$output .= '' . t('Creating content') . ' ';
$output .= '' . t('When new content is created, the Node module records basic information about the content, including the author, date of creation, and the Content type . It also manages the publishing options , which define whether or not the content is published, promoted to the front page of the site, and/or sticky at the top of content lists. Default settings can be configured for each type of content on your site.', array('@content-type' => url('admin/structure/types'))) . ' ';
$output .= '' . t('Creating custom content types') . ' ';
$output .= '' . t('The Node module gives users with the Administer content types permission the ability to create new content types in addition to the default ones already configured. Creating custom content types allows you the flexibility to add fields and configure default settings that suit the differing needs of various site content.', array('@content-new' => url('admin/structure/types/add'), '@field' => url('admin/help/field'))) . ' ';
$output .= '' . t('Administering content') . ' ';
$output .= '' . t('The Content administration page allows you to review and bulk manage your site content.', array('@content' => url('admin/content'))) . ' ';
$output .= '' . t('Creating revisions') . ' ';
$output .= '' . t('The Node module also enables you to create multiple versions of any content, and revert to older versions using the Revision information settings.') . ' ';
$output .= '' . t('User permissions') . ' ';
$output .= '' . t('The Node module makes a number of permissions available for each content type, which can be set by role on the permissions page .', array('@permissions' => url('admin/people/permissions', array('fragment' => 'module-node')))) . ' ';
$output .= ' ';
return $output;
case 'admin/structure/types/add':
return '' . t('Individual content types can have different fields, behaviors, and permissions assigned to them.') . '
';
case 'admin/structure/types/manage/%/display':
return '' . t('Content items can be displayed using different view modes: Teaser, Full content, Print, RSS, etc. Teaser is a short format that is typically used in lists of multiple content items. Full content is typically used when the content is displayed on its own page.') . '
' .
'' . t('Here, you can define which fields are shown and hidden when %type content is displayed in each view mode, and define how the fields are displayed in each view mode.', array('%type' => node_type_get_name($arg[4]))) . '
';
case 'node/%/revisions':
return '' . t('Revisions allow you to track differences between multiple versions of your content, and revert back to older versions.') . '
';
case 'node/%/edit':
$node = node_load($arg[1]);
$type = node_type_get_type($node);
return (!empty($type->help) ? '' . filter_xss_admin($type->help) . '
' : '');
}
if ($arg[0] == 'node' && $arg[1] == 'add' && $arg[2]) {
$type = node_type_get_type(str_replace('-', '_', $arg[2]));
return (!empty($type->help) ? '' . filter_xss_admin($type->help) . '
' : '');
}
}
/**
* Implements hook_theme().
*/
function node_theme() {
return array(
'node' => array(
'render element' => 'elements',
'template' => 'node',
),
'node_search_admin' => array(
'render element' => 'form',
),
'node_add_list' => array(
'variables' => array('content' => NULL),
'file' => 'node.pages.inc',
),
'node_preview' => array(
'variables' => array('node' => NULL),
'file' => 'node.pages.inc',
),
'node_admin_overview' => array(
'variables' => array('name' => NULL, 'type' => NULL),
'file' => 'content_types.inc',
),
'node_recent_block' => array(
'variables' => array('nodes' => NULL),
),
'node_recent_content' => array(
'variables' => array('node' => NULL),
),
);
}
/**
* Implements hook_cron().
*/
function node_cron() {
db_delete('history')
->condition('timestamp', NODE_NEW_LIMIT, '<')
->execute();
}
/**
* Implements hook_entity_info().
*/
function node_entity_info() {
$return = array(
'node' => array(
'label' => t('Node'),
'controller class' => 'NodeController',
'base table' => 'node',
'revision table' => 'node_revision',
'uri callback' => 'node_uri',
'fieldable' => TRUE,
'entity keys' => array(
'id' => 'nid',
'revision' => 'vid',
'bundle' => 'type',
'label' => 'title',
'language' => 'language',
),
'bundle keys' => array(
'bundle' => 'type',
),
'bundles' => array(),
'view modes' => array(
'full' => array(
'label' => t('Full content'),
'custom settings' => FALSE,
),
'teaser' => array(
'label' => t('Teaser'),
'custom settings' => TRUE,
),
'rss' => array(
'label' => t('RSS'),
'custom settings' => FALSE,
),
),
),
);
// Search integration is provided by node.module, so search-related view modes
// for nodes are defined here and not in search.module.
if (module_exists('search')) {
$return['node']['view modes'] += array(
'search_index' => array(
'label' => t('Search index'),
'custom settings' => FALSE,
),
'search_result' => array(
'label' => t('Search result highlighting input'),
'custom settings' => FALSE,
),
);
}
// Bundles must provide a human readable name so we can create help and error
// messages, and the path to attach Field admin pages to.
foreach (node_type_get_names() as $type => $name) {
$return['node']['bundles'][$type] = array(
'label' => $name,
'admin' => array(
'path' => 'admin/structure/types/manage/%node_type',
'real path' => 'admin/structure/types/manage/' . str_replace('_', '-', $type),
'bundle argument' => 4,
'access arguments' => array('administer content types'),
),
);
}
return $return;
}
/**
* Implements hook_field_display_ENTITY_TYPE_alter().
*/
function node_field_display_node_alter(&$display, $context) {
// Hide field labels in search index.
if ($context['view_mode'] == 'search_index') {
$display['label'] = 'hidden';
}
}
/**
* Implements callback_entity_info_uri().
*/
function node_uri($node) {
return array(
'path' => 'node/' . $node->nid,
);
}
/**
* Implements hook_admin_paths().
*/
function node_admin_paths() {
if (variable_get('node_admin_theme')) {
$paths = array(
'node/*/edit' => TRUE,
'node/*/delete' => TRUE,
'node/*/revisions' => TRUE,
'node/*/revisions/*/revert' => TRUE,
'node/*/revisions/*/delete' => TRUE,
'node/add' => TRUE,
'node/add/*' => TRUE,
);
return $paths;
}
}
/**
* Gathers a listing of links to nodes.
*
* @param $result
* A database result object from a query to fetch node entities. If your
* query joins the {node_comment_statistics} table so that the comment_count
* field is available, a title attribute will be added to show the number of
* comments.
* @param $title
* A heading for the resulting list.
*
* @return
* A renderable array containing a list of linked node titles fetched from
* $result, or FALSE if there are no rows in $result.
*/
function node_title_list($result, $title = NULL) {
$items = array();
$num_rows = FALSE;
foreach ($result as $node) {
$items[] = l($node->title, 'node/' . $node->nid, !empty($node->comment_count) ? array('attributes' => array('title' => format_plural($node->comment_count, '1 comment', '@count comments'))) : array());
$num_rows = TRUE;
}
return $num_rows ? array('#theme' => 'item_list__node', '#items' => $items, '#title' => $title) : FALSE;
}
/**
* Updates the 'last viewed' timestamp of the specified node for current user.
*
* @param $node
* A node object.
*/
function node_tag_new($node) {
global $user;
if ($user->uid) {
db_merge('history')
->key(array(
'uid' => $user->uid,
'nid' => $node->nid,
))
->fields(array('timestamp' => REQUEST_TIME))
->execute();
}
}
/**
* Retrieves the timestamp for the current user's last view of a specified node.
*
* @param $nid
* A node ID.
*
* @return
* If a node has been previously viewed by the user, the timestamp in seconds
* of when the last view occurred; otherwise, zero.
*/
function node_last_viewed($nid) {
global $user;
$history = &drupal_static(__FUNCTION__, array());
if (!isset($history[$nid])) {
$history[$nid] = db_query("SELECT timestamp FROM {history} WHERE uid = :uid AND nid = :nid", array(':uid' => $user->uid, ':nid' => $nid))->fetchObject();
}
return (isset($history[$nid]->timestamp) ? $history[$nid]->timestamp : 0);
}
/**
* Determines the type of marker to be displayed for a given node.
*
* @param $nid
* Node ID whose history supplies the "last viewed" timestamp.
* @param $timestamp
* Time which is compared against node's "last viewed" timestamp.
*
* @return
* One of the MARK constants.
*/
function node_mark($nid, $timestamp) {
global $user;
$cache = &drupal_static(__FUNCTION__, array());
if (!$user->uid) {
return MARK_READ;
}
if (!isset($cache[$nid])) {
$cache[$nid] = node_last_viewed($nid);
}
if ($cache[$nid] == 0 && $timestamp > NODE_NEW_LIMIT) {
return MARK_NEW;
}
elseif ($timestamp > $cache[$nid] && $timestamp > NODE_NEW_LIMIT) {
return MARK_UPDATED;
}
return MARK_READ;
}
/**
* Extracts the type name.
*
* @param $node
* Either a string or object, containing the node type information.
*
* @return
* Node type of the passed-in data.
*/
function _node_extract_type($node) {
return is_object($node) ? $node->type : $node;
}
/**
* Returns a list of all the available node types.
*
* This list can include types that are queued for addition or deletion.
* See _node_types_build() for details.
*
* @return
* An array of node types, as objects, keyed by the type.
*
* @see node_type_get_type()
*/
function node_type_get_types() {
return _node_types_build()->types;
}
/**
* Returns the node type of the passed node or node type string.
*
* @param $node
* A node object or string that indicates the node type to return.
*
* @return
* A single node type, as an object, or FALSE if the node type is not found.
* The node type is an object containing fields from hook_node_info() return
* values, as well as the field 'type' (the machine-readable type) and other
* fields used internally and defined in _node_types_build(),
* hook_node_info(), and node_type_set_defaults().
*/
function node_type_get_type($node) {
$type = _node_extract_type($node);
$types = _node_types_build()->types;
return isset($types[$type]) ? $types[$type] : FALSE;
}
/**
* Returns the node type base of the passed node or node type string.
*
* The base indicates which module implements this node type and is used to
* execute node-type-specific hooks. For types defined in the user interface
* and managed by node.module, the base is 'node_content'.
*
* @param $node
* A node object or string that indicates the node type to return.
*
* @return
* The node type base or FALSE if the node type is not found.
*
* @see node_invoke()
*/
function node_type_get_base($node) {
$type = _node_extract_type($node);
$types = _node_types_build()->types;
return isset($types[$type]) && isset($types[$type]->base) ? $types[$type]->base : FALSE;
}
/**
* Returns a list of available node type names.
*
* This list can include types that are queued for addition or deletion.
* See _node_types_build() for details.
*
* @return
* An array of node type names, keyed by the type.
*/
function node_type_get_names() {
return _node_types_build()->names;
}
/**
* Returns the node type name of the passed node or node type string.
*
* @param $node
* A node object or string that indicates the node type to return.
*
* @return
* The node type name or FALSE if the node type is not found.
*/
function node_type_get_name($node) {
$type = _node_extract_type($node);
$types = _node_types_build()->names;
return isset($types[$type]) ? $types[$type] : FALSE;
}
/**
* Updates the database cache of node types.
*
* All new module-defined node types are saved to the database via a call to
* node_type_save(), and obsolete ones are deleted via a call to
* node_type_delete(). See _node_types_build() for an explanation of the new
* and obsolete types.
*
* @see _node_types_build()
*/
function node_types_rebuild() {
_node_types_build(TRUE);
}
/**
* Menu argument loader: loads a node type by string.
*
* @param $name
* The machine-readable name of a node type to load, where '_' is replaced
* with '-'.
*
* @return
* A node type object or FALSE if $name does not exist.
*/
function node_type_load($name) {
return node_type_get_type(strtr($name, array('-' => '_')));
}
/**
* Saves a node type to the database.
*
* @param object $info
* The node type to save; an object with the following properties:
* - type: A string giving the machine name of the node type.
* - name: A string giving the human-readable name of the node type.
* - base: A string that indicates the base string for hook functions. For
* example, 'node_content' is the value used by the UI when creating a new
* node type.
* - description: A string that describes the node type.
* - help: A string giving the help information shown to the user when
* creating a node of this type.
* - custom: TRUE or FALSE indicating whether this type is defined by a module
* (FALSE) or by a user (TRUE) via Add Content Type.
* - modified: TRUE or FALSE indicating whether this type has been modified by
* an administrator. When modifying an existing node type, set to TRUE, or
* the change will be ignored on node_types_rebuild().
* - locked: TRUE or FALSE indicating whether the administrator can change the
* machine name of this type.
* - disabled: TRUE or FALSE indicating whether this type has been disabled.
* - has_title: TRUE or FALSE indicating whether this type uses the node title
* field.
* - title_label: A string containing the label for the title.
* - module: A string giving the module defining this type of node.
* - orig_type: A string giving the original machine-readable name of this
* node type. This may be different from the current type name if the
* 'locked' key is FALSE.
*
* @return int
* A status flag indicating the outcome of the operation, either SAVED_NEW or
* SAVED_UPDATED.
*/
function node_type_save($info) {
$existing_type = !empty($info->old_type) ? $info->old_type : $info->type;
$is_existing = (bool) db_query_range('SELECT 1 FROM {node_type} WHERE type = :type', 0, 1, array(':type' => $existing_type))->fetchField();
$type = node_type_set_defaults($info);
$fields = array(
'type' => (string) $type->type,
'name' => (string) $type->name,
'base' => (string) $type->base,
'has_title' => (int) $type->has_title,
'title_label' => (string) $type->title_label,
'description' => (string) $type->description,
'help' => (string) $type->help,
'custom' => (int) $type->custom,
'modified' => (int) $type->modified,
'locked' => (int) $type->locked,
'disabled' => (int) $type->disabled,
'module' => $type->module,
);
if ($is_existing) {
db_update('node_type')
->fields($fields)
->condition('type', $existing_type)
->execute();
if (!empty($type->old_type) && $type->old_type != $type->type) {
field_attach_rename_bundle('node', $type->old_type, $type->type);
}
module_invoke_all('node_type_update', $type);
$status = SAVED_UPDATED;
}
else {
$fields['orig_type'] = (string) $type->orig_type;
db_insert('node_type')
->fields($fields)
->execute();
field_attach_create_bundle('node', $type->type);
module_invoke_all('node_type_insert', $type);
$status = SAVED_NEW;
}
// Clear the node type cache.
node_type_cache_reset();
return $status;
}
/**
* Adds default body field to a node type.
*
* @param $type
* A node type object.
* @param $label
* The label for the body instance.
*
* @return
* Body field instance.
*/
function node_add_body_field($type, $label = 'Body') {
// Add or remove the body field, as needed.
$field = field_info_field('body');
$instance = field_info_instance('node', 'body', $type->type);
if (empty($field)) {
$field = array(
'field_name' => 'body',
'type' => 'text_with_summary',
'entity_types' => array('node'),
);
$field = field_create_field($field);
}
if (empty($instance)) {
$instance = array(
'field_name' => 'body',
'entity_type' => 'node',
'bundle' => $type->type,
'label' => $label,
'widget' => array('type' => 'text_textarea_with_summary'),
'settings' => array('display_summary' => TRUE),
'display' => array(
'default' => array(
'label' => 'hidden',
'type' => 'text_default',
),
'teaser' => array(
'label' => 'hidden',
'type' => 'text_summary_or_trimmed',
),
),
);
$instance = field_create_instance($instance);
}
return $instance;
}
/**
* Implements hook_field_extra_fields().
*/
function node_field_extra_fields() {
$extra = array();
foreach (node_type_get_types() as $type) {
if ($type->has_title) {
$extra['node'][$type->type] = array(
'form' => array(
'title' => array(
'label' => $type->title_label,
'description' => t('Node module element'),
'weight' => -5,
),
),
);
}
}
return $extra;
}
/**
* Deletes a node type from the database.
*
* @param $type
* The machine-readable name of the node type to be deleted.
*/
function node_type_delete($type) {
$info = node_type_get_type($type);
db_delete('node_type')
->condition('type', $type)
->execute();
field_attach_delete_bundle('node', $type);
module_invoke_all('node_type_delete', $info);
// Clear the node type cache.
node_type_cache_reset();
}
/**
* Updates all nodes of one type to be of another type.
*
* @param $old_type
* The current node type of the nodes.
* @param $type
* The new node type of the nodes.
*
* @return
* The number of nodes whose node type field was modified.
*/
function node_type_update_nodes($old_type, $type) {
return db_update('node')
->fields(array('type' => $type))
->condition('type', $old_type)
->execute();
}
/**
* Builds and returns the list of available node types.
*
* The list of types is built by invoking hook_node_info() on all modules and
* comparing this information with the node types in the {node_type} table.
* These two information sources are not synchronized during module installation
* until node_types_rebuild() is called.
*
* @param $rebuild
* TRUE to rebuild node types. Equivalent to calling node_types_rebuild().
*
* @return
* An object with two properties:
* - names: Associative array of the names of node types, keyed by the type.
* - types: Associative array of node type objects, keyed by the type.
* Both of these arrays will include new types that have been defined by
* hook_node_info() implementations but not yet saved in the {node_type}
* table. These are indicated in the type object by $type->is_new being set
* to the value 1. These arrays will also include obsolete types: types that
* were previously defined by modules that have now been disabled, or for
* whatever reason are no longer being defined in hook_node_info()
* implementations, but are still in the database. These are indicated in the
* type object by $type->disabled being set to TRUE.
*/
function _node_types_build($rebuild = FALSE) {
$cid = 'node_types:' . $GLOBALS['language']->language;
if (!$rebuild) {
$_node_types = &drupal_static(__FUNCTION__);
if (isset($_node_types)) {
return $_node_types;
}
if ($cache = cache_get($cid)) {
$_node_types = $cache->data;
return $_node_types;
}
}
$_node_types = (object) array('types' => array(), 'names' => array());
foreach (module_implements('node_info') as $module) {
$info_array = module_invoke($module, 'node_info');
foreach ($info_array as $type => $info) {
$info['type'] = $type;
$_node_types->types[$type] = node_type_set_defaults($info);
$_node_types->types[$type]->module = $module;
$_node_types->names[$type] = $info['name'];
}
}
$query = db_select('node_type', 'nt')
->addTag('translatable')
->addTag('node_type_access')
->fields('nt')
->orderBy('nt.type', 'ASC');
if (!$rebuild) {
$query->condition('disabled', 0);
}
foreach ($query->execute() as $type_object) {
$type_db = $type_object->type;
// Original disabled value.
$disabled = $type_object->disabled;
// Check for node types from disabled modules and mark their types for removal.
// Types defined by the node module in the database (rather than by a separate
// module using hook_node_info) have a base value of 'node_content'. The isset()
// check prevents errors on old (pre-Drupal 7) databases.
if (isset($type_object->base) && $type_object->base != 'node_content' && empty($_node_types->types[$type_db])) {
$type_object->disabled = TRUE;
}
if (isset($_node_types->types[$type_db])) {
$type_object->disabled = FALSE;
}
if (!isset($_node_types->types[$type_db]) || $type_object->modified) {
$_node_types->types[$type_db] = $type_object;
$_node_types->names[$type_db] = $type_object->name;
if ($type_db != $type_object->orig_type) {
unset($_node_types->types[$type_object->orig_type]);
unset($_node_types->names[$type_object->orig_type]);
}
}
$_node_types->types[$type_db]->disabled = $type_object->disabled;
$_node_types->types[$type_db]->disabled_changed = $disabled != $type_object->disabled;
}
if ($rebuild) {
foreach ($_node_types->types as $type => $type_object) {
if (!empty($type_object->is_new) || !empty($type_object->disabled_changed)) {
node_type_save($type_object);
}
}
}
asort($_node_types->names);
cache_set($cid, $_node_types);
return $_node_types;
}
/**
* Clears the node type cache.
*/
function node_type_cache_reset() {
cache_clear_all('node_types:', 'cache', TRUE);
drupal_static_reset('_node_types_build');
}
/**
* Sets the default values for a node type.
*
* The defaults are appropriate for a type defined through hook_node_info(),
* since 'custom' is TRUE for types defined in the user interface, and FALSE
* for types defined by modules. (The 'custom' flag prevents types from being
* deleted through the user interface.) Also, the default for 'locked' is TRUE,
* which prevents users from changing the machine name of the type.
*
* @param $info
* (optional) An object or array containing values to override the defaults.
* See hook_node_info() for details on what the array elements mean. Defaults
* to an empty array.
*
* @return
* A node type object, with missing values in $info set to their defaults.
*/
function node_type_set_defaults($info = array()) {
$info = (array) $info;
$new_type = $info + array(
'type' => '',
'name' => '',
'base' => '',
'description' => '',
'help' => '',
'custom' => 0,
'modified' => 0,
'locked' => 1,
'disabled' => 0,
'is_new' => 1,
'has_title' => 1,
'title_label' => 'Title',
);
$new_type = (object) $new_type;
// If the type has no title, set an empty label.
if (!$new_type->has_title) {
$new_type->title_label = '';
}
if (empty($new_type->module)) {
$new_type->module = $new_type->base == 'node_content' ? 'node' : '';
}
$new_type->orig_type = isset($info['type']) ? $info['type'] : '';
return $new_type;
}
/**
* Implements hook_rdf_mapping().
*/
function node_rdf_mapping() {
return array(
array(
'type' => 'node',
'bundle' => RDF_DEFAULT_BUNDLE,
'mapping' => array(
'rdftype' => array('sioc:Item', 'foaf:Document'),
'title' => array(
'predicates' => array('dc:title'),
),
'created' => array(
'predicates' => array('dc:date', 'dc:created'),
'datatype' => 'xsd:dateTime',
'callback' => 'date_iso8601',
),
'changed' => array(
'predicates' => array('dc:modified'),
'datatype' => 'xsd:dateTime',
'callback' => 'date_iso8601',
),
'body' => array(
'predicates' => array('content:encoded'),
),
'uid' => array(
'predicates' => array('sioc:has_creator'),
'type' => 'rel',
),
'name' => array(
'predicates' => array('foaf:name'),
),
'comment_count' => array(
'predicates' => array('sioc:num_replies'),
'datatype' => 'xsd:integer',
),
'last_activity' => array(
'predicates' => array('sioc:last_activity_date'),
'datatype' => 'xsd:dateTime',
'callback' => 'date_iso8601',
),
),
),
);
}
/**
* Determines whether a node hook exists.
*
* @param $node
* A node object or a string containing the node type.
* @param $hook
* A string containing the name of the hook.
*
* @return
* TRUE if the $hook exists in the node type of $node.
*/
function node_hook($node, $hook) {
$base = node_type_get_base($node);
return module_hook($base, $hook);
}
/**
* Invokes a node hook.
*
* @param $node
* A node object or a string containing the node type.
* @param $hook
* A string containing the name of the hook.
* @param $a2, $a3, $a4
* Arguments to pass on to the hook, after the $node argument.
*
* @return
* The returned value of the invoked hook.
*/
function node_invoke($node, $hook, $a2 = NULL, $a3 = NULL, $a4 = NULL) {
if (node_hook($node, $hook)) {
$base = node_type_get_base($node);
$function = $base . '_' . $hook;
return ($function($node, $a2, $a3, $a4));
}
}
/**
* Loads node entities from the database.
*
* This function should be used whenever you need to load more than one node
* from the database. Nodes are loaded into memory and will not require database
* access if loaded again during the same page request.
*
* @see entity_load()
* @see EntityFieldQuery
*
* @param $nids
* An array of node IDs.
* @param $conditions
* (deprecated) An associative array of conditions on the {node}
* table, where the keys are the database fields and the values are the
* values those fields must have. Instead, it is preferable to use
* EntityFieldQuery to retrieve a list of entity IDs loadable by
* this function.
* @param $reset
* Whether to reset the internal node_load cache.
*
* @return
* An array of node objects indexed by nid.
*
* @todo Remove $conditions in Drupal 8.
*/
function node_load_multiple($nids = array(), $conditions = array(), $reset = FALSE) {
return entity_load('node', $nids, $conditions, $reset);
}
/**
* Loads a node object from the database.
*
* @param $nid
* The node ID.
* @param $vid
* The revision ID.
* @param $reset
* Whether to reset the node_load_multiple cache.
*
* @return
* A fully-populated node object, or FALSE if the node is not found.
*/
function node_load($nid = NULL, $vid = NULL, $reset = FALSE) {
$nids = (isset($nid) ? array($nid) : array());
$conditions = (isset($vid) ? array('vid' => $vid) : array());
$node = node_load_multiple($nids, $conditions, $reset);
return $node ? reset($node) : FALSE;
}
/**
* Prepares a node object for editing.
*
* Fills in a few default values, and then invokes hook_prepare() on the node
* type module, and hook_node_prepare() on all modules.
*
* @param $node
* A node object.
*/
function node_object_prepare($node) {
// Set up default values, if required.
$node_options = variable_get('node_options_' . $node->type, array('status', 'promote'));
// If this is a new node, fill in the default values.
if (!isset($node->nid) || isset($node->is_new)) {
foreach (array('status', 'promote', 'sticky') as $key) {
// Multistep node forms might have filled in something already.
if (!isset($node->$key)) {
$node->$key = (int) in_array($key, $node_options);
}
}
global $user;
$node->uid = $user->uid;
$node->created = REQUEST_TIME;
}
else {
$node->date = format_date($node->created, 'custom', 'Y-m-d H:i:s O');
// Remove the log message from the original node object.
$node->log = NULL;
}
// Always use the default revision setting.
$node->revision = in_array('revision', $node_options);
node_invoke($node, 'prepare');
module_invoke_all('node_prepare', $node);
}
/**
* Implements hook_validate().
*
* Performs validation checks on the given node.
*/
function node_validate($node, $form, &$form_state) {
if (isset($node->nid) && (node_last_changed($node->nid) > $node->changed)) {
form_set_error('changed', t('The content on this page has either been modified by another user, or you have already submitted modifications using this form. As a result, your changes cannot be saved.'));
}
// Validate the "authored by" field.
if (!empty($node->name) && !($account = user_load_by_name($node->name))) {
// The use of empty() is mandatory in the context of usernames
// as the empty string denotes the anonymous user. In case we
// are dealing with an anonymous user we set the user ID to 0.
form_set_error('name', t('The username %name does not exist.', array('%name' => $node->name)));
}
// Validate the "authored on" field.
if (!empty($node->date) && strtotime($node->date) === FALSE) {
form_set_error('date', t('You have to specify a valid date.'));
}
// Invoke hook_validate() for node type specific validation and
// hook_node_validate() for miscellaneous validation needed by modules. Can't
// use node_invoke() or module_invoke_all(), because $form_state must be
// receivable by reference.
$function = node_type_get_base($node) . '_validate';
if (function_exists($function)) {
$function($node, $form, $form_state);
}
foreach (module_implements('node_validate') as $module) {
$function = $module . '_node_validate';
$function($node, $form, $form_state);
}
}
/**
* Prepares node for saving by populating author and creation date.
*
* @param $node
* A node object.
*
* @return
* An updated node object.
*/
function node_submit($node) {
// A user might assign the node author by entering a user name in the node
// form, which we then need to translate to a user ID.
if (isset($node->name)) {
if ($account = user_load_by_name($node->name)) {
$node->uid = $account->uid;
}
else {
$node->uid = 0;
}
}
$node->created = !empty($node->date) ? strtotime($node->date) : REQUEST_TIME;
$node->validated = TRUE;
return $node;
}
/**
* Saves changes to a node or adds a new node.
*
* @param $node
* The $node object to be saved. If $node->nid is
* omitted (or $node->is_new is TRUE), a new node will be added.
*/
function node_save($node) {
$transaction = db_transaction();
try {
// Load the stored entity, if any.
if (!empty($node->nid) && !isset($node->original)) {
$node->original = entity_load_unchanged('node', $node->nid);
}
field_attach_presave('node', $node);
global $user;
// Determine if we will be inserting a new node.
if (!isset($node->is_new)) {
$node->is_new = empty($node->nid);
}
// Set the timestamp fields.
if (empty($node->created)) {
$node->created = REQUEST_TIME;
}
// The changed timestamp is always updated for bookkeeping purposes,
// for example: revisions, searching, etc.
$node->changed = REQUEST_TIME;
$node->timestamp = REQUEST_TIME;
$update_node = TRUE;
// Let modules modify the node before it is saved to the database.
module_invoke_all('node_presave', $node);
module_invoke_all('entity_presave', $node, 'node');
if ($node->is_new || !empty($node->revision)) {
// When inserting either a new node or a new node revision, $node->log
// must be set because {node_revision}.log is a text column and therefore
// cannot have a default value. However, it might not be set at this
// point (for example, if the user submitting a node form does not have
// permission to create revisions), so we ensure that it is at least an
// empty string in that case.
// @todo: Make the {node_revision}.log column nullable so that we can
// remove this check.
if (!isset($node->log)) {
$node->log = '';
}
}
elseif (!isset($node->log) || $node->log === '') {
// If we are updating an existing node without adding a new revision, we
// need to make sure $node->log is unset whenever it is empty. As long as
// $node->log is unset, drupal_write_record() will not attempt to update
// the existing database column when re-saving the revision; therefore,
// this code allows us to avoid clobbering an existing log entry with an
// empty one.
unset($node->log);
}
// When saving a new node revision, unset any existing $node->vid so as to
// ensure that a new revision will actually be created, then store the old
// revision ID in a separate property for use by node hook implementations.
if (!$node->is_new && !empty($node->revision) && $node->vid) {
$node->old_vid = $node->vid;
unset($node->vid);
}
// Save the node and node revision.
if ($node->is_new) {
// For new nodes, save new records for both the node itself and the node
// revision.
drupal_write_record('node', $node);
_node_save_revision($node, $user->uid);
$op = 'insert';
}
else {
// For existing nodes, update the node record which matches the value of
// $node->nid.
drupal_write_record('node', $node, 'nid');
// Then, if a new node revision was requested, save a new record for
// that; otherwise, update the node revision record which matches the
// value of $node->vid.
if (!empty($node->revision)) {
_node_save_revision($node, $user->uid);
}
else {
_node_save_revision($node, $user->uid, 'vid');
$update_node = FALSE;
}
$op = 'update';
}
if ($update_node) {
db_update('node')
->fields(array('vid' => $node->vid))
->condition('nid', $node->nid)
->execute();
}
// Call the node specific callback (if any). This can be
// node_invoke($node, 'insert') or
// node_invoke($node, 'update').
node_invoke($node, $op);
// Save fields.
$function = "field_attach_$op";
$function('node', $node);
module_invoke_all('node_' . $op, $node);
module_invoke_all('entity_' . $op, $node, 'node');
// Update the node access table for this node.
node_access_acquire_grants($node);
// Clear internal properties.
unset($node->is_new);
unset($node->original);
// Clear the static loading cache.
entity_get_controller('node')->resetCache(array($node->nid));
// Ignore slave server temporarily to give time for the
// saved node to be propagated to the slave.
db_ignore_slave();
}
catch (Exception $e) {
$transaction->rollback();
watchdog_exception('node', $e);
throw $e;
}
}
/**
* Helper function to save a revision with the uid of the current user.
*
* The resulting revision ID is available afterward in $node->vid.
*
* @param $node
* A node object.
* @param $uid
* The current user's UID.
* @param $update
* (optional) An array of primary keys' field names to update.
*/
function _node_save_revision($node, $uid, $update = NULL) {
$temp_uid = $node->uid;
$node->uid = $uid;
if (isset($update)) {
drupal_write_record('node_revision', $node, $update);
}
else {
drupal_write_record('node_revision', $node);
}
// Have node object still show node owner's uid, not revision author's.
$node->uid = $temp_uid;
}
/**
* Deletes a node.
*
* @param $nid
* A node ID.
*/
function node_delete($nid) {
node_delete_multiple(array($nid));
}
/**
* Deletes multiple nodes.
*
* @param $nids
* An array of node IDs.
*/
function node_delete_multiple($nids) {
$transaction = db_transaction();
if (!empty($nids)) {
$nodes = node_load_multiple($nids, array());
try {
foreach ($nodes as $nid => $node) {
// Call the node-specific callback (if any):
node_invoke($node, 'delete');
module_invoke_all('node_delete', $node);
module_invoke_all('entity_delete', $node, 'node');
field_attach_delete('node', $node);
// Remove this node from the search index if needed.
// This code is implemented in node module rather than in search module,
// because node module is implementing search module's API, not the other
// way around.
if (module_exists('search')) {
search_reindex($nid, 'node');
}
}
// Delete after calling hooks so that they can query node tables as needed.
db_delete('node')
->condition('nid', $nids, 'IN')
->execute();
db_delete('node_revision')
->condition('nid', $nids, 'IN')
->execute();
db_delete('history')
->condition('nid', $nids, 'IN')
->execute();
db_delete('node_access')
->condition('nid', $nids, 'IN')
->execute();
}
catch (Exception $e) {
$transaction->rollback();
watchdog_exception('node', $e);
throw $e;
}
// Clear the page and block and node_load_multiple caches.
entity_get_controller('node')->resetCache();
}
}
/**
* Deletes a node revision.
*
* @param $revision_id
* The revision ID to delete.
*/
function node_revision_delete($revision_id) {
if ($revision = node_load(NULL, $revision_id)) {
// Prevent deleting the current revision.
$node = node_load($revision->nid);
if ($revision_id == $node->vid) {
return FALSE;
}
db_delete('node_revision')
->condition('nid', $revision->nid)
->condition('vid', $revision->vid)
->execute();
module_invoke_all('node_revision_delete', $revision);
field_attach_delete_revision('node', $revision);
return TRUE;
}
return FALSE;
}
/**
* Generates an array for rendering the given node.
*
* @param $node
* A node object.
* @param $view_mode
* View mode, e.g. 'full', 'teaser'...
* @param $langcode
* (optional) A language code to use for rendering. Defaults to the global
* content language of the current request.
*
* @return
* An array as expected by drupal_render().
*/
function node_view($node, $view_mode = 'full', $langcode = NULL) {
if (!isset($langcode)) {
$langcode = $GLOBALS['language_content']->language;
}
// Populate $node->content with a render() array.
node_build_content($node, $view_mode, $langcode);
$build = $node->content;
// We don't need duplicate rendering info in node->content.
unset($node->content);
$build += array(
'#theme' => 'node',
'#node' => $node,
'#view_mode' => $view_mode,
'#language' => $langcode,
);
// Add contextual links for this node, except when the node is already being
// displayed on its own page. Modules may alter this behavior (for example,
// to restrict contextual links to certain view modes) by implementing
// hook_node_view_alter().
if (!empty($node->nid) && !($view_mode == 'full' && node_is_page($node))) {
$build['#contextual_links']['node'] = array('node', array($node->nid));
}
// Allow modules to modify the structured node.
$type = 'node';
drupal_alter(array('node_view', 'entity_view'), $build, $type);
return $build;
}
/**
* Builds a structured array representing the node's content.
*
* The content built for the node (field values, comments, file attachments or
* other node components) will vary depending on the $view_mode parameter.
*
* Drupal core defines the following view modes for nodes, with the following
* default use cases:
* - full (default): node is being displayed on its own page (node/123)
* - teaser: node is being displayed on the default home page listing, on
* taxonomy listing pages, or on blog listing pages.
* - rss: node displayed in an RSS feed.
* If search.module is enabled:
* - search_index: node is being indexed for search.
* - search_result: node is being displayed as a search result.
* If book.module is enabled:
* - print: node is being displayed in print-friendly mode.
* Contributed modules might define additional view modes, or use existing
* view modes in additional contexts.
*
* @param $node
* A node object.
* @param $view_mode
* View mode, e.g. 'full', 'teaser'...
* @param $langcode
* (optional) A language code to use for rendering. Defaults to the global
* content language of the current request.
*/
function node_build_content($node, $view_mode = 'full', $langcode = NULL) {
if (!isset($langcode)) {
$langcode = $GLOBALS['language_content']->language;
}
// Remove previously built content, if exists.
$node->content = array();
// Allow modules to change the view mode.
$view_mode = key(entity_view_mode_prepare('node', array($node->nid => $node), $view_mode, $langcode));
// The 'view' hook can be implemented to overwrite the default function
// to display nodes.
if (node_hook($node, 'view')) {
$node = node_invoke($node, 'view', $view_mode, $langcode);
}
// Build fields content.
// In case of a multiple view, node_view_multiple() already ran the
// 'prepare_view' step. An internal flag prevents the operation from running
// twice.
field_attach_prepare_view('node', array($node->nid => $node), $view_mode, $langcode);
entity_prepare_view('node', array($node->nid => $node), $langcode);
$node->content += field_attach_view('node', $node, $view_mode, $langcode);
// Always display a read more link on teasers because we have no way to know
// when a teaser view is different than a full view.
$links = array();
$node->content['links'] = array(
'#theme' => 'links__node',
'#pre_render' => array('drupal_pre_render_links'),
'#attributes' => array('class' => array('links', 'inline')),
);
if ($view_mode == 'teaser') {
$node_title_stripped = strip_tags($node->title);
$links['node-readmore'] = array(
'title' => t('Read more about @title ', array('@title' => $node_title_stripped)),
'href' => 'node/' . $node->nid,
'html' => TRUE,
'attributes' => array('rel' => 'tag', 'title' => $node_title_stripped),
);
}
$node->content['links']['node'] = array(
'#theme' => 'links__node__node',
'#links' => $links,
'#attributes' => array('class' => array('links', 'inline')),
);
// Allow modules to make their own additions to the node.
module_invoke_all('node_view', $node, $view_mode, $langcode);
module_invoke_all('entity_view', $node, 'node', $view_mode, $langcode);
// Make sure the current view mode is stored if no module has already
// populated the related key.
$node->content += array('#view_mode' => $view_mode);
}
/**
* Generates an array which displays a node detail page.
*
* @param $node
* A node object.
* @param $message
* A flag which sets a page title relevant to the revision being viewed.
*
* @return
* A $page element suitable for use by drupal_render().
*/
function node_show($node, $message = FALSE) {
if ($message) {
drupal_set_title(t('Revision of %title from %date', array('%title' => $node->title, '%date' => format_date($node->revision_timestamp))), PASS_THROUGH);
}
// For markup consistency with other pages, use node_view_multiple() rather than node_view().
$nodes = node_view_multiple(array($node->nid => $node), 'full');
// Update the history table, stating that this user viewed this node.
node_tag_new($node);
return $nodes;
}
/**
* Returns whether the current page is the full page view of the passed-in node.
*
* @param $node
* A node object.
*
* @return
* The ID of the node if this is a full page view, otherwise FALSE.
*/
function node_is_page($node) {
$page_node = menu_get_object();
return (!empty($page_node) ? $page_node->nid == $node->nid : FALSE);
}
/**
* Processes variables for node.tpl.php
*
* Most themes utilize their own copy of node.tpl.php. The default is located
* inside "modules/node/node.tpl.php". Look in there for the full list of
* variables.
*
* The $variables array contains the following arguments:
* - $node
* - $view_mode
* - $page
*
* @see node.tpl.php
*/
function template_preprocess_node(&$variables) {
$variables['view_mode'] = $variables['elements']['#view_mode'];
// Provide a distinct $teaser boolean.
$variables['teaser'] = $variables['view_mode'] == 'teaser';
$variables['node'] = $variables['elements']['#node'];
$node = $variables['node'];
$variables['date'] = format_date($node->created);
$variables['name'] = theme('username', array('account' => $node));
$uri = entity_uri('node', $node);
$variables['node_url'] = url($uri['path'], $uri['options']);
$variables['title'] = check_plain($node->title);
$variables['page'] = $variables['view_mode'] == 'full' && node_is_page($node);
// Flatten the node object's member fields.
$variables = array_merge((array) $node, $variables);
// Helpful $content variable for templates.
$variables += array('content' => array());
foreach (element_children($variables['elements']) as $key) {
$variables['content'][$key] = $variables['elements'][$key];
}
// Make the field variables available with the appropriate language.
field_attach_preprocess('node', $node, $variables['content'], $variables);
// Display post information only on certain node types.
if (variable_get('node_submitted_' . $node->type, TRUE)) {
$variables['display_submitted'] = TRUE;
$variables['submitted'] = t('Submitted by !username on !datetime', array('!username' => $variables['name'], '!datetime' => $variables['date']));
$variables['user_picture'] = theme_get_setting('toggle_node_user_picture') ? theme('user_picture', array('account' => $node)) : '';
}
else {
$variables['display_submitted'] = FALSE;
$variables['submitted'] = '';
$variables['user_picture'] = '';
}
// Gather node classes.
$variables['classes_array'][] = drupal_html_class('node-' . $node->type);
if ($variables['promote']) {
$variables['classes_array'][] = 'node-promoted';
}
if ($variables['sticky']) {
$variables['classes_array'][] = 'node-sticky';
}
if (!$variables['status']) {
$variables['classes_array'][] = 'node-unpublished';
}
if ($variables['teaser']) {
$variables['classes_array'][] = 'node-teaser';
}
if (isset($variables['preview'])) {
$variables['classes_array'][] = 'node-preview';
}
// Clean up name so there are no underscores.
$variables['theme_hook_suggestions'][] = 'node__' . $node->type;
$variables['theme_hook_suggestions'][] = 'node__' . $node->nid;
}
/**
* Implements hook_permission().
*/
function node_permission() {
$perms = array(
'bypass node access' => array(
'title' => t('Bypass content access control'),
'description' => t('View, edit and delete all content regardless of permission restrictions.'),
'restrict access' => TRUE,
),
'administer content types' => array(
'title' => t('Administer content types'),
'restrict access' => TRUE,
),
'administer nodes' => array(
'title' => t('Administer content'),
'restrict access' => TRUE,
),
'access content overview' => array(
'title' => t('Access the content overview page'),
'description' => t('Get an overview of all content .', array('@url' => url('admin/content'))),
),
'access content' => array(
'title' => t('View published content'),
),
'view own unpublished content' => array(
'title' => t('View own unpublished content'),
),
'view revisions' => array(
'title' => t('View content revisions'),
),
'revert revisions' => array(
'title' => t('Revert content revisions'),
),
'delete revisions' => array(
'title' => t('Delete content revisions'),
),
);
// Generate standard node permissions for all applicable node types.
foreach (node_permissions_get_configured_types() as $type) {
$perms += node_list_permissions($type);
}
return $perms;
}
/**
* Gathers the rankings from the hook_ranking() implementations.
*
* @param $query
* A query object that has been extended with the Search DB Extender.
*/
function _node_rankings(SelectQueryExtender $query) {
if ($ranking = module_invoke_all('ranking')) {
$tables = &$query->getTables();
foreach ($ranking as $rank => $values) {
if ($node_rank = variable_get('node_rank_' . $rank, 0)) {
// If the table defined in the ranking isn't already joined, then add it.
if (isset($values['join']) && !isset($tables[$values['join']['alias']])) {
$query->addJoin($values['join']['type'], $values['join']['table'], $values['join']['alias'], $values['join']['on']);
}
$arguments = isset($values['arguments']) ? $values['arguments'] : array();
$query->addScore($values['score'], $arguments, $node_rank);
}
}
}
}
/**
* Implements hook_search_info().
*/
function node_search_info() {
return array(
'title' => 'Content',
'path' => 'node',
);
}
/**
* Implements hook_search_access().
*/
function node_search_access() {
return user_access('access content');
}
/**
* Implements hook_search_reset().
*/
function node_search_reset() {
db_update('search_dataset')
->fields(array('reindex' => REQUEST_TIME))
->condition('type', 'node')
->execute();
}
/**
* Implements hook_search_status().
*/
function node_search_status() {
$total = db_query('SELECT COUNT(*) FROM {node}')->fetchField();
$remaining = db_query("SELECT COUNT(*) FROM {node} n LEFT JOIN {search_dataset} d ON d.type = 'node' AND d.sid = n.nid WHERE d.sid IS NULL OR d.reindex <> 0")->fetchField();
return array('remaining' => $remaining, 'total' => $total);
}
/**
* Implements hook_search_admin().
*/
function node_search_admin() {
// Output form for defining rank factor weights.
$form['content_ranking'] = array(
'#type' => 'fieldset',
'#title' => t('Content ranking'),
);
$form['content_ranking']['#theme'] = 'node_search_admin';
$form['content_ranking']['info'] = array(
'#markup' => '' . t('Influence is a numeric multiplier used in ordering search results. A higher number means the corresponding factor has more influence on search results; zero means the factor is ignored. Changing these numbers does not require the search index to be rebuilt. Changes take effect immediately.') . '
'
);
// Note: reversed to reflect that higher number = higher ranking.
$options = drupal_map_assoc(range(0, 10));
foreach (module_invoke_all('ranking') as $var => $values) {
$form['content_ranking']['factors']['node_rank_' . $var] = array(
'#title' => $values['title'],
'#type' => 'select',
'#options' => $options,
'#default_value' => variable_get('node_rank_' . $var, 0),
);
}
return $form;
}
/**
* Implements hook_search_execute().
*/
function node_search_execute($keys = NULL, $conditions = NULL) {
// Build matching conditions
$query = db_select('search_index', 'i', array('target' => 'slave'))->extend('SearchQuery')->extend('PagerDefault');
$query->join('node', 'n', 'n.nid = i.sid');
$query
->condition('n.status', 1)
->addTag('node_access')
->searchExpression($keys, 'node');
// Insert special keywords.
$query->setOption('type', 'n.type');
$query->setOption('language', 'n.language');
if ($query->setOption('term', 'ti.tid')) {
$query->join('taxonomy_index', 'ti', 'n.nid = ti.nid');
}
// Only continue if the first pass query matches.
if (!$query->executeFirstPass()) {
return array();
}
// Add the ranking expressions.
_node_rankings($query);
// Load results.
$find = $query
->limit(10)
->execute();
$results = array();
foreach ($find as $item) {
// Render the node.
$node = node_load($item->sid);
$build = node_view($node, 'search_result');
unset($build['#theme']);
$node->rendered = drupal_render($build);
// Fetch comments for snippet.
$node->rendered .= ' ' . module_invoke('comment', 'node_update_index', $node);
$extra = module_invoke_all('node_search_result', $node);
$uri = entity_uri('node', $node);
$results[] = array(
'link' => url($uri['path'], array_merge($uri['options'], array('absolute' => TRUE))),
'type' => check_plain(node_type_get_name($node)),
'title' => $node->title,
'user' => theme('username', array('account' => $node)),
'date' => $node->changed,
'node' => $node,
'extra' => $extra,
'score' => $item->calculated_score,
'snippet' => search_excerpt($keys, $node->rendered),
'language' => entity_language('node', $node),
);
}
return $results;
}
/**
* Implements hook_ranking().
*/
function node_ranking() {
// Create the ranking array and add the basic ranking options.
$ranking = array(
'relevance' => array(
'title' => t('Keyword relevance'),
// Average relevance values hover around 0.15
'score' => 'i.relevance',
),
'sticky' => array(
'title' => t('Content is sticky at top of lists'),
// The sticky flag is either 0 or 1, which is automatically normalized.
'score' => 'n.sticky',
),
'promote' => array(
'title' => t('Content is promoted to the front page'),
// The promote flag is either 0 or 1, which is automatically normalized.
'score' => 'n.promote',
),
);
// Add relevance based on creation or changed date.
if ($node_cron_last = variable_get('node_cron_last', 0)) {
$ranking['recent'] = array(
'title' => t('Recently posted'),
// Exponential decay with half-life of 6 months, starting at last indexed node
'score' => 'POW(2.0, (GREATEST(n.created, n.changed) - :node_cron_last) * 6.43e-8)',
'arguments' => array(':node_cron_last' => $node_cron_last),
);
}
return $ranking;
}
/**
* Implements hook_user_cancel().
*/
function node_user_cancel($edit, $account, $method) {
switch ($method) {
case 'user_cancel_block_unpublish':
// Unpublish nodes (current revisions).
module_load_include('inc', 'node', 'node.admin');
$nodes = db_select('node', 'n')
->fields('n', array('nid'))
->condition('uid', $account->uid)
->execute()
->fetchCol();
node_mass_update($nodes, array('status' => 0));
break;
case 'user_cancel_reassign':
// Anonymize nodes (current revisions).
module_load_include('inc', 'node', 'node.admin');
$nodes = db_select('node', 'n')
->fields('n', array('nid'))
->condition('uid', $account->uid)
->execute()
->fetchCol();
node_mass_update($nodes, array('uid' => 0));
// Anonymize old revisions.
db_update('node_revision')
->fields(array('uid' => 0))
->condition('uid', $account->uid)
->execute();
// Clean history.
db_delete('history')
->condition('uid', $account->uid)
->execute();
break;
}
}
/**
* Implements hook_user_delete().
*/
function node_user_delete($account) {
// Delete nodes (current revisions).
// @todo Introduce node_mass_delete() or make node_mass_update() more flexible.
$nodes = db_select('node', 'n')
->fields('n', array('nid'))
->condition('uid', $account->uid)
->execute()
->fetchCol();
node_delete_multiple($nodes);
// Delete old revisions.
$revisions = db_query('SELECT vid FROM {node_revision} WHERE uid = :uid', array(':uid' => $account->uid))->fetchCol();
foreach ($revisions as $revision) {
node_revision_delete($revision);
}
// Clean history.
db_delete('history')
->condition('uid', $account->uid)
->execute();
}
/**
* Returns HTML for the content ranking part of the search settings admin page.
*
* @param $variables
* An associative array containing:
* - form: A render element representing the form.
*
* @see node_search_admin()
* @ingroup themeable
*/
function theme_node_search_admin($variables) {
$form = $variables['form'];
$output = drupal_render($form['info']);
$header = array(t('Factor'), t('Influence'));
foreach (element_children($form['factors']) as $key) {
$row = array();
$row[] = $form['factors'][$key]['#title'];
$form['factors'][$key]['#title_display'] = 'invisible';
$row[] = drupal_render($form['factors'][$key]);
$rows[] = $row;
}
$output .= theme('table', array('header' => $header, 'rows' => $rows));
$output .= drupal_render_children($form);
return $output;
}
/**
* Access callback: Checks node revision access.
*
* @param $node
* The node to check.
* @param $op
* (optional) The specific operation being checked. Defaults to 'view.'
* @param object $account
* (optional) A user object representing the user for whom the operation is
* to be performed. Determines access for a user other than the current user.
*
* @return
* TRUE if the operation may be performed, FALSE otherwise.
*
* @see node_menu()
*/
function _node_revision_access($node, $op = 'view', $account = NULL) {
$access = &drupal_static(__FUNCTION__, array());
$map = array(
'view' => 'view revisions',
'update' => 'revert revisions',
'delete' => 'delete revisions',
);
if (!$node || !isset($map[$op])) {
// If there was no node to check against, or the $op was not one of the
// supported ones, we return access denied.
return FALSE;
}
if (!isset($account)) {
$account = $GLOBALS['user'];
}
// Statically cache access by revision ID, user account ID, and operation.
$cid = $node->vid . ':' . $account->uid . ':' . $op;
if (!isset($access[$cid])) {
// Perform basic permission checks first.
if (!user_access($map[$op], $account) && !user_access('administer nodes', $account)) {
return $access[$cid] = FALSE;
}
$node_current_revision = node_load($node->nid);
$is_current_revision = $node_current_revision->vid == $node->vid;
// There should be at least two revisions. If the vid of the given node and
// the vid of the current revision differ, then we already have two
// different revisions so there is no need for a separate database check.
// Also, if you try to revert to or delete the current revision, that's not
// good.
if ($is_current_revision && (db_query('SELECT COUNT(vid) FROM {node_revision} WHERE nid = :nid', array(':nid' => $node->nid))->fetchField() == 1 || $op == 'update' || $op == 'delete')) {
$access[$cid] = FALSE;
}
elseif (user_access('administer nodes', $account)) {
$access[$cid] = TRUE;
}
else {
// First check the access to the current revision and finally, if the node
// passed in is not the current revision then access to that, too.
$access[$cid] = node_access($op, $node_current_revision, $account) && ($is_current_revision || node_access($op, $node, $account));
}
}
return $access[$cid];
}
/**
* Access callback: Checks whether the user has permission to add a node.
*
* @return
* TRUE if the user has add permission, otherwise FALSE.
*
* @see node_menu()
*/
function _node_add_access() {
$types = node_type_get_types();
foreach ($types as $type) {
if (node_hook($type->type, 'form') && node_access('create', $type->type)) {
return TRUE;
}
}
if (user_access('administer content types')) {
// There are no content types defined that the user has permission to create,
// but the user does have the permission to administer the content types, so
// grant them access to the page anyway.
return TRUE;
}
return FALSE;
}
/**
* Implements hook_menu().
*/
function node_menu() {
$items['admin/content'] = array(
'title' => 'Content',
'description' => 'Find and manage content.',
'page callback' => 'drupal_get_form',
'page arguments' => array('node_admin_content'),
'access arguments' => array('access content overview'),
'weight' => -10,
'file' => 'node.admin.inc',
);
$items['admin/content/node'] = array(
'title' => 'Content',
'type' => MENU_DEFAULT_LOCAL_TASK,
'weight' => -10,
);
$items['admin/reports/status/rebuild'] = array(
'title' => 'Rebuild permissions',
'page callback' => 'drupal_get_form',
'page arguments' => array('node_configure_rebuild_confirm'),
// Any user than can potentially trigger a node_access_needs_rebuild(TRUE)
// has to be allowed access to the 'node access rebuild' confirm form.
'access arguments' => array('access administration pages'),
'type' => MENU_CALLBACK,
'file' => 'node.admin.inc',
);
$items['admin/structure/types'] = array(
'title' => 'Content types',
'description' => 'Manage content types, including default status, front page promotion, comment settings, etc.',
'page callback' => 'node_overview_types',
'access arguments' => array('administer content types'),
'file' => 'content_types.inc',
);
$items['admin/structure/types/list'] = array(
'title' => 'List',
'type' => MENU_DEFAULT_LOCAL_TASK,
'weight' => -10,
);
$items['admin/structure/types/add'] = array(
'title' => 'Add content type',
'page callback' => 'drupal_get_form',
'page arguments' => array('node_type_form'),
'access arguments' => array('administer content types'),
'type' => MENU_LOCAL_ACTION,
'file' => 'content_types.inc',
);
$items['admin/structure/types/manage/%node_type'] = array(
'title' => 'Edit content type',
'title callback' => 'node_type_page_title',
'title arguments' => array(4),
'page callback' => 'drupal_get_form',
'page arguments' => array('node_type_form', 4),
'access arguments' => array('administer content types'),
'file' => 'content_types.inc',
);
$items['admin/structure/types/manage/%node_type/edit'] = array(
'title' => 'Edit',
'type' => MENU_DEFAULT_LOCAL_TASK,
);
$items['admin/structure/types/manage/%node_type/delete'] = array(
'title' => 'Delete',
'page arguments' => array('node_type_delete_confirm', 4),
'access arguments' => array('administer content types'),
'file' => 'content_types.inc',
);
$items['node'] = array(
'page callback' => 'node_page_default',
'access arguments' => array('access content'),
'menu_name' => 'navigation',
'type' => MENU_CALLBACK,
);
$items['node/add'] = array(
'title' => 'Add content',
'page callback' => 'node_add_page',
'access callback' => '_node_add_access',
'file' => 'node.pages.inc',
);
$items['rss.xml'] = array(
'title' => 'RSS feed',
'page callback' => 'node_feed',
'access arguments' => array('access content'),
'type' => MENU_CALLBACK,
// Pass a FALSE and array argument to ensure that additional path components
// are not passed to node_feed().
'page arguments' => array(FALSE, array()),
);
// @todo Remove this loop when we have a 'description callback' property.
// Reset internal static cache of _node_types_build(), forces to rebuild the
// node type information.
node_type_cache_reset();
foreach (node_type_get_types() as $type) {
$type_url_str = str_replace('_', '-', $type->type);
$items['node/add/' . $type_url_str] = array(
'title' => $type->name,
'title callback' => 'check_plain',
'page callback' => 'node_add',
'page arguments' => array($type->type),
'access callback' => 'node_access',
'access arguments' => array('create', $type->type),
'description' => $type->description,
'file' => 'node.pages.inc',
);
}
$items['node/%node'] = array(
'title callback' => 'node_page_title',
'title arguments' => array(1),
// The page callback also invokes drupal_set_title() in case
// the menu router's title is overridden by a menu link.
'page callback' => 'node_page_view',
'page arguments' => array(1),
'access callback' => 'node_access',
'access arguments' => array('view', 1),
);
$items['node/%node/view'] = array(
'title' => 'View',
'type' => MENU_DEFAULT_LOCAL_TASK,
'weight' => -10,
);
$items['node/%node/edit'] = array(
'title' => 'Edit',
'page callback' => 'node_page_edit',
'page arguments' => array(1),
'access callback' => 'node_access',
'access arguments' => array('update', 1),
'weight' => 0,
'type' => MENU_LOCAL_TASK,
'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
'file' => 'node.pages.inc',
);
$items['node/%node/delete'] = array(
'title' => 'Delete',
'page callback' => 'drupal_get_form',
'page arguments' => array('node_delete_confirm', 1),
'access callback' => 'node_access',
'access arguments' => array('delete', 1),
'weight' => 1,
'type' => MENU_LOCAL_TASK,
'context' => MENU_CONTEXT_INLINE,
'file' => 'node.pages.inc',
);
$items['node/%node/revisions'] = array(
'title' => 'Revisions',
'page callback' => 'node_revision_overview',
'page arguments' => array(1),
'access callback' => '_node_revision_access',
'access arguments' => array(1),
'weight' => 2,
'type' => MENU_LOCAL_TASK,
'file' => 'node.pages.inc',
);
$items['node/%node/revisions/%/view'] = array(
'title' => 'Revisions',
'load arguments' => array(3),
'page callback' => 'node_show',
'page arguments' => array(1, TRUE),
'access callback' => '_node_revision_access',
'access arguments' => array(1),
);
$items['node/%node/revisions/%/revert'] = array(
'title' => 'Revert to earlier revision',
'load arguments' => array(3),
'page callback' => 'drupal_get_form',
'page arguments' => array('node_revision_revert_confirm', 1),
'access callback' => '_node_revision_access',
'access arguments' => array(1, 'update'),
'file' => 'node.pages.inc',
);
$items['node/%node/revisions/%/delete'] = array(
'title' => 'Delete earlier revision',
'load arguments' => array(3),
'page callback' => 'drupal_get_form',
'page arguments' => array('node_revision_delete_confirm', 1),
'access callback' => '_node_revision_access',
'access arguments' => array(1, 'delete'),
'file' => 'node.pages.inc',
);
return $items;
}
/**
* Implements hook_menu_local_tasks_alter().
*/
function node_menu_local_tasks_alter(&$data, $router_item, $root_path) {
// Add action link to 'node/add' on 'admin/content' page.
if ($root_path == 'admin/content') {
$item = menu_get_item('node/add');
if ($item['access']) {
$data['actions']['output'][] = array(
'#theme' => 'menu_local_action',
'#link' => $item,
);
}
}
}
/**
* Title callback: Returns the unsanitized title of the node type edit form.
*
* @param $type
* The node type object.
*
* @return string
* An unsanitized string that is the title of the node type edit form.
*
* @see node_menu()
*/
function node_type_page_title($type) {
return $type->name;
}
/**
* Title callback: Returns the title of the node.
*
* @param $node
* The node object.
*
* @return
* An unsanitized string that is the title of the node.
*
* @see node_menu()
*/
function node_page_title($node) {
return $node->title;
}
/**
* Finds the last time a node was changed.
*
* @param $nid
* The ID of a node.
*
* @return
* A unix timestamp indicating the last time the node was changed.
*/
function node_last_changed($nid) {
return db_query('SELECT changed FROM {node} WHERE nid = :nid', array(':nid' => $nid))->fetch()->changed;
}
/**
* Returns a list of all the existing revision numbers.
*
* @param $node
* The node object.
*
* @return
* An associative array keyed by node revision number.
*/
function node_revision_list($node) {
$revisions = array();
$result = db_query('SELECT r.vid, r.title, r.log, r.uid, n.vid AS current_vid, r.timestamp, u.name FROM {node_revision} r LEFT JOIN {node} n ON n.vid = r.vid INNER JOIN {users} u ON u.uid = r.uid WHERE r.nid = :nid ORDER BY r.vid DESC', array(':nid' => $node->nid));
foreach ($result as $revision) {
$revisions[$revision->vid] = $revision;
}
return $revisions;
}
/**
* Implements hook_block_info().
*/
function node_block_info() {
$blocks['syndicate']['info'] = t('Syndicate');
// Not worth caching.
$blocks['syndicate']['cache'] = DRUPAL_NO_CACHE;
$blocks['recent']['info'] = t('Recent content');
$blocks['recent']['properties']['administrative'] = TRUE;
return $blocks;
}
/**
* Implements hook_block_view().
*/
function node_block_view($delta = '') {
$block = array();
switch ($delta) {
case 'syndicate':
$block['subject'] = t('Syndicate');
$block['content'] = theme('feed_icon', array('url' => 'rss.xml', 'title' => t('Syndicate')));
break;
case 'recent':
if (user_access('access content')) {
$block['subject'] = t('Recent content');
if ($nodes = node_get_recent(variable_get('node_recent_block_count', 10))) {
$block['content'] = theme('node_recent_block', array(
'nodes' => $nodes,
));
} else {
$block['content'] = t('No content available.');
}
}
break;
}
return $block;
}
/**
* Implements hook_block_configure().
*/
function node_block_configure($delta = '') {
$form = array();
if ($delta == 'recent') {
$form['node_recent_block_count'] = array(
'#type' => 'select',
'#title' => t('Number of recent content items to display'),
'#default_value' => variable_get('node_recent_block_count', 10),
'#options' => drupal_map_assoc(array(2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 25, 30)),
);
}
return $form;
}
/**
* Implements hook_block_save().
*/
function node_block_save($delta = '', $edit = array()) {
if ($delta == 'recent') {
variable_set('node_recent_block_count', $edit['node_recent_block_count']);
}
}
/**
* Finds the most recently changed nodes that are available to the current user.
*
* @param $number
* (optional) The maximum number of nodes to find. Defaults to 10.
*
* @return
* An array of node entities or an empty array if there are no recent nodes
* visible to the current user.
*/
function node_get_recent($number = 10) {
$query = db_select('node', 'n');
if (!user_access('bypass node access')) {
// If the user is able to view their own unpublished nodes, allow them to
// see these in addition to published nodes. Check that they actually have
// some unpublished nodes to view before adding the condition.
if (user_access('view own unpublished content') && $own_unpublished = db_query('SELECT nid FROM {node} WHERE uid = :uid AND status = :status', array(':uid' => $GLOBALS['user']->uid, ':status' => NODE_NOT_PUBLISHED))->fetchCol()) {
$query->condition(db_or()
->condition('n.status', NODE_PUBLISHED)
->condition('n.nid', $own_unpublished, 'IN')
);
}
else {
// If not, restrict the query to published nodes.
$query->condition('n.status', NODE_PUBLISHED);
}
}
$nids = $query
->fields('n', array('nid'))
->orderBy('n.changed', 'DESC')
->range(0, $number)
->addTag('node_access')
->execute()
->fetchCol();
$nodes = node_load_multiple($nids);
return $nodes ? $nodes : array();
}
/**
* Returns HTML for a list of recent content.
*
* @param $variables
* An associative array containing:
* - nodes: An array of recent node objects.
*
* @ingroup themeable
*/
function theme_node_recent_block($variables) {
$rows = array();
$output = '';
$l_options = array('query' => drupal_get_destination());
foreach ($variables['nodes'] as $node) {
$row = array();
$row[] = array(
'data' => theme('node_recent_content', array('node' => $node)),
'class' => 'title-author',
);
$row[] = array(
'data' => node_access('update', $node) ? l(t('edit'), 'node/' . $node->nid . '/edit', $l_options) : '',
'class' => 'edit',
);
$row[] = array(
'data' => node_access('delete', $node) ? l(t('delete'), 'node/' . $node->nid . '/delete', $l_options) : '',
'class' => 'delete',
);
$rows[] = $row;
}
if ($rows) {
$output = theme('table', array('rows' => $rows));
if (user_access('access content overview')) {
$output .= theme('more_link', array('url' => 'admin/content', 'title' => t('Show more content')));
}
}
return $output;
}
/**
* Returns HTML for a recent node to be displayed in the recent content block.
*
* @param $variables
* An associative array containing:
* - node: A node object.
*
* @ingroup themeable
*/
function theme_node_recent_content($variables) {
$node = $variables['node'];
$output = '';
$output .= l($node->title, 'node/' . $node->nid);
$output .= theme('mark', array('type' => node_mark($node->nid, $node->changed)));
$output .= '
';
$output .= theme('username', array('account' => user_load($node->uid)));
$output .= '
';
return $output;
}
/**
* Implements hook_form_FORMID_alter().
*
* Adds node-type specific visibility options to add block form.
*
* @see block_add_block_form()
*/
function node_form_block_add_block_form_alter(&$form, &$form_state) {
node_form_block_admin_configure_alter($form, $form_state);
}
/**
* Implements hook_form_FORMID_alter().
*
* Adds node-type specific visibility options to block configuration form.
*
* @see block_admin_configure()
*/
function node_form_block_admin_configure_alter(&$form, &$form_state) {
$default_type_options = db_query("SELECT type FROM {block_node_type} WHERE module = :module AND delta = :delta", array(
':module' => $form['module']['#value'],
':delta' => $form['delta']['#value'],
))->fetchCol();
$form['visibility']['node_type'] = array(
'#type' => 'fieldset',
'#title' => t('Content types'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#group' => 'visibility',
'#weight' => 5,
);
$form['visibility']['node_type']['types'] = array(
'#type' => 'checkboxes',
'#title' => t('Show block for specific content types'),
'#default_value' => $default_type_options,
'#options' => node_type_get_names(),
'#description' => t('Show this block only on pages that display content of the given type(s). If you select no types, there will be no type-specific limitation.'),
);
$form['#submit'][] = 'node_form_block_admin_configure_submit';
}
/**
* Form submission handler for node_form_block_admin_configure_alter().
*
* @see node_form_block_admin_configure_alter()
*/
function node_form_block_admin_configure_submit($form, &$form_state) {
db_delete('block_node_type')
->condition('module', $form_state['values']['module'])
->condition('delta', $form_state['values']['delta'])
->execute();
$query = db_insert('block_node_type')->fields(array('type', 'module', 'delta'));
foreach (array_filter($form_state['values']['types']) as $type) {
$query->values(array(
'type' => $type,
'module' => $form_state['values']['module'],
'delta' => $form_state['values']['delta'],
));
}
$query->execute();
}
/**
* Implements hook_form_FORMID_alter().
*
* Adds node specific submit handler to delete custom block form.
*
* @see block_custom_block_delete()
*/
function node_form_block_custom_block_delete_alter(&$form, &$form_state) {
$form['#submit'][] = 'node_form_block_custom_block_delete_submit';
}
/**
* Form submission handler for node_form_block_custom_block_delete_alter().
*
* @see node_form_block_custom_block_delete_alter()
*/
function node_form_block_custom_block_delete_submit($form, &$form_state) {
db_delete('block_node_type')
->condition('module', 'block')
->condition('delta', $form_state['values']['bid'])
->execute();
}
/**
* Implements hook_modules_uninstalled().
*
* Cleanup {block_node_type} table from modules' blocks.
*/
function node_modules_uninstalled($modules) {
db_delete('block_node_type')
->condition('module', $modules, 'IN')
->execute();
}
/**
* Implements hook_block_list_alter().
*
* Check the content type specific visibilty settings. Remove the block if the
* visibility conditions are not met.
*/
function node_block_list_alter(&$blocks) {
global $theme_key;
// Build an array of node types for each block.
$block_node_types = array();
$result = db_query('SELECT module, delta, type FROM {block_node_type}');
foreach ($result as $record) {
$block_node_types[$record->module][$record->delta][$record->type] = TRUE;
}
$node = menu_get_object();
$node_types = node_type_get_types();
if (arg(0) == 'node' && arg(1) == 'add' && arg(2)) {
$node_add_arg = strtr(arg(2), '-', '_');
}
foreach ($blocks as $key => $block) {
if (!isset($block->theme) || !isset($block->status) || $block->theme != $theme_key || $block->status != 1) {
// This block was added by a contrib module, leave it in the list.
continue;
}
// If a block has no node types associated, it is displayed for every type.
// For blocks with node types associated, if the node type does not match
// the settings from this block, remove it from the block list.
if (isset($block_node_types[$block->module][$block->delta])) {
if (!empty($node)) {
// This is a node or node edit page.
if (!isset($block_node_types[$block->module][$block->delta][$node->type])) {
// This block should not be displayed for this node type.
unset($blocks[$key]);
continue;
}
}
elseif (isset($node_add_arg) && isset($node_types[$node_add_arg])) {
// This is a node creation page
if (!isset($block_node_types[$block->module][$block->delta][$node_add_arg])) {
// This block should not be displayed for this node type.
unset($blocks[$key]);
continue;
}
}
else {
// This is not a node page, remove the block.
unset($blocks[$key]);
continue;
}
}
}
}
/**
* Generates and prints an RSS feed.
*
* Generates an RSS feed from an array of node IDs, and prints it with an HTTP
* header, with Content Type set to RSS/XML.
*
* @param $nids
* An array of node IDs (nid). Defaults to FALSE so empty feeds can be
* generated with passing an empty array, if no items are to be added
* to the feed.
* @param $channel
* An associative array containing title, link, description and other keys,
* to be parsed by format_rss_channel() and format_xml_elements().
* A list of channel elements can be found at the
* @link http://cyber.law.harvard.edu/rss/rss.html RSS 2.0 Specification. @endlink
* The link should be an absolute URL.
*/
function node_feed($nids = FALSE, $channel = array()) {
global $base_url, $language_content;
if ($nids === FALSE) {
$nids = db_select('node', 'n')
->fields('n', array('nid', 'created'))
->condition('n.promote', 1)
->condition('n.status', 1)
->orderBy('n.created', 'DESC')
->range(0, variable_get('feed_default_items', 10))
->addTag('node_access')
->execute()
->fetchCol();
}
$item_length = variable_get('feed_item_length', 'fulltext');
$namespaces = array('xmlns:dc' => 'http://purl.org/dc/elements/1.1/');
// Load all nodes to be rendered.
$nodes = node_load_multiple($nids);
$items = '';
foreach ($nodes as $node) {
$item_text = '';
$node->link = url("node/$node->nid", array('absolute' => TRUE));
$node->rss_namespaces = array();
$account = user_load($node->uid);
$node->rss_elements = array(
array('key' => 'pubDate', 'value' => gmdate('r', $node->created)),
array('key' => 'dc:creator', 'value' => format_username($account)),
array('key' => 'guid', 'value' => $node->nid . ' at ' . $base_url, 'attributes' => array('isPermaLink' => 'false'))
);
// The node gets built and modules add to or modify $node->rss_elements
// and $node->rss_namespaces.
$build = node_view($node, 'rss');
unset($build['#theme']);
if (!empty($node->rss_namespaces)) {
$namespaces = array_merge($namespaces, $node->rss_namespaces);
}
if ($item_length != 'title') {
// We render node contents and force links to be last.
$build['links']['#weight'] = 1000;
$item_text .= drupal_render($build);
}
$items .= format_rss_item($node->title, $node->link, $item_text, $node->rss_elements);
}
$channel_defaults = array(
'version' => '2.0',
'title' => variable_get('site_name', 'Drupal'),
'link' => $base_url,
'description' => variable_get('feed_description', ''),
'language' => $language_content->language
);
$channel_extras = array_diff_key($channel, $channel_defaults);
$channel = array_merge($channel_defaults, $channel);
$output = "\n";
$output .= "\n";
$output .= format_rss_channel($channel['title'], $channel['link'], $channel['description'], $items, $channel['language'], $channel_extras);
$output .= " \n";
drupal_add_http_header('Content-Type', 'application/rss+xml; charset=utf-8');
print $output;
}
/**
* Constructs a drupal_render() style array from an array of loaded nodes.
*
* @param $nodes
* An array of nodes as returned by node_load_multiple().
* @param $view_mode
* View mode, e.g. 'full', 'teaser'...
* @param $weight
* An integer representing the weight of the first node in the list.
* @param $langcode
* (optional) A language code to use for rendering. Defaults to NULL which is
* the global content language of the current request.
*
* @return
* An array in the format expected by drupal_render().
*/
function node_view_multiple($nodes, $view_mode = 'teaser', $weight = 0, $langcode = NULL) {
$build = array('nodes' => array());
$entities_by_view_mode = entity_view_mode_prepare('node', $nodes, $view_mode, $langcode);
foreach ($entities_by_view_mode as $entity_view_mode => $entities) {
field_attach_prepare_view('node', $entities, $entity_view_mode, $langcode);
entity_prepare_view('node', $entities, $langcode);
foreach ($entities as $entity) {
$build['nodes'][$entity->nid] = node_view($entity, $entity_view_mode, $langcode);
}
}
foreach ($nodes as $node) {
$build['nodes'][$node->nid]['#weight'] = $weight;
$weight++;
}
// Sort here, to preserve the input order of the entities that were passed to
// this function.
uasort($build['nodes'], 'element_sort');
$build['nodes']['#sorted'] = TRUE;
return $build;
}
/**
* Menu callback: Generates a listing of promoted nodes.
*
* @return array
* An array in the format expected by drupal_render().
*
* @see node_menu()
*/
function node_page_default() {
$select = db_select('node', 'n')
->fields('n', array('nid', 'sticky', 'created'))
->condition('n.promote', 1)
->condition('n.status', 1)
->orderBy('n.sticky', 'DESC')
->orderBy('n.created', 'DESC')
->extend('PagerDefault')
->limit(variable_get('default_nodes_main', 10))
->addTag('node_access');
$nids = $select->execute()->fetchCol();
if (!empty($nids)) {
$nodes = node_load_multiple($nids);
$build = node_view_multiple($nodes);
// 'rss.xml' is a path, not a file, registered in node_menu().
drupal_add_feed('rss.xml', variable_get('site_name', 'Drupal') . ' ' . t('RSS'));
$build['pager'] = array(
'#theme' => 'pager',
'#weight' => 5,
);
drupal_set_title('');
}
else {
drupal_set_title(t('Welcome to @site-name', array('@site-name' => variable_get('site_name', 'Drupal'))), PASS_THROUGH);
$default_message = '' . t('No front page content has been created yet.') . '
';
$default_links = array();
if (_node_add_access()) {
$default_links[] = l(t('Add new content'), 'node/add');
}
if (!empty($default_links)) {
$default_message .= theme('item_list', array('items' => $default_links));
}
$build['default_message'] = array(
'#markup' => $default_message,
'#prefix' => '',
'#suffix' => '
',
);
}
return $build;
}
/**
* Menu callback: Displays a single node.
*
* @param $node
* The node object.
*
* @return
* A page array suitable for use by drupal_render().
*
* @see node_menu()
*/
function node_page_view($node) {
// If there is a menu link to this node, the link becomes the last part
// of the active trail, and the link name becomes the page title.
// Thus, we must explicitly set the page title to be the node title.
drupal_set_title($node->title);
$uri = entity_uri('node', $node);
// Set the node path as the canonical URL to prevent duplicate content.
drupal_add_html_head_link(array('rel' => 'canonical', 'href' => url($uri['path'], $uri['options'])), TRUE);
// Set the non-aliased path as a default shortlink.
drupal_add_html_head_link(array('rel' => 'shortlink', 'href' => url($uri['path'], array_merge($uri['options'], array('alias' => TRUE)))), TRUE);
return node_show($node);
}
/**
* Implements hook_update_index().
*/
function node_update_index() {
$limit = (int)variable_get('search_cron_limit', 100);
$result = db_query_range("SELECT n.nid FROM {node} n LEFT JOIN {search_dataset} d ON d.type = 'node' AND d.sid = n.nid WHERE d.sid IS NULL OR d.reindex <> 0 ORDER BY d.reindex ASC, n.nid ASC", 0, $limit, array(), array('target' => 'slave'));
foreach ($result as $node) {
_node_index_node($node);
}
}
/**
* Indexes a single node.
*
* @param $node
* The node to index.
*/
function _node_index_node($node) {
$node = node_load($node->nid);
// Save the changed time of the most recent indexed node, for the search
// results half-life calculation.
variable_set('node_cron_last', $node->changed);
// Render the node.
$build = node_view($node, 'search_index');
unset($build['#theme']);
$node->rendered = drupal_render($build);
$text = '' . check_plain($node->title) . ' ' . $node->rendered;
// Fetch extra data normally not visible
$extra = module_invoke_all('node_update_index', $node);
foreach ($extra as $t) {
$text .= $t;
}
// Update index
search_index($node->nid, 'node', $text);
}
/**
* Implements hook_form_FORM_ID_alter().
*/
function node_form_search_form_alter(&$form, $form_state) {
if (isset($form['module']) && $form['module']['#value'] == 'node' && user_access('use advanced search')) {
// Keyword boxes:
$form['advanced'] = array(
'#type' => 'fieldset',
'#title' => t('Advanced search'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#attributes' => array('class' => array('search-advanced')),
);
$form['advanced']['keywords'] = array(
'#prefix' => '',
'#suffix' => '
',
);
$form['advanced']['keywords']['or'] = array(
'#type' => 'textfield',
'#title' => t('Containing any of the words'),
'#size' => 30,
'#maxlength' => 255,
);
$form['advanced']['keywords']['phrase'] = array(
'#type' => 'textfield',
'#title' => t('Containing the phrase'),
'#size' => 30,
'#maxlength' => 255,
);
$form['advanced']['keywords']['negative'] = array(
'#type' => 'textfield',
'#title' => t('Containing none of the words'),
'#size' => 30,
'#maxlength' => 255,
);
// Node types:
$types = array_map('check_plain', node_type_get_names());
$form['advanced']['type'] = array(
'#type' => 'checkboxes',
'#title' => t('Only of the type(s)'),
'#prefix' => '',
'#suffix' => '
',
'#options' => $types,
);
$form['advanced']['submit'] = array(
'#type' => 'submit',
'#value' => t('Advanced search'),
'#prefix' => '',
'#suffix' => '
',
'#weight' => 100,
);
// Languages:
$language_options = array();
foreach (language_list('language') as $key => $entity) {
if ($entity->enabled) {
$language_options[$key] = $entity->name;
}
}
if (count($language_options) > 1) {
$form['advanced']['language'] = array(
'#type' => 'checkboxes',
'#title' => t('Languages'),
'#prefix' => '',
'#suffix' => '
',
'#options' => $language_options,
);
}
$form['#validate'][] = 'node_search_validate';
}
}
/**
* Form validation handler for node_form_alter().
*/
function node_search_validate($form, &$form_state) {
// Initialize using any existing basic search keywords.
$keys = $form_state['values']['processed_keys'];
// Insert extra restrictions into the search keywords string.
if (isset($form_state['values']['type']) && is_array($form_state['values']['type'])) {
// Retrieve selected types - Form API sets the value of unselected
// checkboxes to 0.
$form_state['values']['type'] = array_filter($form_state['values']['type']);
if (count($form_state['values']['type'])) {
$keys = search_expression_insert($keys, 'type', implode(',', array_keys($form_state['values']['type'])));
}
}
if (isset($form_state['values']['term']) && is_array($form_state['values']['term']) && count($form_state['values']['term'])) {
$keys = search_expression_insert($keys, 'term', implode(',', $form_state['values']['term']));
}
if (isset($form_state['values']['language']) && is_array($form_state['values']['language'])) {
$languages = array_filter($form_state['values']['language']);
if (count($languages)) {
$keys = search_expression_insert($keys, 'language', implode(',', $languages));
}
}
if ($form_state['values']['or'] != '') {
if (preg_match_all('/ ("[^"]+"|[^" ]+)/i', ' ' . $form_state['values']['or'], $matches)) {
$keys .= ' ' . implode(' OR ', $matches[1]);
}
}
if ($form_state['values']['negative'] != '') {
if (preg_match_all('/ ("[^"]+"|[^" ]+)/i', ' ' . $form_state['values']['negative'], $matches)) {
$keys .= ' -' . implode(' -', $matches[1]);
}
}
if ($form_state['values']['phrase'] != '') {
$keys .= ' "' . str_replace('"', ' ', $form_state['values']['phrase']) . '"';
}
if (!empty($keys)) {
form_set_value($form['basic']['processed_keys'], trim($keys), $form_state);
}
}
/**
* @defgroup node_access Node access rights
* @{
* The node access system determines who can do what to which nodes.
*
* In determining access rights for a node, node_access() first checks whether
* the user has the "bypass node access" permission. Such users have
* unrestricted access to all nodes. user 1 will always pass this check.
*
* Next, all implementations of hook_node_access() will be called. Each
* implementation may explicitly allow, explicitly deny, or ignore the access
* request. If at least one module says to deny the request, it will be rejected.
* If no modules deny the request and at least one says to allow it, the request
* will be permitted.
*
* If all modules ignore the access request, then the node_access table is used
* to determine access. All node access modules are queried using
* hook_node_grants() to assemble a list of "grant IDs" for the user. This list
* is compared against the table. If any row contains the node ID in question
* (or 0, which stands for "all nodes"), one of the grant IDs returned, and a
* value of TRUE for the operation in question, then access is granted. Note
* that this table is a list of grants; any matching row is sufficient to
* grant access to the node.
*
* In node listings (lists of nodes generated from a select query, such as the
* default home page at path 'node', an RSS feed, a recent content block, etc.),
* the process above is followed except that hook_node_access() is not called on
* each node for performance reasons and for proper functioning of the pager
* system. When adding a node listing to your module, be sure to use a dynamic
* query created by db_select() and add a tag of "node_access". This will allow
* modules dealing with node access to ensure only nodes to which the user has
* access are retrieved, through the use of hook_query_TAG_alter(). Tagging a
* query with "node_access" does not check the published/unpublished status of
* nodes, so the base query is responsible for ensuring that unpublished nodes
* are not displayed to inappropriate users.
*
* Note: Even a single module returning NODE_ACCESS_DENY from hook_node_access()
* will block access to the node. Therefore, implementers should take care to
* not deny access unless they really intend to. Unless a module wishes to
* actively deny access it should return NODE_ACCESS_IGNORE (or simply return
* nothing) to allow other modules or the node_access table to control access.
*
* To see how to write a node access module of your own, see
* node_access_example.module.
*/
/**
* Determines whether the current user may perform the operation on the node.
*
* @param $op
* The operation to be performed on the node. Possible values are:
* - "view"
* - "update"
* - "delete"
* - "create"
* @param $node
* The node object on which the operation is to be performed, or node type
* (e.g. 'forum') for "create" operation.
* @param $account
* Optional, a user object representing the user for whom the operation is to
* be performed. Determines access for a user other than the current user.
*
* @return
* TRUE if the operation may be performed, FALSE otherwise.
*/
function node_access($op, $node, $account = NULL) {
$rights = &drupal_static(__FUNCTION__, array());
if (!$node || !in_array($op, array('view', 'update', 'delete', 'create'), TRUE)) {
// If there was no node to check against, or the $op was not one of the
// supported ones, we return access denied.
return FALSE;
}
// If no user object is supplied, the access check is for the current user.
if (empty($account)) {
$account = $GLOBALS['user'];
}
// $node may be either an object or a node type. Since node types cannot be
// an integer, use either nid or type as the static cache id.
$cid = is_object($node) ? $node->nid : $node;
// If we've already checked access for this node, user and op, return from
// cache.
if (isset($rights[$account->uid][$cid][$op])) {
return $rights[$account->uid][$cid][$op];
}
if (user_access('bypass node access', $account)) {
$rights[$account->uid][$cid][$op] = TRUE;
return TRUE;
}
if (!user_access('access content', $account)) {
$rights[$account->uid][$cid][$op] = FALSE;
return FALSE;
}
// We grant access to the node if both of the following conditions are met:
// - No modules say to deny access.
// - At least one module says to grant access.
// If no module specified either allow or deny, we fall back to the
// node_access table.
$access = module_invoke_all('node_access', $node, $op, $account);
if (in_array(NODE_ACCESS_DENY, $access, TRUE)) {
$rights[$account->uid][$cid][$op] = FALSE;
return FALSE;
}
elseif (in_array(NODE_ACCESS_ALLOW, $access, TRUE)) {
$rights[$account->uid][$cid][$op] = TRUE;
return TRUE;
}
// Check if authors can view their own unpublished nodes.
if ($op == 'view' && !$node->status && user_access('view own unpublished content', $account) && $account->uid == $node->uid && $account->uid != 0) {
$rights[$account->uid][$cid][$op] = TRUE;
return TRUE;
}
// If the module did not override the access rights, use those set in the
// node_access table.
if ($op != 'create' && $node->nid) {
if (module_implements('node_grants')) {
$query = db_select('node_access');
$query->addExpression('1');
$query->condition('grant_' . $op, 1, '>=');
$nids = db_or()->condition('nid', $node->nid);
if ($node->status) {
$nids->condition('nid', 0);
}
$query->condition($nids);
$query->range(0, 1);
$grants = node_add_node_grants_to_query(node_access_grants($op, $account));
if (count($grants) > 0) {
$query->condition($grants);
}
$result = (bool) $query
->execute()
->fetchField();
$rights[$account->uid][$cid][$op] = $result;
return $result;
}
elseif (is_object($node) && $op == 'view' && $node->status) {
// If no modules implement hook_node_grants(), the default behavior is to
// allow all users to view published nodes, so reflect that here.
$rights[$account->uid][$cid][$op] = TRUE;
return TRUE;
}
}
return FALSE;
}
/**
* Helper function to create the or condition for a node grants check.
*
* @param $account
* The grants to add to the query, usually gotten via node_access_grants().
* @param $table_alias
* Optional, the alias to the node access table.
*
* @return
* TRUE if the operation may be performed, FALSE otherwise.
*/
function node_add_node_grants_to_query($node_access_grants, $table_alias = '') {
$grants = db_or();
$prefix = $table_alias ? $table_alias . '.' : '';
foreach ($node_access_grants as $realm => $gids) {
if (!empty($gids)) {
$grants->condition(db_and()
->condition($prefix . 'gid', $gids, 'IN')
->condition($prefix . 'realm', $realm)
);
}
}
return $grants;
}
/**
* Implements hook_node_access().
*/
function node_node_access($node, $op, $account) {
$type = is_string($node) ? $node : $node->type;
if (in_array($type, node_permissions_get_configured_types())) {
if ($op == 'create' && user_access('create ' . $type . ' content', $account)) {
return NODE_ACCESS_ALLOW;
}
if ($op == 'update') {
if (user_access('edit any ' . $type . ' content', $account) || (user_access('edit own ' . $type . ' content', $account) && ($account->uid == $node->uid))) {
return NODE_ACCESS_ALLOW;
}
}
if ($op == 'delete') {
if (user_access('delete any ' . $type . ' content', $account) || (user_access('delete own ' . $type . ' content', $account) && ($account->uid == $node->uid))) {
return NODE_ACCESS_ALLOW;
}
}
}
return NODE_ACCESS_IGNORE;
}
/**
* Helper function to generate standard node permission list for a given type.
*
* @param $type
* The machine-readable name of the node type.
*
* @return array
* An array of permission names and descriptions.
*/
function node_list_permissions($type) {
$info = node_type_get_type($type);
// Build standard list of node permissions for this type.
$perms = array(
"create $type content" => array(
'title' => t('%type_name: Create new content', array('%type_name' => $info->name)),
),
"edit own $type content" => array(
'title' => t('%type_name: Edit own content', array('%type_name' => $info->name)),
),
"edit any $type content" => array(
'title' => t('%type_name: Edit any content', array('%type_name' => $info->name)),
),
"delete own $type content" => array(
'title' => t('%type_name: Delete own content', array('%type_name' => $info->name)),
),
"delete any $type content" => array(
'title' => t('%type_name: Delete any content', array('%type_name' => $info->name)),
),
);
return $perms;
}
/**
* Returns an array of node types that should be managed by permissions.
*
* By default, this will include all node types in the system. To exclude a
* specific node from getting permissions defined for it, set the
* node_permissions_$type variable to 0. Core does not provide an interface for
* doing so. However, contrib modules may exclude their own nodes in
* hook_install(). Alternatively, contrib modules may configure all node types
* at once, or decide to apply some other hook_node_access() implementation to
* some or all node types.
*
* @return
* An array of node types managed by this module.
*/
function node_permissions_get_configured_types() {
$configured_types = array();
foreach (node_type_get_types() as $type => $info) {
if (variable_get('node_permissions_' . $type, 1)) {
$configured_types[] = $type;
}
}
return $configured_types;
}
/**
* Fetches an array of permission IDs granted to the given user ID.
*
* The implementation here provides only the universal "all" grant. A node
* access module should implement hook_node_grants() to provide a grant list for
* the user.
*
* After the default grants have been loaded, we allow modules to alter the
* grants array by reference. This hook allows for complex business logic to be
* applied when integrating multiple node access modules.
*
* @param $op
* The operation that the user is trying to perform.
* @param $account
* The user object for the user performing the operation. If omitted, the
* current user is used.
*
* @return
* An associative array in which the keys are realms, and the values are
* arrays of grants for those realms.
*/
function node_access_grants($op, $account = NULL) {
if (!isset($account)) {
$account = $GLOBALS['user'];
}
// Fetch node access grants from other modules.
$grants = module_invoke_all('node_grants', $account, $op);
// Allow modules to alter the assigned grants.
drupal_alter('node_grants', $grants, $account, $op);
return array_merge(array('all' => array(0)), $grants);
}
/**
* Determines whether the user has a global viewing grant for all nodes.
*
* Checks to see whether any module grants global 'view' access to a user
* account; global 'view' access is encoded in the {node_access} table as a
* grant with nid=0. If no node access modules are enabled, node.module defines
* such a global 'view' access grant.
*
* This function is called when a node listing query is tagged with
* 'node_access'; when this function returns TRUE, no node access joins are
* added to the query.
*
* @param $account
* The user object for the user whose access is being checked. If omitted,
* the current user is used.
*
* @return
* TRUE if 'view' access to all nodes is granted, FALSE otherwise.
*
* @see hook_node_grants()
* @see _node_query_node_access_alter()
*/
function node_access_view_all_nodes($account = NULL) {
global $user;
if (!$account) {
$account = $user;
}
// Statically cache results in an array keyed by $account->uid.
$access = &drupal_static(__FUNCTION__);
if (isset($access[$account->uid])) {
return $access[$account->uid];
}
// If no modules implement the node access system, access is always TRUE.
if (!module_implements('node_grants')) {
$access[$account->uid] = TRUE;
}
else {
$query = db_select('node_access');
$query->addExpression('COUNT(*)');
$query
->condition('nid', 0)
->condition('grant_view', 1, '>=');
$grants = node_add_node_grants_to_query(node_access_grants('view', $account));
if (count($grants) > 0 ) {
$query->condition($grants);
}
$access[$account->uid] = $query
->execute()
->fetchField();
}
return $access[$account->uid];
}
/**
* Implements hook_query_TAG_alter().
*
* This is the hook_query_alter() for queries tagged with 'node_access'. It adds
* node access checks for the user account given by the 'account' meta-data (or
* global $user if not provided), for an operation given by the 'op' meta-data
* (or 'view' if not provided; other possible values are 'update' and 'delete').
*/
function node_query_node_access_alter(QueryAlterableInterface $query) {
_node_query_node_access_alter($query, 'node');
}
/**
* Implements hook_query_TAG_alter().
*
* This function implements the same functionality as
* node_query_node_access_alter() for the SQL field storage engine. Node access
* conditions are added for field values belonging to nodes only.
*/
function node_query_entity_field_access_alter(QueryAlterableInterface $query) {
_node_query_node_access_alter($query, 'entity');
}
/**
* Helper for node access functions.
*
* Queries tagged with 'node_access' that are not against the {node} table
* should add the base table as metadata. For example:
* @code
* $query
* ->addTag('node_access')
* ->addMetaData('base_table', 'taxonomy_index');
* @endcode
* If the query is not against the {node} table, an attempt is made to guess
* the table, but is not recommended to rely on this as it is deprecated and not
* allowed in Drupal 8. It is always safer to provide the table.
*
* @param $query
* The query to add conditions to.
* @param $type
* Either 'node' or 'entity' depending on what sort of query it is. See
* node_query_node_access_alter() and node_query_entity_field_access_alter()
* for more.
*/
function _node_query_node_access_alter($query, $type) {
global $user;
// Read meta-data from query, if provided.
if (!$account = $query->getMetaData('account')) {
$account = $user;
}
if (!$op = $query->getMetaData('op')) {
$op = 'view';
}
// If $account can bypass node access, or there are no node access modules,
// or the operation is 'view' and the $account has a global view grant
// (such as a view grant for node ID 0), we don't need to alter the query.
if (user_access('bypass node access', $account)) {
return;
}
if (!count(module_implements('node_grants'))) {
return;
}
if ($op == 'view' && node_access_view_all_nodes($account)) {
return;
}
$tables = $query->getTables();
$base_table = $query->getMetaData('base_table');
// If no base table is specified explicitly, search for one.
if (!$base_table) {
$fallback = '';
foreach ($tables as $alias => $table_info) {
if (!($table_info instanceof SelectQueryInterface)) {
$table = $table_info['table'];
// If the node table is in the query, it wins immediately.
if ($table == 'node') {
$base_table = $table;
break;
}
// Check whether the table has a foreign key to node.nid. If it does,
// do not run this check again as we found a base table and only node
// can triumph that.
if (!$base_table) {
// The schema is cached.
$schema = drupal_get_schema($table);
if (isset($schema['fields']['nid'])) {
if (isset($schema['foreign keys'])) {
foreach ($schema['foreign keys'] as $relation) {
if ($relation['table'] === 'node' && $relation['columns'] === array('nid' => 'nid')) {
$base_table = $table;
}
}
}
else {
// At least it's a nid. A table with a field called nid is very
// very likely to be a node.nid in a node access query.
$fallback = $table;
}
}
}
}
}
// If there is nothing else, use the fallback.
if (!$base_table) {
if ($fallback) {
watchdog('security', 'Your node listing query is using @fallback as a base table in a query tagged for node access. This might not be secure and might not even work. Specify foreign keys in your schema to node.nid ', array('@fallback' => $fallback), WATCHDOG_WARNING);
$base_table = $fallback;
}
else {
throw new Exception(t('Query tagged for node access but there is no nid. Add foreign keys to node.nid in schema to fix.'));
}
}
}
// Find all instances of the base table being joined -- could appear
// more than once in the query, and could be aliased. Join each one to
// the node_access table.
$grants = node_access_grants($op, $account);
if ($type == 'entity') {
// The original query looked something like:
// @code
// SELECT nid FROM sometable s
// INNER JOIN node_access na ON na.nid = s.nid
// WHERE ($node_access_conditions)
// @endcode
//
// Our query will look like:
// @code
// SELECT entity_type, entity_id
// FROM field_data_something s
// LEFT JOIN node_access na ON s.entity_id = na.nid
// WHERE (entity_type = 'node' AND $node_access_conditions) OR (entity_type <> 'node')
// @endcode
//
// So instead of directly adding to the query object, we need to collect
// all of the node access conditions in a separate db_and() object and
// then add it to the query at the end.
$node_conditions = db_and();
}
foreach ($tables as $nalias => $tableinfo) {
$table = $tableinfo['table'];
if (!($table instanceof SelectQueryInterface) && $table == $base_table) {
// Set the subquery.
$subquery = db_select('node_access', 'na')
->fields('na', array('nid'));
$grant_conditions = node_add_node_grants_to_query($grants, 'na');
// Attach conditions to the subquery for nodes.
if (count($grant_conditions->conditions())) {
$subquery->condition($grant_conditions);
}
$subquery->condition('na.grant_' . $op, 1, '>=');
$field = 'nid';
// Now handle entities.
if ($type == 'entity') {
// Set a common alias for entities.
$base_alias = $nalias;
$field = 'entity_id';
}
$subquery->where("$nalias.$field = na.nid");
// For an entity query, attach the subquery to entity conditions.
if ($type == 'entity') {
$node_conditions->exists($subquery);
}
// Otherwise attach it to the node query itself.
else {
$query->exists($subquery);
}
}
}
if ($type == 'entity' && count($subquery->conditions())) {
// All the node access conditions are only for field values belonging to
// nodes.
$node_conditions->condition("$base_alias.entity_type", 'node');
$or = db_or();
$or->condition($node_conditions);
// If the field value belongs to a non-node entity type then this function
// does not do anything with it.
$or->condition("$base_alias.entity_type", 'node', '<>');
// Add the compiled set of rules to the query.
$query->condition($or);
}
}
/**
* Gets the list of node access grants and writes them to the database.
*
* This function is called when a node is saved, and can also be called by
* modules if something other than a node save causes node access permissions to
* change. It collects all node access grants for the node from
* hook_node_access_records() implementations, allows these grants to be altered
* via hook_node_access_records_alter() implementations, and saves the collected
* and altered grants to the database.
*
* @param $node
* The $node to acquire grants for.
*
* @param $delete
* Whether to delete existing node access records before inserting new ones.
* Defaults to TRUE.
*/
function node_access_acquire_grants($node, $delete = TRUE) {
$grants = module_invoke_all('node_access_records', $node);
// Let modules alter the grants.
drupal_alter('node_access_records', $grants, $node);
// If no grants are set and the node is published, then use the default grant.
if (empty($grants) && !empty($node->status)) {
$grants[] = array('realm' => 'all', 'gid' => 0, 'grant_view' => 1, 'grant_update' => 0, 'grant_delete' => 0);
}
else {
// Retain grants by highest priority.
$grant_by_priority = array();
foreach ($grants as $g) {
$grant_by_priority[intval($g['priority'])][] = $g;
}
krsort($grant_by_priority);
$grants = array_shift($grant_by_priority);
}
node_access_write_grants($node, $grants, NULL, $delete);
}
/**
* Writes a list of grants to the database, deleting any previously saved ones.
*
* If a realm is provided, it will only delete grants from that realm, but it
* will always delete a grant from the 'all' realm. Modules that utilize
* node_access() can use this function when doing mass updates due to widespread
* permission changes.
*
* Note: Don't call this function directly from a contributed module. Call
* node_access_acquire_grants() instead.
*
* @param $node
* The node whose grants are being written.
* @param $grants
* A list of grants to write. Each grant is an array that must contain the
* following keys: realm, gid, grant_view, grant_update, grant_delete.
* The realm is specified by a particular module; the gid is as well, and
* is a module-defined id to define grant privileges. each grant_* field
* is a boolean value.
* @param $realm
* (optional) If provided, read/write grants for that realm only. Defaults to
* NULL.
* @param $delete
* (optional) If false, does not delete records. This is only for optimization
* purposes, and assumes the caller has already performed a mass delete of
* some form. Defaults to TRUE.
*
* @see node_access_acquire_grants()
*/
function node_access_write_grants($node, $grants, $realm = NULL, $delete = TRUE) {
if ($delete) {
$query = db_delete('node_access')->condition('nid', $node->nid);
if ($realm) {
$query->condition('realm', array($realm, 'all'), 'IN');
}
$query->execute();
}
// Only perform work when node_access modules are active.
if (!empty($grants) && count(module_implements('node_grants'))) {
$query = db_insert('node_access')->fields(array('nid', 'realm', 'gid', 'grant_view', 'grant_update', 'grant_delete'));
foreach ($grants as $grant) {
if ($realm && $realm != $grant['realm']) {
continue;
}
// Only write grants; denies are implicit.
if ($grant['grant_view'] || $grant['grant_update'] || $grant['grant_delete']) {
$grant['nid'] = $node->nid;
$query->values($grant);
}
}
$query->execute();
}
}
/**
* Flags or unflags the node access grants for rebuilding.
*
* If the argument isn't specified, the current value of the flag is returned.
* When the flag is set, a message is displayed to users with 'access
* administration pages' permission, pointing to the 'rebuild' confirm form.
* This can be used as an alternative to direct node_access_rebuild calls,
* allowing administrators to decide when they want to perform the actual
* (possibly time consuming) rebuild. When unsure if the current user is an
* administrator, node_access_rebuild() should be used instead.
*
* @param $rebuild
* (Optional) The boolean value to be written.
*
* @return
* The current value of the flag if no value was provided for $rebuild.
*
* @see node_access_rebuild()
*/
function node_access_needs_rebuild($rebuild = NULL) {
if (!isset($rebuild)) {
return variable_get('node_access_needs_rebuild', FALSE);
}
elseif ($rebuild) {
variable_set('node_access_needs_rebuild', TRUE);
}
else {
variable_del('node_access_needs_rebuild');
}
}
/**
* Rebuilds the node access database.
*
* This is occasionally needed by modules that make system-wide changes to
* access levels. When the rebuild is required by an admin-triggered action (e.g
* module settings form), calling node_access_needs_rebuild(TRUE) instead of
* node_access_rebuild() lets the user perform his changes and actually
* rebuild only once he is done.
*
* Note: As of Drupal 6, node access modules are not required to (and actually
* should not) call node_access_rebuild() in hook_enable/disable anymore.
*
* @see node_access_needs_rebuild()
*
* @param $batch_mode
* Set to TRUE to process in 'batch' mode, spawning processing over several
* HTTP requests (thus avoiding the risk of PHP timeout if the site has a
* large number of nodes).
* hook_update_N and any form submit handler are safe contexts to use the
* 'batch mode'. Less decidable cases (such as calls from hook_user,
* hook_taxonomy, etc...) might consider using the non-batch mode.
*/
function node_access_rebuild($batch_mode = FALSE) {
db_delete('node_access')->execute();
// Only recalculate if the site is using a node_access module.
if (count(module_implements('node_grants'))) {
if ($batch_mode) {
$batch = array(
'title' => t('Rebuilding content access permissions'),
'operations' => array(
array('_node_access_rebuild_batch_operation', array()),
),
'finished' => '_node_access_rebuild_batch_finished'
);
batch_set($batch);
}
else {
// Try to allocate enough time to rebuild node grants
drupal_set_time_limit(240);
// Rebuild newest nodes first so that recent content becomes available quickly.
$nids = db_query("SELECT nid FROM {node} ORDER BY nid DESC")->fetchCol();
foreach ($nids as $nid) {
$node = node_load($nid, NULL, TRUE);
// To preserve database integrity, only acquire grants if the node
// loads successfully.
if (!empty($node)) {
node_access_acquire_grants($node);
}
}
}
}
else {
// Not using any node_access modules. Add the default grant.
db_insert('node_access')
->fields(array(
'nid' => 0,
'realm' => 'all',
'gid' => 0,
'grant_view' => 1,
'grant_update' => 0,
'grant_delete' => 0,
))
->execute();
}
if (!isset($batch)) {
drupal_set_message(t('Content permissions have been rebuilt.'));
node_access_needs_rebuild(FALSE);
cache_clear_all();
}
}
/**
* Implements callback_batch_operation().
*
* Performs batch operation for node_access_rebuild().
*
* This is a multistep operation: we go through all nodes by packs of 20. The
* batch processing engine interrupts processing and sends progress feedback
* after 1 second execution time.
*
* @param array $context
* An array of contextual key/value information for rebuild batch process.
*/
function _node_access_rebuild_batch_operation(&$context) {
if (empty($context['sandbox'])) {
// Initiate multistep processing.
$context['sandbox']['progress'] = 0;
$context['sandbox']['current_node'] = 0;
$context['sandbox']['max'] = db_query('SELECT COUNT(nid) FROM {node}')->fetchField();
}
// Process the next 20 nodes.
$limit = 20;
$nids = db_query_range("SELECT nid FROM {node} WHERE nid > :nid ORDER BY nid ASC", 0, $limit, array(':nid' => $context['sandbox']['current_node']))->fetchCol();
$nodes = node_load_multiple($nids, array(), TRUE);
foreach ($nodes as $nid => $node) {
// To preserve database integrity, only acquire grants if the node
// loads successfully.
if (!empty($node)) {
node_access_acquire_grants($node);
}
$context['sandbox']['progress']++;
$context['sandbox']['current_node'] = $nid;
}
// Multistep processing : report progress.
if ($context['sandbox']['progress'] != $context['sandbox']['max']) {
$context['finished'] = $context['sandbox']['progress'] / $context['sandbox']['max'];
}
}
/**
* Implements callback_batch_finished().
*
* Performs post-processing for node_access_rebuild().
*
* @param bool $success
* A boolean indicating whether the re-build process has completed.
* @param array $results
* An array of results information.
* @param array $operations
* An array of function calls (not used in this function).
*/
function _node_access_rebuild_batch_finished($success, $results, $operations) {
if ($success) {
drupal_set_message(t('The content access permissions have been rebuilt.'));
node_access_needs_rebuild(FALSE);
}
else {
drupal_set_message(t('The content access permissions have not been properly rebuilt.'), 'error');
}
cache_clear_all();
}
/**
* @} End of "defgroup node_access".
*/
/**
* @defgroup node_content Hook implementations for user-created content types
* @{
* Functions that implement hooks for user-created content types.
*/
/**
* Implements hook_form().
*/
function node_content_form($node, $form_state) {
// It is impossible to define a content type without implementing hook_form()
// @todo: remove this requirement.
$form = array();
$type = node_type_get_type($node);
if ($type->has_title) {
$form['title'] = array(
'#type' => 'textfield',
'#title' => check_plain($type->title_label),
'#required' => TRUE,
'#default_value' => $node->title,
'#maxlength' => 255,
'#weight' => -5,
);
}
return $form;
}
/**
* @} End of "defgroup node_content".
*/
/**
* Implements hook_forms().
*
* All node forms share the same form handler.
*/
function node_forms() {
$forms = array();
if ($types = node_type_get_types()) {
foreach (array_keys($types) as $type) {
$forms[$type . '_node_form']['callback'] = 'node_form';
}
}
return $forms;
}
/**
* Implements hook_action_info().
*/
function node_action_info() {
return array(
'node_publish_action' => array(
'type' => 'node',
'label' => t('Publish content'),
'configurable' => FALSE,
'behavior' => array('changes_property'),
'triggers' => array('node_presave', 'comment_insert', 'comment_update', 'comment_delete'),
),
'node_unpublish_action' => array(
'type' => 'node',
'label' => t('Unpublish content'),
'configurable' => FALSE,
'behavior' => array('changes_property'),
'triggers' => array('node_presave', 'comment_insert', 'comment_update', 'comment_delete'),
),
'node_make_sticky_action' => array(
'type' => 'node',
'label' => t('Make content sticky'),
'configurable' => FALSE,
'behavior' => array('changes_property'),
'triggers' => array('node_presave', 'comment_insert', 'comment_update', 'comment_delete'),
),
'node_make_unsticky_action' => array(
'type' => 'node',
'label' => t('Make content unsticky'),
'configurable' => FALSE,
'behavior' => array('changes_property'),
'triggers' => array('node_presave', 'comment_insert', 'comment_update', 'comment_delete'),
),
'node_promote_action' => array(
'type' => 'node',
'label' => t('Promote content to front page'),
'configurable' => FALSE,
'behavior' => array('changes_property'),
'triggers' => array('node_presave', 'comment_insert', 'comment_update', 'comment_delete'),
),
'node_unpromote_action' => array(
'type' => 'node',
'label' => t('Remove content from front page'),
'configurable' => FALSE,
'behavior' => array('changes_property'),
'triggers' => array('node_presave', 'comment_insert', 'comment_update', 'comment_delete'),
),
'node_assign_owner_action' => array(
'type' => 'node',
'label' => t('Change the author of content'),
'configurable' => TRUE,
'behavior' => array('changes_property'),
'triggers' => array('node_presave', 'comment_insert', 'comment_update', 'comment_delete'),
),
'node_save_action' => array(
'type' => 'node',
'label' => t('Save content'),
'configurable' => FALSE,
'triggers' => array('comment_insert', 'comment_update', 'comment_delete'),
),
'node_unpublish_by_keyword_action' => array(
'type' => 'node',
'label' => t('Unpublish content containing keyword(s)'),
'configurable' => TRUE,
'triggers' => array('node_presave', 'node_insert', 'node_update'),
),
);
}
/**
* Sets the status of a node to 1 (published).
*
* @param $node
* A node object.
* @param $context
* (optional) Array of additional information about what triggered the action.
* Not used for this action.
*
* @ingroup actions
*/
function node_publish_action($node, $context = array()) {
$node->status = NODE_PUBLISHED;
watchdog('action', 'Set @type %title to published.', array('@type' => node_type_get_name($node), '%title' => $node->title));
}
/**
* Sets the status of a node to 0 (unpublished).
*
* @param $node
* A node object.
* @param $context
* (optional) Array of additional information about what triggered the action.
* Not used for this action.
*
* @ingroup actions
*/
function node_unpublish_action($node, $context = array()) {
$node->status = NODE_NOT_PUBLISHED;
watchdog('action', 'Set @type %title to unpublished.', array('@type' => node_type_get_name($node), '%title' => $node->title));
}
/**
* Sets the sticky-at-top-of-list property of a node to 1.
*
* @param $node
* A node object.
* @param $context
* (optional) Array of additional information about what triggered the action.
* Not used for this action.
*
* @ingroup actions
*/
function node_make_sticky_action($node, $context = array()) {
$node->sticky = NODE_STICKY;
watchdog('action', 'Set @type %title to sticky.', array('@type' => node_type_get_name($node), '%title' => $node->title));
}
/**
* Sets the sticky-at-top-of-list property of a node to 0.
*
* @param $node
* A node object.
* @param $context
* (optional) Array of additional information about what triggered the action.
* Not used for this action.
*
* @ingroup actions
*/
function node_make_unsticky_action($node, $context = array()) {
$node->sticky = NODE_NOT_STICKY;
watchdog('action', 'Set @type %title to unsticky.', array('@type' => node_type_get_name($node), '%title' => $node->title));
}
/**
* Sets the promote property of a node to 1.
*
* @param $node
* A node object.
* @param $context
* (optional) Array of additional information about what triggered the action.
* Not used for this action.
*
* @ingroup actions
*/
function node_promote_action($node, $context = array()) {
$node->promote = NODE_PROMOTED;
watchdog('action', 'Promoted @type %title to front page.', array('@type' => node_type_get_name($node), '%title' => $node->title));
}
/**
* Sets the promote property of a node to 0.
*
* @param $node
* A node object.
* @param $context
* (optional) Array of additional information about what triggered the action.
* Not used for this action.
*
* @ingroup actions
*/
function node_unpromote_action($node, $context = array()) {
$node->promote = NODE_NOT_PROMOTED;
watchdog('action', 'Removed @type %title from front page.', array('@type' => node_type_get_name($node), '%title' => $node->title));
}
/**
* Saves a node.
*
* @param $node
* The node to be saved.
*
* @ingroup actions
*/
function node_save_action($node) {
node_save($node);
watchdog('action', 'Saved @type %title', array('@type' => node_type_get_name($node), '%title' => $node->title));
}
/**
* Assigns ownership of a node to a user.
*
* @param $node
* A node object to modify.
* @param $context
* Array with the following elements:
* - 'owner_uid': User ID to assign to the node.
*
* @see node_assign_owner_action_form()
* @see node_assign_owner_action_validate()
* @see node_assign_owner_action_submit()
* @ingroup actions
*/
function node_assign_owner_action($node, $context) {
$node->uid = $context['owner_uid'];
$owner_name = db_query("SELECT name FROM {users} WHERE uid = :uid", array(':uid' => $context['owner_uid']))->fetchField();
watchdog('action', 'Changed owner of @type %title to uid %name.', array('@type' => node_type_get_name($node), '%title' => $node->title, '%name' => $owner_name));
}
/**
* Generates the settings form for node_assign_owner_action().
*
* @param $context
* Array of additional information about what triggered the action. Includes
* the following elements:
* - 'owner_uid': User ID to assign to the node.
*
* @see node_assign_owner_action_submit()
* @see node_assign_owner_action_validate()
*
* @ingroup forms
*/
function node_assign_owner_action_form($context) {
$description = t('The username of the user to which you would like to assign ownership.');
$count = db_query("SELECT COUNT(*) FROM {users}")->fetchField();
$owner_name = '';
if (isset($context['owner_uid'])) {
$owner_name = db_query("SELECT name FROM {users} WHERE uid = :uid", array(':uid' => $context['owner_uid']))->fetchField();
}
// Use dropdown for fewer than 200 users; textbox for more than that.
if (intval($count) < 200) {
$options = array();
$result = db_query("SELECT uid, name FROM {users} WHERE uid > 0 ORDER BY name");
foreach ($result as $data) {
$options[$data->name] = $data->name;
}
$form['owner_name'] = array(
'#type' => 'select',
'#title' => t('Username'),
'#default_value' => $owner_name,
'#options' => $options,
'#description' => $description,
);
}
else {
$form['owner_name'] = array(
'#type' => 'textfield',
'#title' => t('Username'),
'#default_value' => $owner_name,
'#autocomplete_path' => 'user/autocomplete',
'#size' => '6',
'#maxlength' => '60',
'#description' => $description,
);
}
return $form;
}
/**
* Validates settings form for node_assign_owner_action().
*
* @see node_assign_owner_action_submit()
*/
function node_assign_owner_action_validate($form, $form_state) {
$exists = (bool) db_query_range('SELECT 1 FROM {users} WHERE name = :name', 0, 1, array(':name' => $form_state['values']['owner_name']))->fetchField();
if (!$exists) {
form_set_error('owner_name', t('Enter a valid username.'));
}
}
/**
* Saves settings form for node_assign_owner_action().
*
* @see node_assign_owner_action_validate()
*/
function node_assign_owner_action_submit($form, $form_state) {
// Username can change, so we need to store the ID, not the username.
$uid = db_query('SELECT uid from {users} WHERE name = :name', array(':name' => $form_state['values']['owner_name']))->fetchField();
return array('owner_uid' => $uid);
}
/**
* Generates settings form for node_unpublish_by_keyword_action().
*
* @param array $context
* Array of additional information about what triggered this action.
*
* @return array
* A form array.
*
* @see node_unpublish_by_keyword_action_submit()
*/
function node_unpublish_by_keyword_action_form($context) {
$form['keywords'] = array(
'#title' => t('Keywords'),
'#type' => 'textarea',
'#description' => t('The content will be unpublished if it contains any of the phrases above. Use a case-sensitive, comma-separated list of phrases. Example: funny, bungee jumping, "Company, Inc."'),
'#default_value' => isset($context['keywords']) ? drupal_implode_tags($context['keywords']) : '',
);
return $form;
}
/**
* Saves settings form for node_unpublish_by_keyword_action().
*/
function node_unpublish_by_keyword_action_submit($form, $form_state) {
return array('keywords' => drupal_explode_tags($form_state['values']['keywords']));
}
/**
* Unpublishes a node containing certain keywords.
*
* @param $node
* A node object to modify.
* @param $context
* Array with the following elements:
* - 'keywords': Array of keywords. If any keyword is present in the rendered
* node, the node's status flag is set to unpublished.
*
* @ingroup actions
*/
function node_unpublish_by_keyword_action($node, $context) {
foreach ($context['keywords'] as $keyword) {
$elements = node_view(clone $node);
if (strpos(drupal_render($elements), $keyword) !== FALSE || strpos($node->title, $keyword) !== FALSE) {
$node->status = NODE_NOT_PUBLISHED;
watchdog('action', 'Set @type %title to unpublished.', array('@type' => node_type_get_name($node), '%title' => $node->title));
break;
}
}
}
/**
* Implements hook_requirements().
*/
function node_requirements($phase) {
$requirements = array();
if ($phase === 'runtime') {
// Only show rebuild button if there are either 0, or 2 or more, rows
// in the {node_access} table, or if there are modules that
// implement hook_node_grants().
$grant_count = db_query('SELECT COUNT(*) FROM {node_access}')->fetchField();
if ($grant_count != 1 || count(module_implements('node_grants')) > 0) {
$value = format_plural($grant_count, 'One permission in use', '@count permissions in use', array('@count' => $grant_count));
}
else {
$value = t('Disabled');
}
$description = t('If the site is experiencing problems with permissions to content, you may have to rebuild the permissions cache. Rebuilding will remove all privileges to content and replace them with permissions based on the current modules and settings. Rebuilding may take some time if there is a lot of content or complex permission settings. After rebuilding has completed, content will automatically use the new permissions.');
$requirements['node_access'] = array(
'title' => t('Node Access Permissions'),
'value' => $value,
'description' => $description . ' ' . l(t('Rebuild permissions'), 'admin/reports/status/rebuild'),
);
}
return $requirements;
}
/**
* Implements hook_modules_enabled().
*/
function node_modules_enabled($modules) {
// Check if any of the newly enabled modules require the node_access table to
// be rebuilt.
if (!node_access_needs_rebuild() && array_intersect($modules, module_implements('node_grants'))) {
node_access_needs_rebuild(TRUE);
}
}
/**
* Controller class for nodes.
*
* This extends the DrupalDefaultEntityController class, adding required
* special handling for node objects.
*/
class NodeController extends DrupalDefaultEntityController {
protected function attachLoad(&$nodes, $revision_id = FALSE) {
// Create an array of nodes for each content type and pass this to the
// object type specific callback.
$typed_nodes = array();
foreach ($nodes as $id => $entity) {
$typed_nodes[$entity->type][$id] = $entity;
}
// Call object type specific callbacks on each typed array of nodes.
foreach ($typed_nodes as $node_type => $nodes_of_type) {
if (node_hook($node_type, 'load')) {
$function = node_type_get_base($node_type) . '_load';
$function($nodes_of_type);
}
}
// Besides the list of nodes, pass one additional argument to
// hook_node_load(), containing a list of node types that were loaded.
$argument = array_keys($typed_nodes);
$this->hookLoadArguments = array($argument);
parent::attachLoad($nodes, $revision_id);
}
protected function buildQuery($ids, $conditions = array(), $revision_id = FALSE) {
// Ensure that uid is taken from the {node} table,
// alias timestamp to revision_timestamp and add revision_uid.
$query = parent::buildQuery($ids, $conditions, $revision_id);
$fields =& $query->getFields();
unset($fields['timestamp']);
$query->addField('revision', 'timestamp', 'revision_timestamp');
$fields['uid']['table'] = 'base';
$query->addField('revision', 'uid', 'revision_uid');
return $query;
}
}
/**
* Implements hook_file_download_access().
*/
function node_file_download_access($field, $entity_type, $entity) {
if ($entity_type == 'node') {
return node_access('view', $entity);
}
}
Edit @type @title', array('@type' => $type_name, '@title' => $node->title)), PASS_THROUGH);
return drupal_get_form($node->type . '_node_form', $node);
}
/**
* Page callback: Displays add content links for available content types.
*
* Redirects to node/add/[type] if only one content type is available.
*
* @see node_menu()
*/
function node_add_page() {
$item = menu_get_item();
$content = system_admin_menu_block($item);
// Bypass the node/add listing if only one content type is available.
if (count($content) == 1) {
$item = array_shift($content);
drupal_goto($item['href']);
}
return theme('node_add_list', array('content' => $content));
}
/**
* Returns HTML for a list of available node types for node creation.
*
* @param $variables
* An associative array containing:
* - content: An array of content types.
*
* @ingroup themeable
*/
function theme_node_add_list($variables) {
$content = $variables['content'];
$output = '';
if ($content) {
$output = '';
foreach ($content as $item) {
$output .= '' . l($item['title'], $item['href'], $item['localized_options']) . ' ';
$output .= '' . filter_xss_admin($item['description']) . ' ';
}
$output .= ' ';
}
else {
$output = '' . t('You have not created any content types yet. Go to the content type creation page to add a new content type.', array('@create-content' => url('admin/structure/types/add'))) . '
';
}
return $output;
}
/**
* Returns a node submission form.
*
* @param $type
* The node type for the submitted node.
*
* @return
* The themed form.
*/
function node_add($type) {
global $user;
$types = node_type_get_types();
$node = (object) array('uid' => $user->uid, 'name' => (isset($user->name) ? $user->name : ''), 'type' => $type, 'language' => LANGUAGE_NONE);
drupal_set_title(t('Create @name', array('@name' => $types[$type]->name)), PASS_THROUGH);
$output = drupal_get_form($type . '_node_form', $node);
return $output;
}
/**
* Form validation handler for node_form().
*
* @see node_form()
* @see node_form_submit()
*/
function node_form_validate($form, &$form_state) {
// $form_state['node'] contains the actual entity being edited, but we must
// not update it with form values that have not yet been validated, so we
// create a pseudo-entity to use during validation.
$node = (object) $form_state['values'];
node_validate($node, $form, $form_state);
entity_form_field_validate('node', $form, $form_state);
}
/**
* Form constructor for the node add/edit form.
*
* @see node_form_validate()
* @see node_form_submit()
* @see node_form_build_preview()
* @see node_form_delete_submit()
* @ingroup forms
*/
function node_form($form, &$form_state, $node) {
global $user;
// During initial form build, add the node entity to the form state for use
// during form building and processing. During a rebuild, use what is in the
// form state.
if (!isset($form_state['node'])) {
if (!isset($node->title)) {
$node->title = NULL;
}
node_object_prepare($node);
$form_state['node'] = $node;
}
else {
$node = $form_state['node'];
}
// Some special stuff when previewing a node.
if (isset($form_state['node_preview'])) {
$form['#prefix'] = $form_state['node_preview'];
$node->in_preview = TRUE;
}
else {
unset($node->in_preview);
}
// Identify this as a node edit form.
// @todo D8: Remove. Modules can implement hook_form_BASE_FORM_ID_alter() now.
$form['#node_edit_form'] = TRUE;
$form['#attributes']['class'][] = 'node-form';
if (!empty($node->type)) {
$form['#attributes']['class'][] = 'node-' . $node->type . '-form';
}
// Basic node information.
// These elements are just values so they are not even sent to the client.
foreach (array('nid', 'vid', 'uid', 'created', 'type', 'language') as $key) {
$form[$key] = array(
'#type' => 'value',
'#value' => isset($node->$key) ? $node->$key : NULL,
);
}
// Changed must be sent to the client, for later overwrite error checking.
$form['changed'] = array(
'#type' => 'hidden',
'#default_value' => isset($node->changed) ? $node->changed : NULL,
);
// Invoke hook_form() to get the node-specific bits. Can't use node_invoke(),
// because hook_form() needs to be able to receive $form_state by reference.
// @todo hook_form() implementations are unable to add #validate or #submit
// handlers to the form buttons below. Remove hook_form() entirely.
$function = node_type_get_base($node) . '_form';
if (function_exists($function) && ($extra = $function($node, $form_state))) {
$form = array_merge_recursive($form, $extra);
}
// If the node type has a title, and the node type form defined no special
// weight for it, we default to a weight of -5 for consistency.
if (isset($form['title']) && !isset($form['title']['#weight'])) {
$form['title']['#weight'] = -5;
}
// @todo D8: Remove. Modules should access the node using $form_state['node'].
$form['#node'] = $node;
$form['additional_settings'] = array(
'#type' => 'vertical_tabs',
'#weight' => 99,
);
// Add a log field if the "Create new revision" option is checked, or if the
// current user has the ability to check that option.
$form['revision_information'] = array(
'#type' => 'fieldset',
'#title' => t('Revision information'),
'#collapsible' => TRUE,
// Collapsed by default when "Create new revision" is unchecked
'#collapsed' => !$node->revision,
'#group' => 'additional_settings',
'#attributes' => array(
'class' => array('node-form-revision-information'),
),
'#attached' => array(
'js' => array(drupal_get_path('module', 'node') . '/node.js'),
),
'#weight' => 20,
'#access' => $node->revision || user_access('administer nodes'),
);
$form['revision_information']['revision'] = array(
'#type' => 'checkbox',
'#title' => t('Create new revision'),
'#default_value' => $node->revision,
'#access' => user_access('administer nodes'),
);
// Check the revision log checkbox when the log textarea is filled in.
// This must not happen if "Create new revision" is enabled by default, since
// the state would auto-disable the checkbox otherwise.
if (!$node->revision) {
$form['revision_information']['revision']['#states'] = array(
'checked' => array(
'textarea[name="log"]' => array('empty' => FALSE),
),
);
}
$form['revision_information']['log'] = array(
'#type' => 'textarea',
'#title' => t('Revision log message'),
'#rows' => 4,
'#default_value' => !empty($node->log) ? $node->log : '',
'#description' => t('Provide an explanation of the changes you are making. This will help other authors understand your motivations.'),
);
// Node author information for administrators
$form['author'] = array(
'#type' => 'fieldset',
'#access' => user_access('administer nodes'),
'#title' => t('Authoring information'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#group' => 'additional_settings',
'#attributes' => array(
'class' => array('node-form-author'),
),
'#attached' => array(
'js' => array(
drupal_get_path('module', 'node') . '/node.js',
array(
'type' => 'setting',
'data' => array('anonymous' => variable_get('anonymous', t('Anonymous'))),
),
),
),
'#weight' => 90,
);
$form['author']['name'] = array(
'#type' => 'textfield',
'#title' => t('Authored by'),
'#maxlength' => 60,
'#autocomplete_path' => 'user/autocomplete',
'#default_value' => !empty($node->name) ? $node->name : '',
'#weight' => -1,
'#description' => t('Leave blank for %anonymous.', array('%anonymous' => variable_get('anonymous', t('Anonymous')))),
);
$form['author']['date'] = array(
'#type' => 'textfield',
'#title' => t('Authored on'),
'#maxlength' => 25,
'#description' => t('Format: %time. The date format is YYYY-MM-DD and %timezone is the time zone offset from UTC. Leave blank to use the time of form submission.', array('%time' => !empty($node->date) ? date_format(date_create($node->date), 'Y-m-d H:i:s O') : format_date($node->created, 'custom', 'Y-m-d H:i:s O'), '%timezone' => !empty($node->date) ? date_format(date_create($node->date), 'O') : format_date($node->created, 'custom', 'O'))),
'#default_value' => !empty($node->date) ? $node->date : '',
);
// Node options for administrators
$form['options'] = array(
'#type' => 'fieldset',
'#access' => user_access('administer nodes'),
'#title' => t('Publishing options'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#group' => 'additional_settings',
'#attributes' => array(
'class' => array('node-form-options'),
),
'#attached' => array(
'js' => array(drupal_get_path('module', 'node') . '/node.js'),
),
'#weight' => 95,
);
$form['options']['status'] = array(
'#type' => 'checkbox',
'#title' => t('Published'),
'#default_value' => $node->status,
);
$form['options']['promote'] = array(
'#type' => 'checkbox',
'#title' => t('Promoted to front page'),
'#default_value' => $node->promote,
);
$form['options']['sticky'] = array(
'#type' => 'checkbox',
'#title' => t('Sticky at top of lists'),
'#default_value' => $node->sticky,
);
// Add the buttons.
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#access' => variable_get('node_preview_' . $node->type, DRUPAL_OPTIONAL) != DRUPAL_REQUIRED || (!form_get_errors() && isset($form_state['node_preview'])),
'#value' => t('Save'),
'#weight' => 5,
'#submit' => array('node_form_submit'),
);
$form['actions']['preview'] = array(
'#access' => variable_get('node_preview_' . $node->type, DRUPAL_OPTIONAL) != DRUPAL_DISABLED,
'#type' => 'submit',
'#value' => t('Preview'),
'#weight' => 10,
'#submit' => array('node_form_build_preview'),
);
if (!empty($node->nid) && node_access('delete', $node)) {
$form['actions']['delete'] = array(
'#type' => 'submit',
'#value' => t('Delete'),
'#weight' => 15,
'#submit' => array('node_form_delete_submit'),
);
}
// This form uses a button-level #submit handler for the form's main submit
// action. node_form_submit() manually invokes all form-level #submit handlers
// of the form. Without explicitly setting #submit, Form API would auto-detect
// node_form_submit() as submit handler, but that is the button-level #submit
// handler for the 'Save' action. To maintain backwards compatibility, a
// #submit handler is auto-suggested for custom node type modules.
$form['#validate'][] = 'node_form_validate';
if (!isset($form['#submit']) && function_exists($node->type . '_node_form_submit')) {
$form['#submit'][] = $node->type . '_node_form_submit';
}
$form += array('#submit' => array());
field_attach_form('node', $node, $form, $form_state, entity_language('node', $node));
return $form;
}
/**
* Form submission handler for node_form().
*
* Handles the 'Delete' button on the node form.
*
* @see node_form()
* @see node_form_validate()
*/
function node_form_delete_submit($form, &$form_state) {
$destination = array();
if (isset($_GET['destination'])) {
$destination = drupal_get_destination();
unset($_GET['destination']);
}
$node = $form['#node'];
$form_state['redirect'] = array('node/' . $node->nid . '/delete', array('query' => $destination));
}
/**
* Form submission handler for node_form().
*
* Handles the 'Preview' button on the node form.
*
* @see node_form()
* @see node_form_validate()
*/
function node_form_build_preview($form, &$form_state) {
$node = node_form_submit_build_node($form, $form_state);
$form_state['node_preview'] = node_preview($node);
$form_state['rebuild'] = TRUE;
}
/**
* Generates a node preview.
*
* @param $node
* The node to preview.
*
* @return
* An HTML-formatted string of a node preview.
*
* @see node_form_build_preview()
*/
function node_preview($node) {
// Clone the node before previewing it to prevent the node itself from being
// modified.
$cloned_node = clone $node;
if (node_access('create', $cloned_node) || node_access('update', $cloned_node)) {
_field_invoke_multiple('load', 'node', array($cloned_node->nid => $cloned_node));
// Load the user's name when needed.
if (isset($cloned_node->name)) {
// The use of isset() is mandatory in the context of user IDs, because
// user ID 0 denotes the anonymous user.
if ($user = user_load_by_name($cloned_node->name)) {
$cloned_node->uid = $user->uid;
$cloned_node->picture = $user->picture;
}
else {
$cloned_node->uid = 0; // anonymous user
}
}
elseif ($cloned_node->uid) {
$user = user_load($cloned_node->uid);
$cloned_node->name = $user->name;
$cloned_node->picture = $user->picture;
}
$cloned_node->changed = REQUEST_TIME;
$nodes = array($cloned_node->nid => $cloned_node);
// Display a preview of the node.
if (!form_get_errors()) {
$cloned_node->in_preview = TRUE;
$output = theme('node_preview', array('node' => $cloned_node));
unset($cloned_node->in_preview);
}
drupal_set_title(t('Preview'), PASS_THROUGH);
return $output;
}
}
/**
* Returns HTML for a node preview for display during node creation and editing.
*
* @param $variables
* An associative array containing:
* - node: The node object which is being previewed.
*
* @see node_preview()
* @ingroup themeable
*/
function theme_node_preview($variables) {
$node = $variables['node'];
$output = '';
$preview_trimmed_version = FALSE;
$elements = node_view(clone $node, 'teaser');
$trimmed = drupal_render($elements);
$elements = node_view($node, 'full');
$full = drupal_render($elements);
// Do we need to preview trimmed version of post as well as full version?
if ($trimmed != $full) {
drupal_set_message(t('The trimmed version of your post shows what your post looks like when promoted to the main page or when exported for syndication. You can insert the delimiter "<!--break-->" (without the quotes) to fine-tune where your post gets split. '));
$output .= '
' . t('Preview trimmed version') . ' ';
$output .= $trimmed;
$output .= '' . t('Preview full version') . ' ';
$output .= $full;
}
else {
$output .= $full;
}
$output .= "\n";
return $output;
}
/**
* Form submission handler for node_form().
*
* @see node_form()
* @see node_form_validate()
*/
function node_form_submit($form, &$form_state) {
$node = node_form_submit_build_node($form, $form_state);
$insert = empty($node->nid);
node_save($node);
$node_link = l(t('view'), 'node/' . $node->nid);
$watchdog_args = array('@type' => $node->type, '%title' => $node->title);
$t_args = array('@type' => node_type_get_name($node), '%title' => $node->title);
if ($insert) {
watchdog('content', '@type: added %title.', $watchdog_args, WATCHDOG_NOTICE, $node_link);
drupal_set_message(t('@type %title has been created.', $t_args));
}
else {
watchdog('content', '@type: updated %title.', $watchdog_args, WATCHDOG_NOTICE, $node_link);
drupal_set_message(t('@type %title has been updated.', $t_args));
}
if ($node->nid) {
$form_state['values']['nid'] = $node->nid;
$form_state['nid'] = $node->nid;
$form_state['redirect'] = node_access('view', $node) ? 'node/' . $node->nid : '';
}
else {
// In the unlikely case something went wrong on save, the node will be
// rebuilt and node form redisplayed the same way as in preview.
drupal_set_message(t('The post could not be saved.'), 'error');
$form_state['rebuild'] = TRUE;
}
// Clear the page and block caches.
cache_clear_all();
}
/**
* Updates the form state's node entity by processing this submission's values.
*
* This is the default builder function for the node form. It is called
* during the "Save" and "Preview" submit handlers to retrieve the entity to
* save or preview. This function can also be called by a "Next" button of a
* wizard to update the form state's entity with the current step's values
* before proceeding to the next step.
*
* @see node_form()
*/
function node_form_submit_build_node($form, &$form_state) {
// @todo Legacy support for modules that extend the node form with form-level
// submit handlers that adjust $form_state['values'] prior to those values
// being used to update the entity. Module authors are encouraged to instead
// adjust the node directly within a hook_node_submit() implementation. For
// Drupal 8, evaluate whether the pattern of triggering form-level submit
// handlers during button-level submit processing is worth supporting
// properly, and if so, add a Form API function for doing so.
unset($form_state['submit_handlers']);
form_execute_handlers('submit', $form, $form_state);
$node = $form_state['node'];
entity_form_submit_build_entity('node', $node, $form, $form_state);
node_submit($node);
foreach (module_implements('node_submit') as $module) {
$function = $module . '_node_submit';
$function($node, $form, $form_state);
}
return $node;
}
/**
* Form constructor for the node deletion confirmation form.
*
* @see node_delete_confirm_submit()
*/
function node_delete_confirm($form, &$form_state, $node) {
$form['#node'] = $node;
// Always provide entity id in the same form key as in the entity edit form.
$form['nid'] = array('#type' => 'value', '#value' => $node->nid);
return confirm_form($form,
t('Are you sure you want to delete %title?', array('%title' => $node->title)),
'node/' . $node->nid,
t('This action cannot be undone.'),
t('Delete'),
t('Cancel')
);
}
/**
* Executes node deletion.
*
* @see node_delete_confirm()
*/
function node_delete_confirm_submit($form, &$form_state) {
if ($form_state['values']['confirm']) {
$node = node_load($form_state['values']['nid']);
node_delete($form_state['values']['nid']);
cache_clear_all();
watchdog('content', '@type: deleted %title.', array('@type' => $node->type, '%title' => $node->title));
drupal_set_message(t('@type %title has been deleted.', array('@type' => node_type_get_name($node), '%title' => $node->title)));
}
$form_state['redirect'] = '';
}
/**
* Generates an overview table of older revisions of a node.
*
* @param $node
* A node object.
*
* @return array
* An array as expected by drupal_render().
*
* @see node_menu()
*/
function node_revision_overview($node) {
drupal_set_title(t('Revisions for %title', array('%title' => $node->title)), PASS_THROUGH);
$header = array(t('Revision'), array('data' => t('Operations'), 'colspan' => 2));
$revisions = node_revision_list($node);
$rows = array();
$revert_permission = FALSE;
if ((user_access('revert revisions') || user_access('administer nodes')) && node_access('update', $node)) {
$revert_permission = TRUE;
}
$delete_permission = FALSE;
if ((user_access('delete revisions') || user_access('administer nodes')) && node_access('delete', $node)) {
$delete_permission = TRUE;
}
foreach ($revisions as $revision) {
$row = array();
$operations = array();
if ($revision->current_vid > 0) {
$row[] = array('data' => t('!date by !username', array('!date' => l(format_date($revision->timestamp, 'short'), "node/$node->nid"), '!username' => theme('username', array('account' => $revision))))
. (($revision->log != '') ? '' . filter_xss($revision->log) . '
' : ''),
'class' => array('revision-current'));
$operations[] = array('data' => drupal_placeholder(t('current revision')), 'class' => array('revision-current'), 'colspan' => 2);
}
else {
$row[] = t('!date by !username', array('!date' => l(format_date($revision->timestamp, 'short'), "node/$node->nid/revisions/$revision->vid/view"), '!username' => theme('username', array('account' => $revision))))
. (($revision->log != '') ? '' . filter_xss($revision->log) . '
' : '');
if ($revert_permission) {
$operations[] = l(t('revert'), "node/$node->nid/revisions/$revision->vid/revert");
}
if ($delete_permission) {
$operations[] = l(t('delete'), "node/$node->nid/revisions/$revision->vid/delete");
}
}
$rows[] = array_merge($row, $operations);
}
$build['node_revisions_table'] = array(
'#theme' => 'table',
'#rows' => $rows,
'#header' => $header,
);
return $build;
}
/**
* Asks for confirmation of the reversion to prevent against CSRF attacks.
*
* @param int $node_revision
* The node revision ID.
*
* @return array
* An array as expected by drupal_render().
*
* @see node_menu()
* @see node_revision_revert_confirm_submit()
* @ingroup forms
*/
function node_revision_revert_confirm($form, $form_state, $node_revision) {
$form['#node_revision'] = $node_revision;
return confirm_form($form, t('Are you sure you want to revert to the revision from %revision-date?', array('%revision-date' => format_date($node_revision->revision_timestamp))), 'node/' . $node_revision->nid . '/revisions', '', t('Revert'), t('Cancel'));
}
/**
* Form submission handler for node_revision_revert_confirm().
*/
function node_revision_revert_confirm_submit($form, &$form_state) {
$node_revision = $form['#node_revision'];
$node_revision->revision = 1;
$node_revision->log = t('Copy of the revision from %date.', array('%date' => format_date($node_revision->revision_timestamp)));
node_save($node_revision);
watchdog('content', '@type: reverted %title revision %revision.', array('@type' => $node_revision->type, '%title' => $node_revision->title, '%revision' => $node_revision->vid));
drupal_set_message(t('@type %title has been reverted back to the revision from %revision-date.', array('@type' => node_type_get_name($node_revision), '%title' => $node_revision->title, '%revision-date' => format_date($node_revision->revision_timestamp))));
$form_state['redirect'] = 'node/' . $node_revision->nid . '/revisions';
}
/**
* Form constructor for the revision deletion confirmation form.
*
* This form prevents against CSRF attacks.
*
* @param $node_revision
* The node revision ID.
*
* @return
* An array as expected by drupal_render().
*
* @see node_menu()
* @see node_revision_delete_confirm_submit()
* @ingroup forms
*/
function node_revision_delete_confirm($form, $form_state, $node_revision) {
$form['#node_revision'] = $node_revision;
return confirm_form($form, t('Are you sure you want to delete the revision from %revision-date?', array('%revision-date' => format_date($node_revision->revision_timestamp))), 'node/' . $node_revision->nid . '/revisions', t('This action cannot be undone.'), t('Delete'), t('Cancel'));
}
/**
* Form submission handler for node_revision_delete_confirm().
*/
function node_revision_delete_confirm_submit($form, &$form_state) {
$node_revision = $form['#node_revision'];
node_revision_delete($node_revision->vid);
watchdog('content', '@type: deleted %title revision %revision.', array('@type' => $node_revision->type, '%title' => $node_revision->title, '%revision' => $node_revision->vid));
drupal_set_message(t('Revision from %revision-date of @type %title has been deleted.', array('%revision-date' => format_date($node_revision->revision_timestamp), '@type' => node_type_get_name($node_revision), '%title' => $node_revision->title)));
$form_state['redirect'] = 'node/' . $node_revision->nid;
if (db_query('SELECT COUNT(vid) FROM {node_revision} WHERE nid = :nid', array(':nid' => $node_revision->nid))->fetchField() > 1) {
$form_state['redirect'] .= '/revisions';
}
}
profile != 'standard') {
$this->drupalCreateContentType(array('type' => 'page', 'name' => 'Basic page'));
$this->drupalCreateContentType(array('type' => 'article', 'name' => 'Article'));
}
}
}
/**
* Test the node_load_multiple() function.
*/
class NodeLoadMultipleTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Load multiple nodes',
'description' => 'Test the loading of multiple nodes.',
'group' => 'Node',
);
}
function setUp() {
parent::setUp();
$web_user = $this->drupalCreateUser(array('create article content', 'create page content'));
$this->drupalLogin($web_user);
}
/**
* Create four nodes and ensure they're loaded correctly.
*/
function testNodeMultipleLoad() {
$node1 = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1));
$node2 = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1));
$node3 = $this->drupalCreateNode(array('type' => 'article', 'promote' => 0));
$node4 = $this->drupalCreateNode(array('type' => 'page', 'promote' => 0));
// Confirm that promoted nodes appear in the default node listing.
$this->drupalGet('node');
$this->assertText($node1->title, 'Node title appears on the default listing.');
$this->assertText($node2->title, 'Node title appears on the default listing.');
$this->assertNoText($node3->title, 'Node title does not appear in the default listing.');
$this->assertNoText($node4->title, 'Node title does not appear in the default listing.');
// Load nodes with only a condition. Nodes 3 and 4 will be loaded.
$nodes = node_load_multiple(NULL, array('promote' => 0));
$this->assertEqual($node3->title, $nodes[$node3->nid]->title, 'Node was loaded.');
$this->assertEqual($node4->title, $nodes[$node4->nid]->title, 'Node was loaded.');
$count = count($nodes);
$this->assertTrue($count == 2, format_string('@count nodes loaded.', array('@count' => $count)));
// Load nodes by nid. Nodes 1, 2 and 4 will be loaded.
$nodes = node_load_multiple(array(1, 2, 4));
$count = count($nodes);
$this->assertTrue(count($nodes) == 3, format_string('@count nodes loaded', array('@count' => $count)));
$this->assertTrue(isset($nodes[$node1->nid]), 'Node is correctly keyed in the array');
$this->assertTrue(isset($nodes[$node2->nid]), 'Node is correctly keyed in the array');
$this->assertTrue(isset($nodes[$node4->nid]), 'Node is correctly keyed in the array');
foreach ($nodes as $node) {
$this->assertTrue(is_object($node), 'Node is an object');
}
// Load nodes by nid, where type = article. Nodes 1, 2 and 3 will be loaded.
$nodes = node_load_multiple(array(1, 2, 3, 4), array('type' => 'article'));
$count = count($nodes);
$this->assertTrue($count == 3, format_string('@count nodes loaded', array('@count' => $count)));
$this->assertEqual($nodes[$node1->nid]->title, $node1->title, 'Node successfully loaded.');
$this->assertEqual($nodes[$node2->nid]->title, $node2->title, 'Node successfully loaded.');
$this->assertEqual($nodes[$node3->nid]->title, $node3->title, 'Node successfully loaded.');
$this->assertFalse(isset($nodes[$node4->nid]));
// Now that all nodes have been loaded into the static cache, ensure that
// they are loaded correctly again when a condition is passed.
$nodes = node_load_multiple(array(1, 2, 3, 4), array('type' => 'article'));
$count = count($nodes);
$this->assertTrue($count == 3, format_string('@count nodes loaded.', array('@count' => $count)));
$this->assertEqual($nodes[$node1->nid]->title, $node1->title, 'Node successfully loaded');
$this->assertEqual($nodes[$node2->nid]->title, $node2->title, 'Node successfully loaded');
$this->assertEqual($nodes[$node3->nid]->title, $node3->title, 'Node successfully loaded');
$this->assertFalse(isset($nodes[$node4->nid]), 'Node was not loaded');
// Load nodes by nid, where type = article and promote = 0.
$nodes = node_load_multiple(array(1, 2, 3, 4), array('type' => 'article', 'promote' => 0));
$count = count($nodes);
$this->assertTrue($count == 1, format_string('@count node loaded', array('@count' => $count)));
$this->assertEqual($nodes[$node3->nid]->title, $node3->title, 'Node successfully loaded.');
}
}
/**
* Tests for the hooks invoked during node_load().
*/
class NodeLoadHooksTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Node load hooks',
'description' => 'Test the hooks invoked when a node is being loaded.',
'group' => 'Node',
);
}
function setUp() {
parent::setUp('node_test');
}
/**
* Test that hook_node_load() is invoked correctly.
*/
function testHookNodeLoad() {
// Create some sample articles and pages.
$node1 = $this->drupalCreateNode(array('type' => 'article', 'status' => NODE_PUBLISHED));
$node2 = $this->drupalCreateNode(array('type' => 'article', 'status' => NODE_PUBLISHED));
$node3 = $this->drupalCreateNode(array('type' => 'article', 'status' => NODE_NOT_PUBLISHED));
$node4 = $this->drupalCreateNode(array('type' => 'page', 'status' => NODE_NOT_PUBLISHED));
// Check that when a set of nodes that only contains articles is loaded,
// the properties added to the node by node_test_load_node() correctly
// reflect the expected values.
$nodes = node_load_multiple(array(), array('status' => NODE_PUBLISHED));
$loaded_node = end($nodes);
$this->assertEqual($loaded_node->node_test_loaded_nids, array($node1->nid, $node2->nid), 'hook_node_load() received the correct list of node IDs the first time it was called.');
$this->assertEqual($loaded_node->node_test_loaded_types, array('article'), 'hook_node_load() received the correct list of node types the first time it was called.');
// Now, as part of the same page request, load a set of nodes that contain
// both articles and pages, and make sure the parameters passed to
// node_test_node_load() are correctly updated.
$nodes = node_load_multiple(array(), array('status' => NODE_NOT_PUBLISHED));
$loaded_node = end($nodes);
$this->assertEqual($loaded_node->node_test_loaded_nids, array($node3->nid, $node4->nid), 'hook_node_load() received the correct list of node IDs the second time it was called.');
$this->assertEqual($loaded_node->node_test_loaded_types, array('article', 'page'), 'hook_node_load() received the correct list of node types the second time it was called.');
}
}
/**
* Tests the node revision functionality.
*/
class NodeRevisionsTestCase extends DrupalWebTestCase {
/**
* Nodes used by the test.
*
* @var array
*/
protected $nodes;
/**
* The revision messages for node revisions created in the test.
*
* @var array
*/
protected $logs;
public static function getInfo() {
return array(
'name' => 'Node revisions',
'description' => 'Create a node with revisions and test viewing, saving, reverting, and deleting revisions.',
'group' => 'Node',
);
}
function setUp() {
parent::setUp();
// Create and login user.
$web_user = $this->drupalCreateUser(array('view revisions', 'revert revisions', 'edit any page content',
'delete revisions', 'delete any page content'));
$this->drupalLogin($web_user);
// Create initial node.
$node = $this->drupalCreateNode();
$settings = get_object_vars($node);
$settings['revision'] = 1;
$nodes = array();
$logs = array();
// Get original node.
$nodes[] = $node;
// Create three revisions.
$revision_count = 3;
for ($i = 0; $i < $revision_count; $i++) {
$logs[] = $settings['log'] = $this->randomName(32);
// Create revision with random title and body and update variables.
$this->drupalCreateNode($settings);
$node = node_load($node->nid); // Make sure we get revision information.
$settings = get_object_vars($node);
$nodes[] = $node;
}
$this->nodes = $nodes;
$this->logs = $logs;
}
/**
* Checks node revision related operations.
*/
function testRevisions() {
$nodes = $this->nodes;
$logs = $this->logs;
// Get last node for simple checks.
$node = $nodes[3];
// Confirm the correct revision text appears on "view revisions" page.
$this->drupalGet("node/$node->nid/revisions/$node->vid/view");
$this->assertText($node->body[LANGUAGE_NONE][0]['value'], 'Correct text displays for version.');
// Confirm the correct log message appears on "revisions overview" page.
$this->drupalGet("node/$node->nid/revisions");
foreach ($logs as $log) {
$this->assertText($log, 'Log message found.');
}
// Confirm that revisions revert properly.
$this->drupalPost("node/$node->nid/revisions/{$nodes[1]->vid}/revert", array(), t('Revert'));
$this->assertRaw(t('@type %title has been reverted back to the revision from %revision-date.',
array('@type' => 'Basic page', '%title' => $nodes[1]->title,
'%revision-date' => format_date($nodes[1]->revision_timestamp))), 'Revision reverted.');
$reverted_node = node_load($node->nid);
$this->assertTrue(($nodes[1]->body[LANGUAGE_NONE][0]['value'] == $reverted_node->body[LANGUAGE_NONE][0]['value']), 'Node reverted correctly.');
// Confirm revisions delete properly.
$this->drupalPost("node/$node->nid/revisions/{$nodes[1]->vid}/delete", array(), t('Delete'));
$this->assertRaw(t('Revision from %revision-date of @type %title has been deleted.',
array('%revision-date' => format_date($nodes[1]->revision_timestamp),
'@type' => 'Basic page', '%title' => $nodes[1]->title)), 'Revision deleted.');
$this->assertTrue(db_query('SELECT COUNT(vid) FROM {node_revision} WHERE nid = :nid and vid = :vid', array(':nid' => $node->nid, ':vid' => $nodes[1]->vid))->fetchField() == 0, 'Revision not found.');
}
/**
* Checks that revisions are correctly saved without log messages.
*/
function testNodeRevisionWithoutLogMessage() {
// Create a node with an initial log message.
$log = $this->randomName(10);
$node = $this->drupalCreateNode(array('log' => $log));
// Save over the same revision and explicitly provide an empty log message
// (for example, to mimic the case of a node form submitted with no text in
// the "log message" field), and check that the original log message is
// preserved.
$new_title = $this->randomName(10) . 'testNodeRevisionWithoutLogMessage1';
$updated_node = (object) array(
'nid' => $node->nid,
'vid' => $node->vid,
'uid' => $node->uid,
'type' => $node->type,
'title' => $new_title,
'log' => '',
);
node_save($updated_node);
$this->drupalGet('node/' . $node->nid);
$this->assertText($new_title, 'New node title appears on the page.');
$node_revision = node_load($node->nid, NULL, TRUE);
$this->assertEqual($node_revision->log, $log, 'After an existing node revision is re-saved without a log message, the original log message is preserved.');
// Create another node with an initial log message.
$node = $this->drupalCreateNode(array('log' => $log));
// Save a new node revision without providing a log message, and check that
// this revision has an empty log message.
$new_title = $this->randomName(10) . 'testNodeRevisionWithoutLogMessage2';
$updated_node = (object) array(
'nid' => $node->nid,
'vid' => $node->vid,
'uid' => $node->uid,
'type' => $node->type,
'title' => $new_title,
'revision' => 1,
);
node_save($updated_node);
$this->drupalGet('node/' . $node->nid);
$this->assertText($new_title, 'New node title appears on the page.');
$node_revision = node_load($node->nid, NULL, TRUE);
$this->assertTrue(empty($node_revision->log), 'After a new node revision is saved with an empty log message, the log message for the node is empty.');
}
}
/**
* Tests the node edit functionality.
*/
class PageEditTestCase extends DrupalWebTestCase {
/**
* A user with permission to create and edit own page content.
*
* @var object
*/
protected $web_user;
/**
* A user with permission to bypass node access and administer nodes.
*
* @var object
*/
protected $admin_user;
public static function getInfo() {
return array(
'name' => 'Node edit',
'description' => 'Create a node and test node edit functionality.',
'group' => 'Node',
);
}
function setUp() {
parent::setUp();
$this->web_user = $this->drupalCreateUser(array('edit own page content', 'create page content'));
$this->admin_user = $this->drupalCreateUser(array('bypass node access', 'administer nodes'));
}
/**
* Checks node edit functionality.
*/
function testPageEdit() {
$this->drupalLogin($this->web_user);
$langcode = LANGUAGE_NONE;
$title_key = "title";
$body_key = "body[$langcode][0][value]";
// Create node to edit.
$edit = array();
$edit[$title_key] = $this->randomName(8);
$edit[$body_key] = $this->randomName(16);
$this->drupalPost('node/add/page', $edit, t('Save'));
// Check that the node exists in the database.
$node = $this->drupalGetNodeByTitle($edit[$title_key]);
$this->assertTrue($node, 'Node found in database.');
// Check that "edit" link points to correct page.
$this->clickLink(t('Edit'));
$edit_url = url("node/$node->nid/edit", array('absolute' => TRUE));
$actual_url = $this->getURL();
$this->assertEqual($edit_url, $actual_url, 'On edit page.');
// Check that the title and body fields are displayed with the correct values.
$active = '' . t('(active tab)') . ' ';
$link_text = t('!local-task-title!active', array('!local-task-title' => t('Edit'), '!active' => $active));
$this->assertText(strip_tags($link_text), 0, 'Edit tab found and marked active.');
$this->assertFieldByName($title_key, $edit[$title_key], 'Title field displayed.');
$this->assertFieldByName($body_key, $edit[$body_key], 'Body field displayed.');
// Edit the content of the node.
$edit = array();
$edit[$title_key] = $this->randomName(8);
$edit[$body_key] = $this->randomName(16);
// Stay on the current page, without reloading.
$this->drupalPost(NULL, $edit, t('Save'));
// Check that the title and body fields are displayed with the updated values.
$this->assertText($edit[$title_key], 'Title displayed.');
$this->assertText($edit[$body_key], 'Body displayed.');
// Login as a second administrator user.
$second_web_user = $this->drupalCreateUser(array('administer nodes', 'edit any page content'));
$this->drupalLogin($second_web_user);
// Edit the same node, creating a new revision.
$this->drupalGet("node/$node->nid/edit");
$edit = array();
$edit['title'] = $this->randomName(8);
$edit[$body_key] = $this->randomName(16);
$edit['revision'] = TRUE;
$this->drupalPost(NULL, $edit, t('Save'));
// Ensure that the node revision has been created.
$revised_node = $this->drupalGetNodeByTitle($edit['title']);
$this->assertNotIdentical($node->vid, $revised_node->vid, 'A new revision has been created.');
// Ensure that the node author is preserved when it was not changed in the
// edit form.
$this->assertIdentical($node->uid, $revised_node->uid, 'The node author has been preserved.');
// Ensure that the revision authors are different since the revisions were
// made by different users.
$first_node_version = node_load($node->nid, $node->vid);
$second_node_version = node_load($node->nid, $revised_node->vid);
$this->assertNotIdentical($first_node_version->revision_uid, $second_node_version->revision_uid, 'Each revision has a distinct user.');
}
/**
* Tests changing a node's "authored by" field.
*/
function testPageAuthoredBy() {
$this->drupalLogin($this->admin_user);
// Create node to edit.
$langcode = LANGUAGE_NONE;
$body_key = "body[$langcode][0][value]";
$edit = array();
$edit['title'] = $this->randomName(8);
$edit[$body_key] = $this->randomName(16);
$this->drupalPost('node/add/page', $edit, t('Save'));
// Check that the node was authored by the currently logged in user.
$node = $this->drupalGetNodeByTitle($edit['title']);
$this->assertIdentical($node->uid, $this->admin_user->uid, 'Node authored by admin user.');
// Try to change the 'authored by' field to an invalid user name.
$edit = array(
'name' => 'invalid-name',
);
$this->drupalPost('node/' . $node->nid . '/edit', $edit, t('Save'));
$this->assertText('The username invalid-name does not exist.');
// Change the authored by field to an empty string, which should assign
// authorship to the anonymous user (uid 0).
$edit['name'] = '';
$this->drupalPost('node/' . $node->nid . '/edit', $edit, t('Save'));
$node = node_load($node->nid, NULL, TRUE);
$this->assertIdentical($node->uid, '0', 'Node authored by anonymous user.');
// Change the authored by field to another user's name (that is not
// logged in).
$edit['name'] = $this->web_user->name;
$this->drupalPost('node/' . $node->nid . '/edit', $edit, t('Save'));
$node = node_load($node->nid, NULL, TRUE);
$this->assertIdentical($node->uid, $this->web_user->uid, 'Node authored by normal user.');
// Check that normal users cannot change the authored by information.
$this->drupalLogin($this->web_user);
$this->drupalGet('node/' . $node->nid . '/edit');
$this->assertNoFieldByName('name');
}
}
/**
* Tests the node entity preview functionality.
*/
class PagePreviewTestCase extends DrupalWebTestCase {
protected $field;
protected $field_name;
protected $instance;
protected $vocabulary;
protected $term;
public static function getInfo() {
return array(
'name' => 'Node preview',
'description' => 'Test node preview functionality.',
'group' => 'Node',
);
}
function setUp() {
parent::setUp(array('taxonomy', 'node'));
$web_user = $this->drupalCreateUser(array('edit own page content', 'create page content'));
$this->drupalLogin($web_user);
// Add a vocabulary so we can test different view modes.
$vocabulary = (object) array(
'name' => $this->randomName(),
'description' => $this->randomName(),
'machine_name' => drupal_strtolower($this->randomName()),
'help' => '',
'nodes' => array('page' => 'page'),
);
taxonomy_vocabulary_save($vocabulary);
$this->vocabulary = $vocabulary;
// Add a term to the vocabulary.
$term = (object) array(
'name' => $this->randomName(),
'description' => $this->randomName(),
// Use the first available text format.
'format' => db_query_range('SELECT format FROM {filter_format}', 0, 1)->fetchField(),
'vid' => $this->vocabulary->vid,
'vocabulary_machine_name' => $vocabulary->machine_name,
);
taxonomy_term_save($term);
$this->term = $term;
// Set up a field and instance.
$this->field_name = drupal_strtolower($this->randomName());
$this->field = array(
'field_name' => $this->field_name,
'type' => 'taxonomy_term_reference',
'settings' => array(
'allowed_values' => array(
array(
'vocabulary' => $this->vocabulary->machine_name,
'parent' => '0',
),
),
)
);
field_create_field($this->field);
$this->instance = array(
'field_name' => $this->field_name,
'entity_type' => 'node',
'bundle' => 'page',
'widget' => array(
'type' => 'options_select',
),
// Hide on full display but render on teaser.
'display' => array(
'default' => array(
'type' => 'hidden',
),
'teaser' => array(
'type' => 'taxonomy_term_reference_link',
),
),
);
field_create_instance($this->instance);
}
/**
* Checks the node preview functionality.
*/
function testPagePreview() {
$langcode = LANGUAGE_NONE;
$title_key = "title";
$body_key = "body[$langcode][0][value]";
$term_key = "{$this->field_name}[$langcode]";
// Fill in node creation form and preview node.
$edit = array();
$edit[$title_key] = $this->randomName(8);
$edit[$body_key] = $this->randomName(16);
$edit[$term_key] = $this->term->tid;
$this->drupalPost('node/add/page', $edit, t('Preview'));
// Check that the preview is displaying the title, body, and term.
$this->assertTitle(t('Preview | Drupal'), 'Basic page title is preview.');
$this->assertText($edit[$title_key], 'Title displayed.');
$this->assertText($edit[$body_key], 'Body displayed.');
$this->assertText($this->term->name, 'Term displayed.');
// Check that the title, body, and term fields are displayed with the
// correct values.
$this->assertFieldByName($title_key, $edit[$title_key], 'Title field displayed.');
$this->assertFieldByName($body_key, $edit[$body_key], 'Body field displayed.');
$this->assertFieldByName($term_key, $edit[$term_key], 'Term field displayed.');
}
/**
* Checks the node preview functionality, when using revisions.
*/
function testPagePreviewWithRevisions() {
$langcode = LANGUAGE_NONE;
$title_key = "title";
$body_key = "body[$langcode][0][value]";
$term_key = "{$this->field_name}[$langcode]";
// Force revision on "Basic page" content.
variable_set('node_options_page', array('status', 'revision'));
// Fill in node creation form and preview node.
$edit = array();
$edit[$title_key] = $this->randomName(8);
$edit[$body_key] = $this->randomName(16);
$edit[$term_key] = $this->term->tid;
$edit['log'] = $this->randomName(32);
$this->drupalPost('node/add/page', $edit, t('Preview'));
// Check that the preview is displaying the title, body, and term.
$this->assertTitle(t('Preview | Drupal'), 'Basic page title is preview.');
$this->assertText($edit[$title_key], 'Title displayed.');
$this->assertText($edit[$body_key], 'Body displayed.');
$this->assertText($this->term->name, 'Term displayed.');
// Check that the title, body, and term fields are displayed with the
// correct values.
$this->assertFieldByName($title_key, $edit[$title_key], 'Title field displayed.');
$this->assertFieldByName($body_key, $edit[$body_key], 'Body field displayed.');
$this->assertFieldByName($term_key, $edit[$term_key], 'Term field displayed.');
// Check that the log field has the correct value.
$this->assertFieldByName('log', $edit['log'], 'Log field displayed.');
}
}
/**
* Tests creating and saving a node.
*/
class NodeCreationTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Node creation',
'description' => 'Create a node and test saving it.',
'group' => 'Node',
);
}
function setUp() {
// Enable dummy module that implements hook_node_insert for exceptions.
parent::setUp('node_test_exception');
$web_user = $this->drupalCreateUser(array('create page content', 'edit own page content'));
$this->drupalLogin($web_user);
}
/**
* Creates a "Basic page" node and verifies its consistency in the database.
*/
function testNodeCreation() {
// Create a node.
$edit = array();
$langcode = LANGUAGE_NONE;
$edit["title"] = $this->randomName(8);
$edit["body[$langcode][0][value]"] = $this->randomName(16);
$this->drupalPost('node/add/page', $edit, t('Save'));
// Check that the Basic page has been created.
$this->assertRaw(t('!post %title has been created.', array('!post' => 'Basic page', '%title' => $edit["title"])), 'Basic page created.');
// Check that the node exists in the database.
$node = $this->drupalGetNodeByTitle($edit["title"]);
$this->assertTrue($node, 'Node found in database.');
}
/**
* Verifies that a transaction rolls back the failed creation.
*/
function testFailedPageCreation() {
// Create a node.
$edit = array(
'uid' => $this->loggedInUser->uid,
'name' => $this->loggedInUser->name,
'type' => 'page',
'language' => LANGUAGE_NONE,
'title' => 'testing_transaction_exception',
);
try {
// An exception is generated by node_test_exception_node_insert() if the
// title is 'testing_transaction_exception'.
node_save((object) $edit);
$this->fail(t('Expected exception has not been thrown.'));
}
catch (Exception $e) {
$this->pass(t('Expected exception has been thrown.'));
}
if (Database::getConnection()->supportsTransactions()) {
// Check that the node does not exist in the database.
$node = $this->drupalGetNodeByTitle($edit['title']);
$this->assertFalse($node, 'Transactions supported, and node not found in database.');
}
else {
// Check that the node exists in the database.
$node = $this->drupalGetNodeByTitle($edit['title']);
$this->assertTrue($node, 'Transactions not supported, and node found in database.');
// Check that the failed rollback was logged.
$records = db_query("SELECT wid FROM {watchdog} WHERE message LIKE 'Explicit rollback failed%'")->fetchAll();
$this->assertTrue(count($records) > 0, 'Transactions not supported, and rollback error logged to watchdog.');
}
// Check that the rollback error was logged.
// PostgreSQL doesn't support bytea LIKE queries, so we need to unserialize
// first to check for the rollback exception message.
$matches = array();
$records = db_query("SELECT wid, variables FROM {watchdog}")->fetchAll();
foreach ($records as $record) {
$variables = (array) unserialize($record->variables);
if (isset($variables['!message']) && $variables['!message'] === 'Test exception for rollback.') {
$matches[] = $record->wid;
}
}
$this->assertTrue(count($matches) > 0, 'Rollback explanatory error logged to watchdog.');
}
/**
* Create an unpublished node and confirm correct redirect behavior.
*/
function testUnpublishedNodeCreation() {
// Set "Basic page" content type to be unpublished by default.
variable_set('node_options_page', array());
// Set the front page to the default "node" page.
variable_set('site_frontpage', 'node');
// Create a node.
$edit = array();
$edit["title"] = $this->randomName(8);
$edit["body[" . LANGUAGE_NONE . "][0][value]"] = $this->randomName(16);
$this->drupalPost('node/add/page', $edit, t('Save'));
// Check that the user was redirected to the home page.
$this->assertText(t('Welcome to Drupal'), t('The user is redirected to the home page.'));
}
}
/**
* Tests the functionality of node entity edit permissions.
*/
class PageViewTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Node edit permissions',
'description' => 'Create a node and test edit permissions.',
'group' => 'Node',
);
}
/**
* Tests an anonymous and unpermissioned user attempting to edit the node.
*/
function testPageView() {
// Create a node to view.
$node = $this->drupalCreateNode();
$this->assertTrue(node_load($node->nid), 'Node created.');
// Try to edit with anonymous user.
$html = $this->drupalGet("node/$node->nid/edit");
$this->assertResponse(403);
// Create a user without permission to edit node.
$web_user = $this->drupalCreateUser(array('access content'));
$this->drupalLogin($web_user);
// Attempt to access edit page.
$this->drupalGet("node/$node->nid/edit");
$this->assertResponse(403);
// Create user with permission to edit node.
$web_user = $this->drupalCreateUser(array('bypass node access'));
$this->drupalLogin($web_user);
// Attempt to access edit page.
$this->drupalGet("node/$node->nid/edit");
$this->assertResponse(200);
}
}
/**
* Tests the summary length functionality.
*/
class SummaryLengthTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Summary length',
'description' => 'Test summary length.',
'group' => 'Node',
);
}
/**
* Tests the node summary length functionality.
*/
function testSummaryLength() {
// Create a node to view.
$settings = array(
'body' => array(LANGUAGE_NONE => array(array('value' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam vitae arcu at leo cursus laoreet. Curabitur dui tortor, adipiscing malesuada tempor in, bibendum ac diam. Cras non tellus a libero pellentesque condimentum. What is a Drupalism? Suspendisse ac lacus libero. Ut non est vel nisl faucibus interdum nec sed leo. Pellentesque sem risus, vulputate eu semper eget, auctor in libero. Ut fermentum est vitae metus convallis scelerisque. Phasellus pellentesque rhoncus tellus, eu dignissim purus posuere id. Quisque eu fringilla ligula. Morbi ullamcorper, lorem et mattis egestas, tortor neque pretium velit, eget eleifend odio turpis eu purus. Donec vitae metus quis leo pretium tincidunt a pulvinar sem. Morbi adipiscing laoreet mauris vel placerat. Nullam elementum, nisl sit amet scelerisque malesuada, dolor nunc hendrerit quam, eu ultrices erat est in orci. Curabitur feugiat egestas nisl sed accumsan.'))),
'promote' => 1,
);
$node = $this->drupalCreateNode($settings);
$this->assertTrue(node_load($node->nid), 'Node created.');
// Create user with permission to view the node.
$web_user = $this->drupalCreateUser(array('access content', 'administer content types'));
$this->drupalLogin($web_user);
// Attempt to access the front page.
$this->drupalGet("node");
// The node teaser when it has 600 characters in length
$expected = 'What is a Drupalism?';
$this->assertRaw($expected, 'Check that the summary is 600 characters in length', 'Node');
// Change the teaser length for "Basic page" content type.
$instance = field_info_instance('node', 'body', $node->type);
$instance['display']['teaser']['settings']['trim_length'] = 200;
field_update_instance($instance);
// Attempt to access the front page again and check if the summary is now only 200 characters in length.
$this->drupalGet("node");
$this->assertNoRaw($expected, 'Check that the summary is not longer than 200 characters', 'Node');
}
}
/**
* Tests XSS functionality with a node entity.
*/
class NodeTitleXSSTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Node title XSS filtering',
'description' => 'Create a node with dangerous tags in its title and test that they are escaped.',
'group' => 'Node',
);
}
/**
* Tests XSS functionality with a node entity.
*/
function testNodeTitleXSS() {
// Prepare a user to do the stuff.
$web_user = $this->drupalCreateUser(array('create page content', 'edit any page content'));
$this->drupalLogin($web_user);
$xss = '';
$title = $xss . $this->randomName();
$edit = array("title" => $title);
$this->drupalPost('node/add/page', $edit, t('Preview'));
$this->assertNoRaw($xss, 'Harmful tags are escaped when previewing a node.');
$settings = array('title' => $title);
$node = $this->drupalCreateNode($settings);
$this->drupalGet('node/' . $node->nid);
// assertTitle() decodes HTML-entities inside the element.
$this->assertTitle($edit["title"] . ' | Drupal', 'Title is diplayed when viewing a node.');
$this->assertNoRaw($xss, 'Harmful tags are escaped when viewing a node.');
$this->drupalGet('node/' . $node->nid . '/edit');
$this->assertNoRaw($xss, 'Harmful tags are escaped when editing a node.');
}
}
/**
* Tests the availability of the syndicate block.
*/
class NodeBlockTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Block availability',
'description' => 'Check if the syndicate block is available.',
'group' => 'Node',
);
}
function setUp() {
parent::setUp();
// Create and login user
$admin_user = $this->drupalCreateUser(array('administer blocks'));
$this->drupalLogin($admin_user);
}
/**
* Tests that the "Syndicate" block is shown when enabled.
*/
function testSyndicateBlock() {
// Set block title to confirm that the interface is available.
$this->drupalPost('admin/structure/block/manage/node/syndicate/configure', array('title' => $this->randomName(8)), t('Save block'));
$this->assertText(t('The block configuration has been saved.'), 'Block configuration set.');
// Set the block to a region to confirm block is available.
$edit = array();
$edit['blocks[node_syndicate][region]'] = 'footer';
$this->drupalPost('admin/structure/block', $edit, t('Save blocks'));
$this->assertText(t('The block settings have been updated.'), 'Block successfully move to footer region.');
}
}
/**
* Checks that the post information displays when enabled for a content type.
*/
class NodePostSettingsTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Node post information display',
'description' => 'Check that the post information (submitted by Username on date) text displays appropriately.',
'group' => 'Node',
);
}
function setUp() {
parent::setUp();
$web_user = $this->drupalCreateUser(array('create page content', 'administer content types', 'access user profiles'));
$this->drupalLogin($web_user);
}
/**
* Confirms "Basic page" content type and post information is on a new node.
*/
function testPagePostInfo() {
// Set "Basic page" content type to display post information.
$edit = array();
$edit['node_submitted'] = TRUE;
$this->drupalPost('admin/structure/types/manage/page', $edit, t('Save content type'));
// Create a node.
$edit = array();
$langcode = LANGUAGE_NONE;
$edit["title"] = $this->randomName(8);
$edit["body[$langcode][0][value]"] = $this->randomName(16);
$this->drupalPost('node/add/page', $edit, t('Save'));
// Check that the post information is displayed.
$node = $this->drupalGetNodeByTitle($edit["title"]);
$elements = $this->xpath('//div[contains(@class,:class)]', array(':class' => 'submitted'));
$this->assertEqual(count($elements), 1, 'Post information is displayed.');
}
/**
* Confirms absence of post information on a new node.
*/
function testPageNotPostInfo() {
// Set "Basic page" content type to display post information.
$edit = array();
$edit['node_submitted'] = FALSE;
$this->drupalPost('admin/structure/types/manage/page', $edit, t('Save content type'));
// Create a node.
$edit = array();
$langcode = LANGUAGE_NONE;
$edit["title"] = $this->randomName(8);
$edit["body[$langcode][0][value]"] = $this->randomName(16);
$this->drupalPost('node/add/page', $edit, t('Save'));
// Check that the post information is displayed.
$node = $this->drupalGetNodeByTitle($edit["title"]);
$this->assertNoRaw('<span class="submitted">', 'Post information is not displayed.');
}
}
/**
* Ensures that data added to nodes by other modules appears in RSS feeds.
*
* Create a node, enable the node_test module to ensure that extra data is
* added to the node->content array, then verify that the data appears on the
* sitewide RSS feed at rss.xml.
*/
class NodeRSSContentTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Node RSS Content',
'description' => 'Ensure that data added to nodes by other modules appears in RSS feeds.',
'group' => 'Node',
);
}
function setUp() {
// Enable dummy module that implements hook_node_view.
parent::setUp('node_test');
// Use bypass node access permission here, because the test class uses
// hook_grants_alter() to deny access to everyone on node_access
// queries.
$user = $this->drupalCreateUser(array('bypass node access', 'access content', 'create article content'));
$this->drupalLogin($user);
}
/**
* Ensures that a new node includes the custom data when added to an RSS feed.
*/
function testNodeRSSContent() {
// Create a node.
$node = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1));
$this->drupalGet('rss.xml');
// Check that content added in 'rss' view mode appear in RSS feed.
$rss_only_content = t('Extra data that should appear only in the RSS feed for node !nid.', array('!nid' => $node->nid));
$this->assertText($rss_only_content, 'Node content designated for RSS appear in RSS feed.');
// Check that content added in view modes other than 'rss' doesn't
// appear in RSS feed.
$non_rss_content = t('Extra data that should appear everywhere except the RSS feed for node !nid.', array('!nid' => $node->nid));
$this->assertNoText($non_rss_content, 'Node content not designed for RSS doesn\'t appear in RSS feed.');
// Check that extra RSS elements and namespaces are added to RSS feed.
$test_element = array(
'key' => 'testElement',
'value' => t('Value of testElement RSS element for node !nid.', array('!nid' => $node->nid)),
);
$test_ns = 'xmlns:drupaltest="http://example.com/test-namespace"';
$this->assertRaw(format_xml_elements(array($test_element)), 'Extra RSS elements appear in RSS feed.');
$this->assertRaw($test_ns, 'Extra namespaces appear in RSS feed.');
// Check that content added in 'rss' view mode doesn't appear when
// viewing node.
$this->drupalGet("node/$node->nid");
$this->assertNoText($rss_only_content, 'Node content designed for RSS doesn\'t appear when viewing node.');
// Check that the node feed page does not try to interpret additional path
// components as arguments for node_feed() and returns default content.
$this->drupalGet('rss.xml/' . $this->randomName() . '/' . $this->randomName());
$this->assertText($rss_only_content, 'Ignore page arguments when delivering rss.xml.');
}
}
/**
* Tests basic node_access functionality.
*
* Note that hook_node_access_records() is covered in another test class.
*
* @todo Cover hook_node_access in a separate test class.
*/
class NodeAccessTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Node access',
'description' => 'Test node_access function',
'group' => 'Node',
);
}
/**
* Asserts node_access() correctly grants or denies access.
*/
function assertNodeAccess($ops, $node, $account) {
foreach ($ops as $op => $result) {
$msg = format_string("node_access returns @result with operation '@op'.", array('@result' => $result ? 'true' : 'false', '@op' => $op));
$this->assertEqual($result, node_access($op, $node, $account), $msg);
}
}
function setUp() {
parent::setUp();
// Clear permissions for authenticated users.
db_delete('role_permission')
->condition('rid', DRUPAL_AUTHENTICATED_RID)
->execute();
}
/**
* Runs basic tests for node_access function.
*/
function testNodeAccess() {
// Ensures user without 'access content' permission can do nothing.
$web_user1 = $this->drupalCreateUser(array('create page content', 'edit any page content', 'delete any page content'));
$node1 = $this->drupalCreateNode(array('type' => 'page'));
$this->assertNodeAccess(array('create' => FALSE), 'page', $web_user1);
$this->assertNodeAccess(array('view' => FALSE, 'update' => FALSE, 'delete' => FALSE), $node1, $web_user1);
// Ensures user with 'bypass node access' permission can do everything.
$web_user2 = $this->drupalCreateUser(array('bypass node access'));
$node2 = $this->drupalCreateNode(array('type' => 'page'));
$this->assertNodeAccess(array('create' => TRUE), 'page', $web_user2);
$this->assertNodeAccess(array('view' => TRUE, 'update' => TRUE, 'delete' => TRUE), $node2, $web_user2);
// User cannot 'view own unpublished content'.
$web_user3 = $this->drupalCreateUser(array('access content'));
$node3 = $this->drupalCreateNode(array('status' => 0, 'uid' => $web_user3->uid));
$this->assertNodeAccess(array('view' => FALSE), $node3, $web_user3);
// User cannot create content without permission.
$this->assertNodeAccess(array('create' => FALSE), 'page', $web_user3);
// User can 'view own unpublished content', but another user cannot.
$web_user4 = $this->drupalCreateUser(array('access content', 'view own unpublished content'));
$web_user5 = $this->drupalCreateUser(array('access content', 'view own unpublished content'));
$node4 = $this->drupalCreateNode(array('status' => 0, 'uid' => $web_user4->uid));
$this->assertNodeAccess(array('view' => TRUE, 'update' => FALSE), $node4, $web_user4);
$this->assertNodeAccess(array('view' => FALSE), $node4, $web_user5);
// Tests the default access provided for a published node.
$node5 = $this->drupalCreateNode();
$this->assertNodeAccess(array('view' => TRUE, 'update' => FALSE, 'delete' => FALSE), $node5, $web_user3);
}
}
/**
* Tests hook_node_access_records() functionality.
*/
class NodeAccessRecordsTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Node access records',
'description' => 'Test hook_node_access_records when acquiring grants.',
'group' => 'Node',
);
}
function setUp() {
// Enable dummy module that implements hook_node_grants(),
// hook_node_access_records(), hook_node_grants_alter() and
// hook_node_access_records_alter().
parent::setUp('node_test');
}
/**
* Creates a node and tests the creation of node access rules.
*/
function testNodeAccessRecords() {
// Create an article node.
$node1 = $this->drupalCreateNode(array('type' => 'article'));
$this->assertTrue(node_load($node1->nid), 'Article node created.');
// Check to see if grants added by node_test_node_access_records made it in.
$records = db_query('SELECT realm, gid FROM {node_access} WHERE nid = :nid', array(':nid' => $node1->nid))->fetchAll();
$this->assertEqual(count($records), 1, 'Returned the correct number of rows.');
$this->assertEqual($records[0]->realm, 'test_article_realm', 'Grant with article_realm acquired for node without alteration.');
$this->assertEqual($records[0]->gid, 1, 'Grant with gid = 1 acquired for node without alteration.');
// Create an unpromoted "Basic page" node.
$node2 = $this->drupalCreateNode(array('type' => 'page', 'promote' => 0));
$this->assertTrue(node_load($node2->nid), 'Unpromoted basic page node created.');
// Check to see if grants added by node_test_node_access_records made it in.
$records = db_query('SELECT realm, gid FROM {node_access} WHERE nid = :nid', array(':nid' => $node2->nid))->fetchAll();
$this->assertEqual(count($records), 1, 'Returned the correct number of rows.');
$this->assertEqual($records[0]->realm, 'test_page_realm', 'Grant with page_realm acquired for node without alteration.');
$this->assertEqual($records[0]->gid, 1, 'Grant with gid = 1 acquired for node without alteration.');
// Create an unpromoted, unpublished "Basic page" node.
$node3 = $this->drupalCreateNode(array('type' => 'page', 'promote' => 0, 'status' => 0));
$this->assertTrue(node_load($node3->nid), 'Unpromoted, unpublished basic page node created.');
// Check to see if grants added by node_test_node_access_records made it in.
$records = db_query('SELECT realm, gid FROM {node_access} WHERE nid = :nid', array(':nid' => $node3->nid))->fetchAll();
$this->assertEqual(count($records), 1, 'Returned the correct number of rows.');
$this->assertEqual($records[0]->realm, 'test_page_realm', 'Grant with page_realm acquired for node without alteration.');
$this->assertEqual($records[0]->gid, 1, 'Grant with gid = 1 acquired for node without alteration.');
// Create a promoted "Basic page" node.
$node4 = $this->drupalCreateNode(array('type' => 'page', 'promote' => 1));
$this->assertTrue(node_load($node4->nid), 'Promoted basic page node created.');
// Check to see if grant added by node_test_node_access_records was altered
// by node_test_node_access_records_alter.
$records = db_query('SELECT realm, gid FROM {node_access} WHERE nid = :nid', array(':nid' => $node4->nid))->fetchAll();
$this->assertEqual(count($records), 1, 'Returned the correct number of rows.');
$this->assertEqual($records[0]->realm, 'test_alter_realm', 'Altered grant with alter_realm acquired for node.');
$this->assertEqual($records[0]->gid, 2, 'Altered grant with gid = 2 acquired for node.');
// Check to see if we can alter grants with hook_node_grants_alter().
$operations = array('view', 'update', 'delete');
// Create a user that is allowed to access content.
$web_user = $this->drupalCreateUser(array('access content'));
foreach ($operations as $op) {
$grants = node_test_node_grants($op, $web_user);
$altered_grants = $grants;
drupal_alter('node_grants', $altered_grants, $web_user, $op);
$this->assertNotEqual($grants, $altered_grants, format_string('Altered the %op grant for a user.', array('%op' => $op)));
}
// Check that core does not grant access to an unpublished node when an
// empty $grants array is returned.
$node6 = $this->drupalCreateNode(array('status' => 0, 'disable_node_access' => TRUE));
$records = db_query('SELECT realm, gid FROM {node_access} WHERE nid = :nid', array(':nid' => $node6->nid))->fetchAll();
$this->assertEqual(count($records), 0, 'Returned no records for unpublished node.');
}
}
/**
* Tests for Node Access with a non-node base table.
*/
class NodeAccessBaseTableTestCase extends DrupalWebTestCase {
protected $nodesByUser;
protected $webUser;
protected $publicTid;
protected $privateTid;
protected $nids_visible;
public static function getInfo() {
return array(
'name' => 'Node Access on any table',
'description' => 'Checks behavior of the node access subsystem if the base table is not node.',
'group' => 'Node',
);
}
public function setUp() {
parent::setUp('node_access_test');
node_access_rebuild();
variable_set('node_access_test_private', TRUE);
}
/**
* Tests the "private" node access functionality.
*
* - Create 2 users with "access content" and "create article" permissions.
* - Each user creates one private and one not private article.
* - Test that each user can view the other user's non-private article.
* - Test that each user cannot view the other user's private article.
* - Test that each user finds only appropriate (non-private + own private)
* in taxonomy listing.
* - Create another user with 'view any private content'.
* - Test that user 4 can view all content created above.
* - Test that user 4 can view all content on taxonomy listing.
*/
function testNodeAccessBasic() {
$num_simple_users = 2;
$simple_users = array();
// nodes keyed by uid and nid: $nodes[$uid][$nid] = $is_private;
$this->nodesByUser = array();
$titles = array(); // Titles keyed by nid
$private_nodes = array(); // Array of nids marked private.
for ($i = 0; $i < $num_simple_users; $i++) {
$simple_users[$i] = $this->drupalCreateUser(array('access content', 'create article content'));
}
foreach ($simple_users as $this->webUser) {
$this->drupalLogin($this->webUser);
foreach (array(0 => 'Public', 1 => 'Private') as $is_private => $type) {
$edit = array(
'title' => t('@private_public Article created by @user', array('@private_public' => $type, '@user' => $this->webUser->name)),
);
if ($is_private) {
$edit['private'] = TRUE;
$edit['body[und][0][value]'] = 'private node';
$edit['field_tags[und]'] = 'private';
}
else {
$edit['body[und][0][value]'] = 'public node';
$edit['field_tags[und]'] = 'public';
}
$this->drupalPost('node/add/article', $edit, t('Save'));
$nid = db_query('SELECT nid FROM {node} WHERE title = :title', array(':title' => $edit['title']))->fetchField();
$private_status = db_query('SELECT private FROM {node_access_test} where nid = :nid', array(':nid' => $nid))->fetchField();
$this->assertTrue($is_private == $private_status, 'The private status of the node was properly set in the node_access_test table.');
if ($is_private) {
$private_nodes[] = $nid;
}
$titles[$nid] = $edit['title'];
$this->nodesByUser[$this->webUser->uid][$nid] = $is_private;
}
}
$this->publicTid = db_query('SELECT tid FROM {taxonomy_term_data} WHERE name = :name', array(':name' => 'public'))->fetchField();
$this->privateTid = db_query('SELECT tid FROM {taxonomy_term_data} WHERE name = :name', array(':name' => 'private'))->fetchField();
$this->assertTrue($this->publicTid, 'Public tid was found');
$this->assertTrue($this->privateTid, 'Private tid was found');
foreach ($simple_users as $this->webUser) {
$this->drupalLogin($this->webUser);
// Check own nodes to see that all are readable.
foreach ($this->nodesByUser as $uid => $data) {
foreach ($data as $nid => $is_private) {
$this->drupalGet('node/' . $nid);
if ($is_private) {
$should_be_visible = $uid == $this->webUser->uid;
}
else {
$should_be_visible = TRUE;
}
$this->assertResponse($should_be_visible ? 200 : 403, strtr('A %private node by user %uid is %visible for user %current_uid.', array(
'%private' => $is_private ? 'private' : 'public',
'%uid' => $uid,
'%visible' => $should_be_visible ? 'visible' : 'not visible',
'%current_uid' => $this->webUser->uid,
)));
}
}
// Check to see that the correct nodes are shown on taxonomy/private
// and taxonomy/public.
$this->assertTaxonomyPage(FALSE);
}
// Now test that a user with 'access any private content' can view content.
$access_user = $this->drupalCreateUser(array('access content', 'create article content', 'node test view', 'search content'));
$this->drupalLogin($access_user);
foreach ($this->nodesByUser as $uid => $private_status) {
foreach ($private_status as $nid => $is_private) {
$this->drupalGet('node/' . $nid);
$this->assertResponse(200);
}
}
// This user should be able to see all of the nodes on the relevant
// taxonomy pages.
$this->assertTaxonomyPage(TRUE);
}
/**
* Checks taxonomy/term listings to ensure only accessible nodes are listed.
*
* @param $is_admin
* A boolean indicating whether the current user is an administrator. If
* TRUE, all nodes should be listed. If FALSE, only public nodes and the
* user's own private nodes should be listed.
*/
protected function assertTaxonomyPage($is_admin) {
foreach (array($this->publicTid, $this->privateTid) as $tid_is_private => $tid) {
$this->drupalGet("taxonomy/term/$tid");
$this->nids_visible = array();
foreach ($this->xpath("//a[text()='Read more']") as $link) {
$this->assertTrue(preg_match('|node/(\d+)$|', (string) $link['href'], $matches), 'Read more points to a node');
$this->nids_visible[$matches[1]] = TRUE;
}
foreach ($this->nodesByUser as $uid => $data) {
foreach ($data as $nid => $is_private) {
// Private nodes should be visible on the private term page,
// public nodes should be visible on the public term page.
$should_be_visible = $tid_is_private == $is_private;
// Non-administrators can only see their own nodes on the private
// term page.
if (!$is_admin && $tid_is_private) {
$should_be_visible = $should_be_visible && $uid == $this->webUser->uid;
}
$this->assertIdentical(isset($this->nids_visible[$nid]), $should_be_visible, strtr('A %private node by user %uid is %visible for user %current_uid on the %tid_is_private page.', array(
'%private' => $is_private ? 'private' : 'public',
'%uid' => $uid,
'%visible' => isset($this->nids_visible[$nid]) ? 'visible' : 'not visible',
'%current_uid' => $this->webUser->uid,
'%tid_is_private' => $tid_is_private ? 'private' : 'public',
)));
}
}
}
}
}
/**
* Tests node save related functionality, including import-save.
*/
class NodeSaveTestCase extends DrupalWebTestCase {
protected $web_user;
public static function getInfo() {
return array(
'name' => 'Node save',
'description' => 'Test node_save() for saving content.',
'group' => 'Node',
);
}
function setUp() {
parent::setUp('node_test');
// Create a user that is allowed to post; we'll use this to test the submission.
$web_user = $this->drupalCreateUser(array('create article content'));
$this->drupalLogin($web_user);
$this->web_user = $web_user;
}
/**
* Checks whether custom node IDs are saved properly during an import operation.
*
* Workflow:
* - first create a piece of content
* - save the content
* - check if node exists
*/
function testImport() {
// Node ID must be a number that is not in the database.
$max_nid = db_query('SELECT MAX(nid) FROM {node}')->fetchField();
$test_nid = $max_nid + mt_rand(1000, 1000000);
$title = $this->randomName(8);
$node = array(
'title' => $title,
'body' => array(LANGUAGE_NONE => array(array('value' => $this->randomName(32)))),
'uid' => $this->web_user->uid,
'type' => 'article',
'nid' => $test_nid,
'is_new' => TRUE,
);
$node = node_submit((object) $node);
// Verify that node_submit did not overwrite the user ID.
$this->assertEqual($node->uid, $this->web_user->uid, 'Function node_submit() preserves user ID');
node_save($node);
// Test the import.
$node_by_nid = node_load($test_nid);
$this->assertTrue($node_by_nid, 'Node load by node ID.');
$node_by_title = $this->drupalGetNodeByTitle($title);
$this->assertTrue($node_by_title, 'Node load by node title.');
}
/**
* Verifies accuracy of the "created" and "changed" timestamp functionality.
*/
function testTimestamps() {
// Use the default timestamps.
$edit = array(
'uid' => $this->web_user->uid,
'type' => 'article',
'title' => $this->randomName(8),
);
node_save((object) $edit);
$node = $this->drupalGetNodeByTitle($edit['title']);
$this->assertEqual($node->created, REQUEST_TIME, 'Creating a node sets default "created" timestamp.');
$this->assertEqual($node->changed, REQUEST_TIME, 'Creating a node sets default "changed" timestamp.');
// Store the timestamps.
$created = $node->created;
$changed = $node->changed;
node_save($node);
$node = $this->drupalGetNodeByTitle($edit['title'], TRUE);
$this->assertEqual($node->created, $created, 'Updating a node preserves "created" timestamp.');
// Programmatically set the timestamps using hook_node_presave.
$node->title = 'testing_node_presave';
node_save($node);
$node = $this->drupalGetNodeByTitle('testing_node_presave', TRUE);
$this->assertEqual($node->created, 280299600, 'Saving a node uses "created" timestamp set in presave hook.');
$this->assertEqual($node->changed, 979534800, 'Saving a node uses "changed" timestamp set in presave hook.');
// Programmatically set the timestamps on the node.
$edit = array(
'uid' => $this->web_user->uid,
'type' => 'article',
'title' => $this->randomName(8),
'created' => 280299600, // Sun, 19 Nov 1978 05:00:00 GMT
'changed' => 979534800, // Drupal 1.0 release.
);
node_save((object) $edit);
$node = $this->drupalGetNodeByTitle($edit['title']);
$this->assertEqual($node->created, 280299600, 'Creating a node uses user-set "created" timestamp.');
$this->assertNotEqual($node->changed, 979534800, 'Creating a node doesn\'t use user-set "changed" timestamp.');
// Update the timestamps.
$node->created = 979534800;
$node->changed = 280299600;
node_save($node);
$node = $this->drupalGetNodeByTitle($edit['title'], TRUE);
$this->assertEqual($node->created, 979534800, 'Updating a node uses user-set "created" timestamp.');
$this->assertNotEqual($node->changed, 280299600, 'Updating a node doesn\'t use user-set "changed" timestamp.');
}
/**
* Tests determing changes in hook_node_presave() and verifies the static node
* load cache is cleared upon save.
*/
function testDeterminingChanges() {
// Initial creation.
$node = (object) array(
'uid' => $this->web_user->uid,
'type' => 'article',
'title' => 'test_changes',
);
node_save($node);
// Update the node without applying changes.
node_save($node);
$this->assertEqual($node->title, 'test_changes', 'No changes have been determined.');
// Apply changes.
$node->title = 'updated';
node_save($node);
// The hook implementations node_test_node_presave() and
// node_test_node_update() determine changes and change the title.
$this->assertEqual($node->title, 'updated_presave_update', 'Changes have been determined.');
// Test the static node load cache to be cleared.
$node = node_load($node->nid);
$this->assertEqual($node->title, 'updated_presave', 'Static cache has been cleared.');
}
/**
* Tests saving a node on node insert.
*
* This test ensures that a node has been fully saved when hook_node_insert()
* is invoked, so that the node can be saved again in a hook implementation
* without errors.
*
* @see node_test_node_insert()
*/
function testNodeSaveOnInsert() {
// node_test_node_insert() triggers a save on insert if the title equals
// 'new'.
$node = $this->drupalCreateNode(array('title' => 'new'));
$this->assertEqual($node->title, 'Node ' . $node->nid, 'Node saved on node insert.');
}
}
/**
* Tests related to node types.
*/
class NodeTypeTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Node types',
'description' => 'Ensures that node type functions work correctly.',
'group' => 'Node',
);
}
/**
* Ensures that node type functions (node_type_get_*) work correctly.
*
* Load available node types and validate the returned data.
*/
function testNodeTypeGetFunctions() {
$node_types = node_type_get_types();
$node_names = node_type_get_names();
$this->assertTrue(isset($node_types['article']), 'Node type article is available.');
$this->assertTrue(isset($node_types['page']), 'Node type basic page is available.');
$this->assertEqual($node_types['article']->name, $node_names['article'], 'Correct node type base has been returned.');
$this->assertEqual($node_types['article'], node_type_get_type('article'), 'Correct node type has been returned.');
$this->assertEqual($node_types['article']->name, node_type_get_name('article'), 'Correct node type name has been returned.');
$this->assertEqual($node_types['page']->base, node_type_get_base('page'), 'Correct node type base has been returned.');
}
/**
* Tests creating a content type programmatically and via a form.
*/
function testNodeTypeCreation() {
// Create a content type programmaticaly.
$type = $this->drupalCreateContentType();
$type_exists = db_query('SELECT 1 FROM {node_type} WHERE type = :type', array(':type' => $type->type))->fetchField();
$this->assertTrue($type_exists, 'The new content type has been created in the database.');
// Login a test user.
$web_user = $this->drupalCreateUser(array('create ' . $type->name . ' content'));
$this->drupalLogin($web_user);
$this->drupalGet('node/add/' . str_replace('_', '-', $type->name));
$this->assertResponse(200, 'The new content type can be accessed at node/add.');
// Create a content type via the user interface.
$web_user = $this->drupalCreateUser(array('bypass node access', 'administer content types'));
$this->drupalLogin($web_user);
$edit = array(
'name' => 'foo',
'title_label' => 'title for foo',
'type' => 'foo',
);
$this->drupalPost('admin/structure/types/add', $edit, t('Save content type'));
$type_exists = db_query('SELECT 1 FROM {node_type} WHERE type = :type', array(':type' => 'foo'))->fetchField();
$this->assertTrue($type_exists, 'The new content type has been created in the database.');
}
/**
* Tests editing a node type using the UI.
*/
function testNodeTypeEditing() {
$web_user = $this->drupalCreateUser(array('bypass node access', 'administer content types', 'administer fields'));
$this->drupalLogin($web_user);
$instance = field_info_instance('node', 'body', 'page');
$this->assertEqual($instance['label'], 'Body', 'Body field was found.');
// Verify that title and body fields are displayed.
$this->drupalGet('node/add/page');
$this->assertRaw('Title', 'Title field was found.');
$this->assertRaw('Body', 'Body field was found.');
// Rename the title field.
$edit = array(
'title_label' => 'Foo',
);
$this->drupalPost('admin/structure/types/manage/page', $edit, t('Save content type'));
// Refresh the field information for the rest of the test.
field_info_cache_clear();
$this->drupalGet('node/add/page');
$this->assertRaw('Foo', 'New title label was displayed.');
$this->assertNoRaw('Title', 'Old title label was not displayed.');
// Change the name, machine name and description.
$edit = array(
'name' => 'Bar',
'type' => 'bar',
'description' => 'Lorem ipsum.',
);
$this->drupalPost('admin/structure/types/manage/page', $edit, t('Save content type'));
field_info_cache_clear();
$this->drupalGet('node/add');
$this->assertRaw('Bar', 'New name was displayed.');
$this->assertRaw('Lorem ipsum', 'New description was displayed.');
$this->clickLink('Bar');
$this->assertEqual(url('node/add/bar', array('absolute' => TRUE)), $this->getUrl(), 'New machine name was used in URL.');
$this->assertRaw('Foo', 'Title field was found.');
$this->assertRaw('Body', 'Body field was found.');
// Remove the body field.
$this->drupalPost('admin/structure/types/manage/bar/fields/body/delete', NULL, t('Delete'));
// Resave the settings for this type.
$this->drupalPost('admin/structure/types/manage/bar', array(), t('Save content type'));
// Check that the body field doesn't exist.
$this->drupalGet('node/add/bar');
$this->assertNoRaw('Body', 'Body field was not found.');
}
/**
* Tests that node_types_rebuild() correctly handles the 'disabled' flag.
*/
function testNodeTypeStatus() {
// Enable all core node modules, and all types should be active.
module_enable(array('blog', 'book', 'poll'), FALSE);
node_types_rebuild();
$types = node_type_get_types();
foreach (array('blog', 'book', 'poll', 'article', 'page') as $type) {
$this->assertTrue(isset($types[$type]), format_string('%type is found in node types.', array('%type' => $type)));
$this->assertTrue(isset($types[$type]->disabled) && empty($types[$type]->disabled), format_string('%type type is enabled.', array('%type' => $type)));
}
// Disable poll module and the respective type should be marked as disabled.
module_disable(array('poll'), FALSE);
node_types_rebuild();
$types = node_type_get_types();
$this->assertTrue(!empty($types['poll']->disabled), "Poll module's node type disabled.");
$this->assertTrue(isset($types['blog']) && empty($types['blog']->disabled), "Blog module's node type still active.");
// Disable blog module and the respective type should be marked as disabled.
module_disable(array('blog'), FALSE);
node_types_rebuild();
$types = node_type_get_types();
$this->assertTrue(!empty($types['blog']->disabled), "Blog module's node type disabled.");
$this->assertTrue(!empty($types['poll']->disabled), "Poll module's node type still disabled.");
// Disable book module and the respective type should still be active, since
// it is not provided by hook_node_info().
module_disable(array('book'), FALSE);
node_types_rebuild();
$types = node_type_get_types();
$this->assertTrue(isset($types['book']) && empty($types['book']->disabled), "Book module's node type still active.");
$this->assertTrue(!empty($types['blog']->disabled), "Blog module's node type still disabled.");
$this->assertTrue(!empty($types['poll']->disabled), "Poll module's node type still disabled.");
$this->assertTrue(isset($types['article']) && empty($types['article']->disabled), "Article node type still active.");
$this->assertTrue(isset($types['page']) && empty($types['page']->disabled), "Basic page node type still active.");
// Re-enable the modules and verify that the types are active again.
module_enable(array('blog', 'book', 'poll'), FALSE);
node_types_rebuild();
$types = node_type_get_types();
foreach (array('blog', 'book', 'poll', 'article', 'page') as $type) {
$this->assertTrue(isset($types[$type]), format_string('%type is found in node types.', array('%type' => $type)));
$this->assertTrue(isset($types[$type]->disabled) && empty($types[$type]->disabled), format_string('%type type is enabled.', array('%type' => $type)));
}
}
/**
* Tests deleting a content type that still has content.
*/
function testNodeTypeDeletion() {
// Create a content type programmatically.
$type = $this->drupalCreateContentType();
// Log in a test user.
$web_user = $this->drupalCreateUser(array(
'bypass node access',
'administer content types',
));
$this->drupalLogin($web_user);
// Add a new node of this type.
$node = $this->drupalCreateNode(array('type' => $type->type));
// Attempt to delete the content type, which should not be allowed.
$this->drupalGet('admin/structure/types/manage/' . $type->name . '/delete');
$this->assertRaw(
t(
'%type is used by 1 piece of content on your site. You cannot remove this content type until you have removed all of the %type content.',
array('%type' => $type->name)
),
'The content type will not be deleted until all nodes of that type are removed.'
);
$this->assertNoText(t('This action cannot be undone.'), 'The node type deletion confirmation form is not available.');
// Delete the node.
node_delete($node->nid);
// Attempt to delete the content type, which should now be allowed.
$this->drupalGet('admin/structure/types/manage/' . $type->name . '/delete');
$this->assertRaw(
t(
'Are you sure you want to delete the content type %type?',
array('%type' => $type->name)
),
'The content type is available for deletion.'
);
$this->assertText(t('This action cannot be undone.'), 'The node type deletion confirmation form is available.');
}
}
/**
* Test node type customizations persistence.
*/
class NodeTypePersistenceTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Node type persist',
'description' => 'Ensures that node type customization survives module enabling and disabling.',
'group' => 'Node',
);
}
/**
* Tests that node type customizations persist through disable and uninstall.
*/
function testNodeTypeCustomizationPersistence() {
$web_user = $this->drupalCreateUser(array('bypass node access', 'administer content types', 'administer modules'));
$this->drupalLogin($web_user);
$poll_key = 'modules[Core][poll][enable]';
$poll_enable = array($poll_key => "1");
$poll_disable = array($poll_key => FALSE);
// Enable poll and verify that the node type is in the DB and is not
// disabled.
$this->drupalPost('admin/modules', $poll_enable, t('Save configuration'));
$disabled = db_query('SELECT disabled FROM {node_type} WHERE type = :type', array(':type' => 'poll'))->fetchField();
$this->assertNotIdentical($disabled, FALSE, 'Poll node type found in the database');
$this->assertEqual($disabled, 0, 'Poll node type is not disabled');
// Check that poll node type (uncustomized) shows up.
$this->drupalGet('node/add');
$this->assertText('poll', 'poll type is found on node/add');
// Customize poll description.
$description = $this->randomName();
$edit = array('description' => $description);
$this->drupalPost('admin/structure/types/manage/poll', $edit, t('Save content type'));
// Check that poll node type customization shows up.
$this->drupalGet('node/add');
$this->assertText($description, 'Customized description found');
// Disable poll and check that the node type gets disabled.
$this->drupalPost('admin/modules', $poll_disable, t('Save configuration'));
$disabled = db_query('SELECT disabled FROM {node_type} WHERE type = :type', array(':type' => 'poll'))->fetchField();
$this->assertEqual($disabled, 1, 'Poll node type is disabled');
$this->drupalGet('node/add');
$this->assertNoText('poll', 'poll type is not found on node/add');
// Reenable poll and check that the customization survived the module
// disable.
$this->drupalPost('admin/modules', $poll_enable, t('Save configuration'));
$disabled = db_query('SELECT disabled FROM {node_type} WHERE type = :type', array(':type' => 'poll'))->fetchField();
$this->assertNotIdentical($disabled, FALSE, 'Poll node type found in the database');
$this->assertEqual($disabled, 0, 'Poll node type is not disabled');
$this->drupalGet('node/add');
$this->assertText($description, 'Customized description found');
// Disable and uninstall poll.
$this->drupalPost('admin/modules', $poll_disable, t('Save configuration'));
$edit = array('uninstall[poll]' => 'poll');
$this->drupalPost('admin/modules/uninstall', $edit, t('Uninstall'));
$this->drupalPost(NULL, array(), t('Uninstall'));
$disabled = db_query('SELECT disabled FROM {node_type} WHERE type = :type', array(':type' => 'poll'))->fetchField();
$this->assertTrue($disabled, 'Poll node type is in the database and is disabled');
$this->drupalGet('node/add');
$this->assertNoText('poll', 'poll type is no longer found on node/add');
// Reenable poll and check that the customization survived the module
// uninstall.
$this->drupalPost('admin/modules', $poll_enable, t('Save configuration'));
$this->drupalGet('node/add');
$this->assertText($description, 'Customized description is found even after uninstall and reenable.');
}
}
/**
* Verifies the rebuild functionality for the node_access table.
*/
class NodeAccessRebuildTestCase extends DrupalWebTestCase {
protected $web_user;
public static function getInfo() {
return array(
'name' => 'Node access rebuild',
'description' => 'Ensures that node access rebuild functions work correctly.',
'group' => 'Node',
);
}
function setUp() {
parent::setUp();
$web_user = $this->drupalCreateUser(array('administer site configuration', 'access administration pages', 'access site reports'));
$this->drupalLogin($web_user);
$this->web_user = $web_user;
}
/**
* Tests rebuilding the node access permissions table.
*/
function testNodeAccessRebuild() {
$this->drupalGet('admin/reports/status');
$this->clickLink(t('Rebuild permissions'));
$this->drupalPost(NULL, array(), t('Rebuild permissions'));
$this->assertText(t('Content permissions have been rebuilt.'));
}
}
/**
* Tests node administration page functionality.
*/
class NodeAdminTestCase extends DrupalWebTestCase {
protected $admin_user;
protected $base_user_1;
protected $base_user_2;
protected $base_user_3;
public static function getInfo() {
return array(
'name' => 'Node administration',
'description' => 'Test node administration page functionality.',
'group' => 'Node',
);
}
function setUp() {
parent::setUp();
// Remove the "view own unpublished content" permission which is set
// by default for authenticated users so we can test this permission
// correctly.
user_role_revoke_permissions(DRUPAL_AUTHENTICATED_RID, array('view own unpublished content'));
$this->admin_user = $this->drupalCreateUser(array('access administration pages', 'access content overview', 'administer nodes', 'bypass node access'));
$this->base_user_1 = $this->drupalCreateUser(array('access content overview'));
$this->base_user_2 = $this->drupalCreateUser(array('access content overview', 'view own unpublished content'));
$this->base_user_3 = $this->drupalCreateUser(array('access content overview', 'bypass node access'));
}
/**
* Tests that the table sorting works on the content admin pages.
*/
function testContentAdminSort() {
$this->drupalLogin($this->admin_user);
foreach (array('dd', 'aa', 'DD', 'bb', 'cc', 'CC', 'AA', 'BB') as $prefix) {
$this->drupalCreateNode(array('title' => $prefix . $this->randomName(6)));
}
// Test that the default sort by node.changed DESC actually fires properly.
$nodes_query = db_select('node', 'n')
->fields('n', array('nid'))
->orderBy('changed', 'DESC')
->execute()
->fetchCol();
$nodes_form = array();
$this->drupalGet('admin/content');
foreach ($this->xpath('//table/tbody/tr/td/div/input/@value') as $input) {
$nodes_form[] = $input;
}
$this->assertEqual($nodes_query, $nodes_form, 'Nodes are sorted in the form according to the default query.');
// Compare the rendered HTML node list to a query for the nodes ordered by
// title to account for possible database-dependent sort order.
$nodes_query = db_select('node', 'n')
->fields('n', array('nid'))
->orderBy('title')
->execute()
->fetchCol();
$nodes_form = array();
$this->drupalGet('admin/content', array('query' => array('sort' => 'asc', 'order' => 'Title')));
foreach ($this->xpath('//table/tbody/tr/td/div/input/@value') as $input) {
$nodes_form[] = $input;
}
$this->assertEqual($nodes_query, $nodes_form, 'Nodes are sorted in the form the same as they are in the query.');
}
/**
* Tests content overview with different user permissions.
*
* Taxonomy filters are tested separately.
*
* @see TaxonomyNodeFilterTestCase
*/
function testContentAdminPages() {
$this->drupalLogin($this->admin_user);
$nodes['published_page'] = $this->drupalCreateNode(array('type' => 'page'));
$nodes['published_article'] = $this->drupalCreateNode(array('type' => 'article'));
$nodes['unpublished_page_1'] = $this->drupalCreateNode(array('type' => 'page', 'uid' => $this->base_user_1->uid, 'status' => 0));
$nodes['unpublished_page_2'] = $this->drupalCreateNode(array('type' => 'page', 'uid' => $this->base_user_2->uid, 'status' => 0));
// Verify view, edit, and delete links for any content.
$this->drupalGet('admin/content');
$this->assertResponse(200);
foreach ($nodes as $node) {
$this->assertLinkByHref('node/' . $node->nid);
$this->assertLinkByHref('node/' . $node->nid . '/edit');
$this->assertLinkByHref('node/' . $node->nid . '/delete');
// Verify tableselect.
$this->assertFieldByName('nodes[' . $node->nid . ']', '', 'Tableselect found.');
}
// Verify filtering by publishing status.
$edit = array(
'status' => 'status-1',
);
$this->drupalPost(NULL, $edit, t('Filter'));
$this->assertRaw(t('where %property is %value', array('%property' => t('status'), '%value' => 'published')), 'Content list is filtered by status.');
$this->assertLinkByHref('node/' . $nodes['published_page']->nid . '/edit');
$this->assertLinkByHref('node/' . $nodes['published_article']->nid . '/edit');
$this->assertNoLinkByHref('node/' . $nodes['unpublished_page_1']->nid . '/edit');
// Verify filtering by status and content type.
$edit = array(
'type' => 'page',
);
$this->drupalPost(NULL, $edit, t('Refine'));
$this->assertRaw(t('where %property is %value', array('%property' => t('status'), '%value' => 'published')), 'Content list is filtered by status.');
$this->assertRaw(t('and where %property is %value', array('%property' => t('type'), '%value' => 'Basic page')), 'Content list is filtered by content type.');
$this->assertLinkByHref('node/' . $nodes['published_page']->nid . '/edit');
$this->assertNoLinkByHref('node/' . $nodes['published_article']->nid . '/edit');
// Verify no operation links are displayed for regular users.
$this->drupalLogout();
$this->drupalLogin($this->base_user_1);
$this->drupalGet('admin/content');
$this->assertResponse(200);
$this->assertLinkByHref('node/' . $nodes['published_page']->nid);
$this->assertLinkByHref('node/' . $nodes['published_article']->nid);
$this->assertNoLinkByHref('node/' . $nodes['published_page']->nid . '/edit');
$this->assertNoLinkByHref('node/' . $nodes['published_page']->nid . '/delete');
$this->assertNoLinkByHref('node/' . $nodes['published_article']->nid . '/edit');
$this->assertNoLinkByHref('node/' . $nodes['published_article']->nid . '/delete');
// Verify no unpublished content is displayed without permission.
$this->assertNoLinkByHref('node/' . $nodes['unpublished_page_1']->nid);
$this->assertNoLinkByHref('node/' . $nodes['unpublished_page_1']->nid . '/edit');
$this->assertNoLinkByHref('node/' . $nodes['unpublished_page_1']->nid . '/delete');
// Verify no tableselect.
$this->assertNoFieldByName('nodes[' . $nodes['published_page']->nid . ']', '', 'No tableselect found.');
// Verify unpublished content is displayed with permission.
$this->drupalLogout();
$this->drupalLogin($this->base_user_2);
$this->drupalGet('admin/content');
$this->assertResponse(200);
$this->assertLinkByHref('node/' . $nodes['unpublished_page_2']->nid);
// Verify no operation links are displayed.
$this->assertNoLinkByHref('node/' . $nodes['unpublished_page_2']->nid . '/edit');
$this->assertNoLinkByHref('node/' . $nodes['unpublished_page_2']->nid . '/delete');
// Verify user cannot see unpublished content of other users.
$this->assertNoLinkByHref('node/' . $nodes['unpublished_page_1']->nid);
$this->assertNoLinkByHref('node/' . $nodes['unpublished_page_1']->nid . '/edit');
$this->assertNoLinkByHref('node/' . $nodes['unpublished_page_1']->nid . '/delete');
// Verify no tableselect.
$this->assertNoFieldByName('nodes[' . $nodes['unpublished_page_2']->nid . ']', '', 'No tableselect found.');
// Verify node access can be bypassed.
$this->drupalLogout();
$this->drupalLogin($this->base_user_3);
$this->drupalGet('admin/content');
$this->assertResponse(200);
foreach ($nodes as $node) {
$this->assertLinkByHref('node/' . $node->nid);
$this->assertLinkByHref('node/' . $node->nid . '/edit');
$this->assertLinkByHref('node/' . $node->nid . '/delete');
}
}
}
/**
* Tests node title functionality.
*/
class NodeTitleTestCase extends DrupalWebTestCase {
/**
* A user with permission to create and edit content and to administer nodes.
*
* @var object
*/
protected $admin_user;
public static function getInfo() {
return array(
'name' => 'Node title',
'description' => 'Test node title.',
'group' => 'Node'
);
}
function setUp() {
parent::setUp();
$this->admin_user = $this->drupalCreateUser(array('administer nodes', 'create article content', 'create page content'));
$this->drupalLogin($this->admin_user);
}
/**
* Creates one node and tests if the node title has the correct value.
*/
function testNodeTitle() {
// Create "Basic page" content with title.
// Add the node to the frontpage so we can test if teaser links are clickable.
$settings = array(
'title' => $this->randomName(8),
'promote' => 1,
);
$node = $this->drupalCreateNode($settings);
// Test <title> tag.
$this->drupalGet("node/$node->nid");
$xpath = '//title';
$this->assertEqual(current($this->xpath($xpath)), $node->title .' | Drupal', 'Page title is equal to node title.', 'Node');
// Test breadcrumb in comment preview.
$this->drupalGet("comment/reply/$node->nid");
$xpath = '//div[@class="breadcrumb"]/a[last()]';
$this->assertEqual(current($this->xpath($xpath)), $node->title, 'Node breadcrumb is equal to node title.', 'Node');
// Test node title in comment preview.
$this->assertEqual(current($this->xpath('//div[@id=:id]/h2/a', array(':id' => 'node-' . $node->nid))), $node->title, 'Node preview title is equal to node title.', 'Node');
// Test node title is clickable on teaser list (/node).
$this->drupalGet('node');
$this->clickLink($node->title);
}
}
/**
* Test the node_feed() functionality.
*/
class NodeFeedTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Node feed',
'description' => 'Ensures that node_feed() functions correctly.',
'group' => 'Node',
);
}
/**
* Ensures that node_feed() accepts and prints extra channel elements.
*/
function testNodeFeedExtraChannelElements() {
ob_start();
node_feed(array(), array('copyright' => 'Drupal is a registered trademark of Dries Buytaert.'));
$output = ob_get_clean();
$this->assertTrue(strpos($output, '<copyright>Drupal is a registered trademark of Dries Buytaert.</copyright>') !== FALSE);
}
}
/**
* Functional tests for the node module blocks.
*/
class NodeBlockFunctionalTest extends DrupalWebTestCase {
protected $admin_user;
protected $web_user;
public static function getInfo() {
return array(
'name' => 'Node blocks',
'description' => 'Test node block functionality.',
'group' => 'Node',
);
}
function setUp() {
parent::setUp('node', 'block');
// Create users and test node.
$this->admin_user = $this->drupalCreateUser(array('administer content types', 'administer nodes', 'administer blocks'));
$this->web_user = $this->drupalCreateUser(array('access content', 'create article content'));
}
/**
* Tests the recent comments block.
*/
function testRecentNodeBlock() {
$this->drupalLogin($this->admin_user);
// Disallow anonymous users to view content.
user_role_change_permissions(DRUPAL_ANONYMOUS_RID, array(
'access content' => FALSE,
));
// Set the block to a region to confirm block is available.
$edit = array(
'blocks[node_recent][region]' => 'sidebar_first',
);
$this->drupalPost('admin/structure/block', $edit, t('Save blocks'));
$this->assertText(t('The block settings have been updated.'), 'Block saved to first sidebar region.');
// Set block title and variables.
$block = array(
'title' => $this->randomName(),
'node_recent_block_count' => 2,
);
$this->drupalPost('admin/structure/block/manage/node/recent/configure', $block, t('Save block'));
$this->assertText(t('The block configuration has been saved.'), 'Block saved.');
// Test that block is not visible without nodes
$this->drupalGet('');
$this->assertText(t('No content available.'), 'Block with "No content available." found.');
// Add some test nodes.
$default_settings = array('uid' => $this->web_user->uid, 'type' => 'article');
$node1 = $this->drupalCreateNode($default_settings);
$node2 = $this->drupalCreateNode($default_settings);
$node3 = $this->drupalCreateNode($default_settings);
// Change the changed time for node so that we can test ordering.
db_update('node')
->fields(array(
'changed' => $node1->changed + 100,
))
->condition('nid', $node2->nid)
->execute();
db_update('node')
->fields(array(
'changed' => $node1->changed + 200,
))
->condition('nid', $node3->nid)
->execute();
// Test that a user without the 'access content' permission cannot
// see the block.
$this->drupalLogout();
$this->drupalGet('');
$this->assertNoText($block['title'], 'Block was not found.');
// Test that only the 2 latest nodes are shown.
$this->drupalLogin($this->web_user);
$this->assertNoText($node1->title, 'Node not found in block.');
$this->assertText($node2->title, 'Node found in block.');
$this->assertText($node3->title, 'Node found in block.');
// Check to make sure nodes are in the right order.
$this->assertTrue($this->xpath('//div[@id="block-node-recent"]/div/table/tbody/tr[position() = 1]/td/div/a[text() = "' . $node3->title . '"]'), 'Nodes were ordered correctly in block.');
// Set the number of recent nodes to show to 10.
$this->drupalLogout();
$this->drupalLogin($this->admin_user);
$block = array(
'node_recent_block_count' => 10,
);
$this->drupalPost('admin/structure/block/manage/node/recent/configure', $block, t('Save block'));
$this->assertText(t('The block configuration has been saved.'), 'Block saved.');
// Post an additional node.
$node4 = $this->drupalCreateNode($default_settings);
// Test that all four nodes are shown.
$this->drupalGet('');
$this->assertText($node1->title, 'Node found in block.');
$this->assertText($node2->title, 'Node found in block.');
$this->assertText($node3->title, 'Node found in block.');
$this->assertText($node4->title, 'Node found in block.');
// Create the custom block.
$custom_block = array();
$custom_block['info'] = $this->randomName();
$custom_block['title'] = $this->randomName();
$custom_block['types[article]'] = TRUE;
$custom_block['body[value]'] = $this->randomName(32);
$custom_block['regions[' . variable_get('theme_default', 'bartik') . ']'] = 'content';
if ($admin_theme = variable_get('admin_theme')) {
$custom_block['regions[' . $admin_theme . ']'] = 'content';
}
$this->drupalPost('admin/structure/block/add', $custom_block, t('Save block'));
$bid = db_query("SELECT bid FROM {block_custom} WHERE info = :info", array(':info' => $custom_block['info']))->fetchField();
$this->assertTrue($bid, 'Custom block with visibility rule was created.');
// Verify visibility rules.
$this->drupalGet('');
$this->assertNoText($custom_block['title'], 'Block was displayed on the front page.');
$this->drupalGet('node/add/article');
$this->assertText($custom_block['title'], 'Block was displayed on the node/add/article page.');
$this->drupalGet('node/' . $node1->nid);
$this->assertText($custom_block['title'], 'Block was displayed on the node/N.');
// Delete the created custom block & verify that it's been deleted.
$this->drupalPost('admin/structure/block/manage/block/' . $bid . '/delete', array(), t('Delete'));
$bid = db_query("SELECT 1 FROM {block_node_type} WHERE module = 'block' AND delta = :delta", array(':delta' => $bid))->fetchField();
$this->assertFalse($bid, 'Custom block was deleted.');
}
}
/**
* Tests basic options of multi-step node forms.
*/
class MultiStepNodeFormBasicOptionsTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Multistep node form basic options',
'description' => 'Test the persistence of basic options through multiple steps.',
'group' => 'Node',
);
}
function setUp() {
parent::setUp('poll');
$web_user = $this->drupalCreateUser(array('administer nodes', 'create poll content'));
$this->drupalLogin($web_user);
}
/**
* Tests changing the default values of basic options to ensure they persist.
*/
function testMultiStepNodeFormBasicOptions() {
$edit = array(
'title' => 'a',
'status' => FALSE,
'promote' => FALSE,
'sticky' => 1,
'choice[new:0][chtext]' => 'a',
'choice[new:1][chtext]' => 'a',
);
$this->drupalPost('node/add/poll', $edit, t('More choices'));
$this->assertNoFieldChecked('edit-status', 'status stayed unchecked');
$this->assertNoFieldChecked('edit-promote', 'promote stayed unchecked');
$this->assertFieldChecked('edit-sticky', 'sticky stayed checked');
}
}
/**
* Test to ensure that a node's content is always rebuilt.
*/
class NodeBuildContent extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Rebuild content',
'description' => 'Test the rebuilding of content for different build modes.',
'group' => 'Node',
);
}
/**
* Ensures that content array is rebuilt on every call to node_build_content().
*/
function testNodeRebuildContent() {
$node = $this->drupalCreateNode();
// Set a property in the content array so we can test for its existence later on.
$node->content['test_content_property'] = array('#value' => $this->randomString());
$content = node_build_content($node);
// If the property doesn't exist it means the node->content was rebuilt.
$this->assertFalse(isset($content['test_content_property']), 'Node content was emptied prior to being built.');
}
}
/**
* Tests node_query_node_access_alter().
*/
class NodeQueryAlter extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Node query alter',
'description' => 'Test that node access queries are properly altered by the node module.',
'group' => 'Node',
);
}
/**
* User with permission to view content.
*
* @var object
*/
protected $accessUser;
/**
* User without permission to view content.
*
* @var object
*/
protected $noAccessUser;
/**
* User without permission to view content.
*
* @var object
*/
protected $noAccessUser2;
function setUp() {
parent::setUp('node_access_test');
node_access_rebuild();
// Create some content.
$this->drupalCreateNode();
$this->drupalCreateNode();
$this->drupalCreateNode();
$this->drupalCreateNode();
// Create user with simple node access permission. The 'node test view'
// permission is implemented and granted by the node_access_test module.
$this->accessUser = $this->drupalCreateUser(array('access content overview', 'access content', 'node test view'));
$this->noAccessUser = $this->drupalCreateUser(array('access content overview', 'access content'));
$this->noAccessUser2 = $this->drupalCreateUser(array('access content overview', 'access content'));
}
/**
* Tests that node access permissions are followed.
*/
function testNodeQueryAlterWithUI() {
// Verify that a user with access permission can see at least one node.
$this->drupalLogin($this->accessUser);
$this->drupalGet('node_access_test_page');
$this->assertText('Yes, 4 nodes', "4 nodes were found for access user");
$this->assertNoText('Exception', "No database exception");
// Test the content overview page.
$this->drupalGet('admin/content');
$table_rows = $this->xpath('//tbody/tr');
$this->assertEqual(4, count($table_rows), "4 nodes were found for access user");
// Verify that a user with no access permission cannot see nodes.
$this->drupalLogin($this->noAccessUser);
$this->drupalGet('node_access_test_page');
$this->assertText('No nodes', "No nodes were found for no access user");
$this->assertNoText('Exception', "No database exception");
$this->drupalGet('admin/content');
$this->assertText(t('No content available.'));
}
/**
* Tests 'node_access' query alter, for user with access.
*
* Verifies that a non-standard table alias can be used, and that a user with
* node access can view the nodes.
*/
function testNodeQueryAlterLowLevelWithAccess() {
// User with access should be able to view 4 nodes.
try {
$query = db_select('node', 'mytab')
->fields('mytab');
$query->addTag('node_access');
$query->addMetaData('op', 'view');
$query->addMetaData('account', $this->accessUser);
$result = $query->execute()->fetchAll();
$this->assertEqual(count($result), 4, 'User with access can see correct nodes');
}
catch (Exception $e) {
$this->fail(t('Altered query is malformed'));
}
}
/**
* Tests 'node_access' query alter, for user without access.
*
* Verifies that a non-standard table alias can be used, and that a user
* without node access cannot view the nodes.
*/
function testNodeQueryAlterLowLevelNoAccess() {
// User without access should be able to view 0 nodes.
try {
$query = db_select('node', 'mytab')
->fields('mytab');
$query->addTag('node_access');
$query->addMetaData('op', 'view');
$query->addMetaData('account', $this->noAccessUser);
$result = $query->execute()->fetchAll();
$this->assertEqual(count($result), 0, 'User with no access cannot see nodes');
}
catch (Exception $e) {
$this->fail(t('Altered query is malformed'));
}
}
/**
* Tests 'node_access' query alter, for edit access.
*
* Verifies that a non-standard table alias can be used, and that a user with
* view-only node access cannot edit the nodes.
*/
function testNodeQueryAlterLowLevelEditAccess() {
// User with view-only access should not be able to edit nodes.
try {
$query = db_select('node', 'mytab')
->fields('mytab');
$query->addTag('node_access');
$query->addMetaData('op', 'update');
$query->addMetaData('account', $this->accessUser);
$result = $query->execute()->fetchAll();
$this->assertEqual(count($result), 0, 'User with view-only access cannot edit nodes');
}
catch (Exception $e) {
$this->fail($e->getMessage());
$this->fail((string) $query);
$this->fail(t('Altered query is malformed'));
}
}
/**
* Tests 'node_access' query alter override.
*
* Verifies that node_access_view_all_nodes() is called from
* node_query_node_access_alter(). We do this by checking that a user who
* normally would not have view privileges is able to view the nodes when we
* add a record to {node_access} paired with a corresponding privilege in
* hook_node_grants().
*/
function testNodeQueryAlterOverride() {
$record = array(
'nid' => 0,
'gid' => 0,
'realm' => 'node_access_all',
'grant_view' => 1,
'grant_update' => 0,
'grant_delete' => 0,
);
drupal_write_record('node_access', $record);
// Test that the noAccessUser still doesn't have the 'view'
// privilege after adding the node_access record.
drupal_static_reset('node_access_view_all_nodes');
try {
$query = db_select('node', 'mytab')
->fields('mytab');
$query->addTag('node_access');
$query->addMetaData('op', 'view');
$query->addMetaData('account', $this->noAccessUser);
$result = $query->execute()->fetchAll();
$this->assertEqual(count($result), 0, 'User view privileges are not overridden');
}
catch (Exception $e) {
$this->fail(t('Altered query is malformed'));
}
// Have node_test_node_grants return a node_access_all privilege,
// to grant the noAccessUser 'view' access. To verify that
// node_access_view_all_nodes is properly checking the specified
// $account instead of the global $user, we will log in as
// noAccessUser2.
$this->drupalLogin($this->noAccessUser2);
variable_set('node_test_node_access_all_uid', $this->noAccessUser->uid);
drupal_static_reset('node_access_view_all_nodes');
try {
$query = db_select('node', 'mytab')
->fields('mytab');
$query->addTag('node_access');
$query->addMetaData('op', 'view');
$query->addMetaData('account', $this->noAccessUser);
$result = $query->execute()->fetchAll();
$this->assertEqual(count($result), 4, 'User view privileges are overridden');
}
catch (Exception $e) {
$this->fail(t('Altered query is malformed'));
}
variable_del('node_test_node_access_all_uid');
}
}
/**
* Tests node_query_entity_field_access_alter().
*/
class NodeEntityFieldQueryAlter extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Node entity query alter',
'description' => 'Test that node access entity queries are properly altered by the node module.',
'group' => 'Node',
);
}
/**
* User with permission to view content.
*
* @var object
*/
protected $accessUser;
/**
* User without permission to view content.
*
* @var object
*/
protected $noAccessUser;
function setUp() {
parent::setUp('node_access_test');
node_access_rebuild();
// Creating 4 nodes with an entity field so we can test that sort of query
// alter. All field values starts with 'A' so we can identify and fetch them
// in the node_access_test module.
$settings = array('language' => LANGUAGE_NONE);
for ($i = 0; $i < 4; $i++) {
$body = array(
'value' => 'A' . $this->randomName(32),
'format' => filter_default_format(),
);
$settings['body'][LANGUAGE_NONE][0] = $body;
$this->drupalCreateNode($settings);
}
// Create user with simple node access permission. The 'node test view'
// permission is implemented and granted by the node_access_test module.
$this->accessUser = $this->drupalCreateUser(array('access content', 'node test view'));
$this->noAccessUser = $this->drupalCreateUser(array('access content'));
}
/**
* Tests that node access permissions are followed.
*/
function testNodeQueryAlterWithUI() {
// Verify that a user with access permission can see at least one node.
$this->drupalLogin($this->accessUser);
$this->drupalGet('node_access_entity_test_page');
$this->assertText('Yes, 4 nodes', "4 nodes were found for access user");
$this->assertNoText('Exception', "No database exception");
// Verify that a user with no access permission cannot see nodes.
$this->drupalLogin($this->noAccessUser);
$this->drupalGet('node_access_entity_test_page');
$this->assertText('No nodes', "No nodes were found for no access user");
$this->assertNoText('Exception', "No database exception");
}
}
/**
* Test node token replacement in strings.
*/
class NodeTokenReplaceTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Node token replacement',
'description' => 'Generates text using placeholders for dummy content to check node token replacement.',
'group' => 'Node',
);
}
/**
* Creates a node, then tests the tokens generated from it.
*/
function testNodeTokenReplacement() {
global $language;
$url_options = array(
'absolute' => TRUE,
'language' => $language,
);
// Create a user and a node.
$account = $this->drupalCreateUser();
$settings = array(
'type' => 'article',
'uid' => $account->uid,
'title' => '<blink>Blinking Text</blink>',
'body' => array(LANGUAGE_NONE => array(array('value' => $this->randomName(32), 'summary' => $this->randomName(16)))),
);
$node = $this->drupalCreateNode($settings);
// Load node so that the body and summary fields are structured properly.
$node = node_load($node->nid);
$instance = field_info_instance('node', 'body', $node->type);
// Generate and test sanitized tokens.
$tests = array();
$langcode = entity_language('node', $node);
$tests['[node:nid]'] = $node->nid;
$tests['[node:vid]'] = $node->vid;
$tests['[node:tnid]'] = $node->tnid;
$tests['[node:type]'] = 'article';
$tests['[node:type-name]'] = 'Article';
$tests['[node:title]'] = check_plain($node->title);
$tests['[node:body]'] = _text_sanitize($instance, $langcode, $node->body[$langcode][0], 'value');
$tests['[node:summary]'] = _text_sanitize($instance, $langcode, $node->body[$langcode][0], 'summary');
$tests['[node:language]'] = check_plain($langcode);
$tests['[node:url]'] = url('node/' . $node->nid, $url_options);
$tests['[node:edit-url]'] = url('node/' . $node->nid . '/edit', $url_options);
$tests['[node:author]'] = check_plain(format_username($account));
$tests['[node:author:uid]'] = $node->uid;
$tests['[node:author:name]'] = check_plain(format_username($account));
$tests['[node:created:since]'] = format_interval(REQUEST_TIME - $node->created, 2, $language->language);
$tests['[node:changed:since]'] = format_interval(REQUEST_TIME - $node->changed, 2, $language->language);
// Test to make sure that we generated something for each token.
$this->assertFalse(in_array(0, array_map('strlen', $tests)), 'No empty tokens generated.');
foreach ($tests as $input => $expected) {
$output = token_replace($input, array('node' => $node), array('language' => $language));
$this->assertEqual($output, $expected, format_string('Sanitized node token %token replaced.', array('%token' => $input)));
}
// Test if the node without nid gets correct tokens (e.g. unsaved node).
$new_node_without_nid = clone $node;
unset($new_node_without_nid->nid);
// Update tokens values which should be empty
$tests['[node:nid]'] = '';
$tests['[node:url]'] = '';
$tests['[node:edit-url]'] = '';
// Generate and test sanitized tokens.
foreach ($tests as $input => $expected) {
$output = token_replace($input, array('node' => $new_node_without_nid), array('language' => $language));
$this->assertEqual($output, $expected, format_string('Sanitized node token %token replaced.', array('%token' => $input)));
}
// Revert tokens values
$tests['[node:nid]'] = $node->nid;
$tests['[node:url]'] = url('node/' . $node->nid, $url_options);
$tests['[node:edit-url]'] = url('node/' . $node->nid . '/edit', $url_options);
// Generate and test unsanitized tokens.
$tests['[node:title]'] = $node->title;
$tests['[node:body]'] = $node->body[$langcode][0]['value'];
$tests['[node:summary]'] = $node->body[$langcode][0]['summary'];
$tests['[node:language]'] = $langcode;
$tests['[node:author:name]'] = format_username($account);
foreach ($tests as $input => $expected) {
$output = token_replace($input, array('node' => $node), array('language' => $language, 'sanitize' => FALSE));
$this->assertEqual($output, $expected, format_string('Unsanitized node token %token replaced.', array('%token' => $input)));
}
// Repeat for a node without a summary.
$settings['body'] = array(LANGUAGE_NONE => array(array('value' => $this->randomName(32), 'summary' => '')));
$node = $this->drupalCreateNode($settings);
// Load node (without summary) so that the body and summary fields are
// structured properly.
$node = node_load($node->nid);
$instance = field_info_instance('node', 'body', $node->type);
// Generate and test sanitized token - use full body as expected value.
$tests = array();
$tests['[node:summary]'] = _text_sanitize($instance, $langcode, $node->body[$langcode][0], 'value');
// Test to make sure that we generated something for each token.
$this->assertFalse(in_array(0, array_map('strlen', $tests)), 'No empty tokens generated for node without a summary.');
foreach ($tests as $input => $expected) {
$output = token_replace($input, array('node' => $node), array('language' => $language));
$this->assertEqual($output, $expected, format_string('Sanitized node token %token replaced for node without a summary.', array('%token' => $input)));
}
// Generate and test unsanitized tokens.
$tests['[node:summary]'] = $node->body[$langcode][0]['value'];
foreach ($tests as $input => $expected) {
$output = token_replace($input, array('node' => $node), array('language' => $language, 'sanitize' => FALSE));
$this->assertEqual($output, $expected, format_string('Unsanitized node token %token replaced for node without a summary.', array('%token' => $input)));
}
}
}
/**
* Tests user permissions for node revisions.
*/
class NodeRevisionPermissionsTestCase extends DrupalWebTestCase {
/**
* Nodes used by the test.
*
* @var array
*/
protected $node_revisions = array();
/**
* Users with different revision permission used by the test.
*
* @var array
*/
protected $accounts = array();
/**
* Map revision permission names to node revision access ops.
*
* @var array
*/
protected $map = array(
'view' => 'view revisions',
'update' => 'revert revisions',
'delete' => 'delete revisions',
);
public static function getInfo() {
return array(
'name' => 'Node revision permissions',
'description' => 'Tests user permissions for node revision operations.',
'group' => 'Node',
);
}
function setUp() {
parent::setUp();
// Create a node with several revisions.
$node = $this->drupalCreateNode();
$this->node_revisions[] = $node;
for ($i = 0; $i < 3; $i++) {
// Create a revision for the same nid and settings with a random log.
$revision = clone $node;
$revision->revision = 1;
$revision->log = $this->randomName(32);
node_save($revision);
$this->node_revisions[] = $revision;
}
// Create three users, one with each revision permission.
foreach ($this->map as $op => $permission) {
// Create the user.
$account = $this->drupalCreateUser(
array(
'access content',
'edit any page content',
'delete any page content',
$permission,
)
);
$account->op = $op;
$this->accounts[] = $account;
}
// Create an admin account (returns TRUE for all revision permissions).
$admin_account = $this->drupalCreateUser(array('access content', 'administer nodes'));
$admin_account->is_admin = TRUE;
$this->accounts['admin'] = $admin_account;
// Create a normal account (returns FALSE for all revision permissions).
$normal_account = $this->drupalCreateUser();
$normal_account->op = FALSE;
$this->accounts[] = $normal_account;
}
/**
* Tests the _node_revision_access() function.
*/
function testNodeRevisionAccess() {
$revision = $this->node_revisions[1];
$parameters = array(
'op' => array_keys($this->map),
'account' => $this->accounts,
);
$permutations = $this->generatePermutations($parameters);
foreach ($permutations as $case) {
if (!empty($case['account']->is_admin) || $case['op'] == $case['account']->op) {
$this->assertTrue(_node_revision_access($revision, $case['op'], $case['account']), "{$this->map[$case['op']]} granted.");
}
else {
$this->assertFalse(_node_revision_access($revision, $case['op'], $case['account']), "{$this->map[$case['op']]} not granted.");
}
}
// Test that access is FALSE for a node administrator with an invalid $node
// or $op parameters.
$admin_account = $this->accounts['admin'];
$this->assertFalse(_node_revision_access(FALSE, 'view', $admin_account), '_node_revision_access() returns FALSE with an invalid node.');
$this->assertFalse(_node_revision_access($revision, 'invalid-op', $admin_account), '_node_revision_access() returns FALSE with an invalid op.');
// Test that the $account parameter defaults to the "logged in" user.
$original_user = $GLOBALS['user'];
$GLOBALS['user'] = $admin_account;
$this->assertTrue(_node_revision_access($revision, 'view'), '_node_revision_access() returns TRUE when used with global user.');
$GLOBALS['user'] = $original_user;
}
}
/**
* Tests pagination with a node access module enabled.
*/
class NodeAccessPagerTestCase extends DrupalWebTestCase {
protected $web_user;
public static function getInfo() {
return array(
'name' => 'Node access pagination',
'description' => 'Test access controlled node views have the right amount of comment pages.',
'group' => 'Node',
);
}
public function setUp() {
parent::setUp('node_access_test', 'comment', 'forum');
node_access_rebuild();
$this->web_user = $this->drupalCreateUser(array('access content', 'access comments', 'node test view'));
}
/**
* Tests the comment pager for nodes with multiple grants per realm.
*/
public function testCommentPager() {
// Create a node.
$node = $this->drupalCreateNode();
// Create 60 comments.
for ($i = 0; $i < 60; $i++) {
$comment = new stdClass();
$comment->cid = 0;
$comment->pid = 0;
$comment->uid = $this->web_user->uid;
$comment->nid = $node->nid;
$comment->subject = $this->randomName();
$comment->comment_body = array(
LANGUAGE_NONE => array(
array('value' => $this->randomName()),
),
);
comment_save($comment);
}
$this->drupalLogin($this->web_user);
// View the node page. With the default 50 comments per page there should
// be two pages (0, 1) but no third (2) page.
$this->drupalGet('node/' . $node->nid);
$this->assertText($node->title);
$this->assertText(t('Comments'));
$this->assertRaw('page=1');
$this->assertNoRaw('page=2');
}
/**
* Tests the forum node pager for nodes with multiple grants per realm.
*/
public function testForumPager() {
// Look up the forums vocabulary ID.
$vid = variable_get('forum_nav_vocabulary', 0);
$this->assertTrue($vid, 'Forum navigation vocabulary ID is set.');
// Look up the general discussion term.
$tree = taxonomy_get_tree($vid, 0, 1);
$tid = reset($tree)->tid;
$this->assertTrue($tid, 'General discussion term is found in the forum vocabulary.');
// Create 30 nodes.
for ($i = 0; $i < 30; $i++) {
$this->drupalCreateNode(array(
'nid' => NULL,
'type' => 'forum',
'taxonomy_forums' => array(
LANGUAGE_NONE => array(
array('tid' => $tid, 'vid' => $vid, 'vocabulary_machine_name' => 'forums'),
),
),
));
}
// View the general discussion forum page. With the default 25 nodes per
// page there should be two pages for 30 nodes, no more.
$this->drupalLogin($this->web_user);
$this->drupalGet('forum/' . $tid);
$this->assertRaw('page=1');
$this->assertNoRaw('page=2');
}
}
/**
* Tests the interaction of the node access system with fields.
*/
class NodeAccessFieldTestCase extends NodeWebTestCase {
protected $field;
protected $field_name;
protected $instance;
protected $admin_user;
protected $content_admin_user;
public static function getInfo() {
return array(
'name' => 'Node access and fields',
'description' => 'Tests the interaction of the node access system with fields.',
'group' => 'Node',
);
}
public function setUp() {
parent::setUp('node_access_test', 'field_ui');
node_access_rebuild();
// Create some users.
$this->admin_user = $this->drupalCreateUser(array('access content', 'bypass node access', 'administer fields'));
$this->content_admin_user = $this->drupalCreateUser(array('access content', 'administer content types', 'administer fields'));
// Add a custom field to the page content type.
$this->field_name = drupal_strtolower($this->randomName() . '_field_name');
$this->field = field_create_field(array('field_name' => $this->field_name, 'type' => 'text'));
$this->instance = field_create_instance(array(
'field_name' => $this->field_name,
'entity_type' => 'node',
'bundle' => 'page',
));
}
/**
* Tests administering fields when node access is restricted.
*/
function testNodeAccessAdministerField() {
// Create a page node.
$langcode = LANGUAGE_NONE;
$field_data = array();
$value = $field_data[$langcode][0]['value'] = $this->randomName();
$node = $this->drupalCreateNode(array($this->field_name => $field_data));
// Log in as the administrator and confirm that the field value is present.
$this->drupalLogin($this->admin_user);
$this->drupalGet("node/{$node->nid}");
$this->assertText($value, 'The saved field value is visible to an administrator.');
// Log in as the content admin and try to view the node.
$this->drupalLogin($this->content_admin_user);
$this->drupalGet("node/{$node->nid}");
$this->assertText('Access denied', 'Access is denied for the content admin.');
// Modify the field default as the content admin.
$edit = array();
$default = 'Sometimes words have two meanings';
$edit["{$this->field_name}[$langcode][0][value]"] = $default;
$this->drupalPost(
"admin/structure/types/manage/page/fields/{$this->field_name}",
$edit,
t('Save settings')
);
// Log in as the administrator.
$this->drupalLogin($this->admin_user);
// Confirm that the existing node still has the correct field value.
$this->drupalGet("node/{$node->nid}");
$this->assertText($value, 'The original field value is visible to an administrator.');
// Confirm that the new default value appears when creating a new node.
$this->drupalGet('node/add/page');
$this->assertRaw($default, 'The updated default value is displayed when creating a new node.');
}
}
/**
* Tests changing view modes for nodes.
*/
class NodeEntityViewModeAlterTest extends NodeWebTestCase {
public static function getInfo() {
return array(
'name' => 'Node entity view mode',
'description' => 'Test changing view mode.',
'group' => 'Node'
);
}
function setUp() {
parent::setUp(array('node_test'));
}
/**
* Create a "Basic page" node and verify its consistency in the database.
*/
function testNodeViewModeChange() {
$web_user = $this->drupalCreateUser(array('create page content', 'edit own page content'));
$this->drupalLogin($web_user);
// Create a node.
$edit = array();
$langcode = LANGUAGE_NONE;
$edit["title"] = $this->randomName(8);
$edit["body[$langcode][0][value]"] = 'Data that should appear only in the body for the node.';
$edit["body[$langcode][0][summary]"] = 'Extra data that should appear only in the teaser for the node.';
$this->drupalPost('node/add/page', $edit, t('Save'));
$node = $this->drupalGetNodeByTitle($edit["title"]);
// Set the flag to alter the view mode and view the node.
variable_set('node_test_change_view_mode', 'teaser');
$this->drupalGet('node/' . $node->nid);
// Check that teaser mode is viewed.
$this->assertText('Extra data that should appear only in the teaser for the node.', 'Teaser text present');
// Make sure body text is not present.
$this->assertNoText('Data that should appear only in the body for the node.', 'Body text not present');
// Test that the correct build mode has been set.
$build = node_view($node);
$this->assertEqual($build['#view_mode'], 'teaser', 'The view mode has correctly been set to teaser.');
}
/**
* Tests fields that were previously hidden when the view mode is changed.
*/
function testNodeViewModeChangeHiddenField() {
// Hide the tags field on the default display
$instance = field_info_instance('node', 'field_tags', 'article');
$instance['display']['default']['type'] = 'hidden';
field_update_instance($instance);
$web_user = $this->drupalCreateUser(array('create article content', 'edit own article content'));
$this->drupalLogin($web_user);
// Create a node.
$edit = array();
$langcode = LANGUAGE_NONE;
$edit["title"] = $this->randomName(8);
$edit["body[$langcode][0][value]"] = 'Data that should appear only in the body for the node.';
$edit["body[$langcode][0][summary]"] = 'Extra data that should appear only in the teaser for the node.';
$edit["field_tags[$langcode]"] = 'Extra tag';
$this->drupalPost('node/add/article', $edit, t('Save'));
$node = $this->drupalGetNodeByTitle($edit["title"]);
// Set the flag to alter the view mode and view the node.
variable_set('node_test_change_view_mode', 'teaser');
$this->drupalGet('node/' . $node->nid);
// Check that teaser mode is viewed.
$this->assertText('Extra data that should appear only in the teaser for the node.', 'Teaser text present');
// Make sure body text is not present.
$this->assertNoText('Data that should appear only in the body for the node.', 'Body text not present');
// Make sure tags are present.
$this->assertText('Extra tag', 'Taxonomy term present');
// Test that the correct build mode has been set.
$build = node_view($node);
$this->assertEqual($build['#view_mode'], 'teaser', 'The view mode has correctly been set to teaser.');
}
}
/**
* Tests the cache invalidation of node operations.
*/
class NodePageCacheTest extends NodeWebTestCase {
/**
* An admin user with administrative permissions for nodes.
*/
protected $admin_user;
public static function getInfo() {
return array(
'name' => 'Node page cache test',
'description' => 'Test cache invalidation of node operations.',
'group' => 'Node',
);
}
function setUp() {
parent::setUp();
variable_set('cache', 1);
variable_set('page_cache_maximum_age', 300);
$this->admin_user = $this->drupalCreateUser(array(
'bypass node access',
'access content overview',
'administer nodes',
));
}
/**
* Tests deleting nodes clears page cache.
*/
public function testNodeDelete() {
$node_path = 'node/' . $this->drupalCreateNode()->nid;
// Populate page cache.
$this->drupalGet($node_path);
// Login and delete the node.
$this->drupalLogin($this->admin_user);
$this->drupalPost($node_path . '/delete', array(), t('Delete'));
// Logout and check the node is not available.
$this->drupalLogout();
$this->drupalGet($node_path);
$this->assertResponse(404);
// Create two new nodes.
$nodes[0] = $this->drupalCreateNode();
$nodes[1] = $this->drupalCreateNode();
$node_path = 'node/' . $nodes[0]->nid;
// Populate page cache.
$this->drupalGet($node_path);
// Login and delete the nodes.
$this->drupalLogin($this->admin_user);
$this->drupalGet('admin/content');
$edit = array(
'operation' => 'delete',
'nodes[' . $nodes[0]->nid . ']' => TRUE,
'nodes[' . $nodes[1]->nid . ']' => TRUE,
);
$this->drupalPost(NULL, $edit, t('Update'));
$this->drupalPost(NULL, array(), t('Delete'));
// Logout and check the node is not available.
$this->drupalLogout();
$this->drupalGet($node_path);
$this->assertResponse(404);
}
}
/**
* Tests that multi-byte UTF-8 characters are stored and retrieved correctly.
*/
class NodeMultiByteUtf8Test extends NodeWebTestCase {
public static function getInfo() {
return array(
'name' => 'Multi-byte UTF-8',
'description' => 'Test that multi-byte UTF-8 characters are stored and retrieved correctly.',
'group' => 'Node',
);
}
/**
* Tests that multi-byte UTF-8 characters are stored and retrieved correctly.
*/
public function testMultiByteUtf8() {
$connection = Database::getConnection();
// On MySQL, this test will only run if 'charset' is set to 'utf8mb4' in
// settings.php.
if (!($connection->utf8mb4IsSupported() && $connection->utf8mb4IsActive())) {
return;
}
$title = '🐙';
$this->assertTrue(drupal_strlen($title, 'utf-8') < strlen($title), 'Title has multi-byte characters.');
$node = $this->drupalCreateNode(array('title' => $title));
$this->drupalGet('node/' . $node->nid);
$result = $this->xpath('//h1[@id="page-title"]');
$this->assertEqual(trim((string) $result[0]), $title, 'The passed title was returned.');
}
}
<?php
/**
* @file
* Builds placeholder replacement tokens for node-related data.
*/
/**
* Implements hook_token_info().
*/
function node_token_info() {
$type = array(
'name' => t('Nodes'),
'description' => t('Tokens related to individual content items, or "nodes".'),
'needs-data' => 'node',
);
// Core tokens for nodes.
$node['nid'] = array(
'name' => t("Content ID"),
'description' => t('The unique ID of the content item, or "node".'),
);
$node['vid'] = array(
'name' => t("Revision ID"),
'description' => t("The unique ID of the node's latest revision."),
);
$node['tnid'] = array(
'name' => t("Translation set ID"),
'description' => t("The unique ID of the original-language version of this node, if one exists."),
);
$node['type'] = array(
'name' => t("Content type"),
'description' => t("The type of the node."),
);
$node['type-name'] = array(
'name' => t("Content type name"),
'description' => t("The human-readable name of the node type."),
);
$node['title'] = array(
'name' => t("Title"),
'description' => t("The title of the node."),
);
$node['body'] = array(
'name' => t("Body"),
'description' => t("The main body text of the node."),
);
$node['summary'] = array(
'name' => t("Summary"),
'description' => t("The summary of the node's main body text."),
);
$node['language'] = array(
'name' => t("Language"),
'description' => t("The language the node is written in."),
);
$node['url'] = array(
'name' => t("URL"),
'description' => t("The URL of the node."),
);
$node['edit-url'] = array(
'name' => t("Edit URL"),
'description' => t("The URL of the node's edit page."),
);
// Chained tokens for nodes.
$node['created'] = array(
'name' => t("Date created"),
'description' => t("The date the node was posted."),
'type' => 'date',
);
$node['changed'] = array(
'name' => t("Date changed"),
'description' => t("The date the node was most recently updated."),
'type' => 'date',
);
$node['author'] = array(
'name' => t("Author"),
'description' => t("The author of the node."),
'type' => 'user',
);
return array(
'types' => array('node' => $type),
'tokens' => array('node' => $node),
);
}
/**
* Implements hook_tokens().
*/
function node_tokens($type, $tokens, array $data = array(), array $options = array()) {
$url_options = array('absolute' => TRUE);
if (isset($options['language'])) {
$url_options['language'] = $options['language'];
$language_code = $options['language']->language;
}
else {
$language_code = NULL;
}
$sanitize = !empty($options['sanitize']);
$replacements = array();
if ($type == 'node' && !empty($data['node'])) {
$node = $data['node'];
foreach ($tokens as $name => $original) {
switch ($name) {
// Simple key values on the node.
case 'nid':
$replacements[$original] = isset($node->nid) ? $node->nid : '';
break;
case 'vid':
$replacements[$original] = $node->vid;
break;
case 'tnid':
$replacements[$original] = $node->tnid;
break;
case 'type':
$replacements[$original] = $sanitize ? check_plain($node->type) : $node->type;
break;
case 'type-name':
$type_name = node_type_get_name($node);
$replacements[$original] = $sanitize ? check_plain($type_name) : $type_name;
break;
case 'title':
$replacements[$original] = $sanitize ? check_plain($node->title) : $node->title;
break;
case 'body':
case 'summary':
if ($items = field_get_items('node', $node, 'body', $language_code)) {
$instance = field_info_instance('node', 'body', $node->type);
$field_langcode = field_language('node', $node, 'body', $language_code);
// If the summary was requested and is not empty, use it.
if ($name == 'summary' && !empty($items[0]['summary'])) {
$output = $sanitize ? _text_sanitize($instance, $field_langcode, $items[0], 'summary') : $items[0]['summary'];
}
// Attempt to provide a suitable version of the 'body' field.
else {
$output = $sanitize ? _text_sanitize($instance, $field_langcode, $items[0], 'value') : $items[0]['value'];
// A summary was requested.
if ($name == 'summary') {
if (isset($instance['display']['teaser']['settings']['trim_length'])) {
$trim_length = $instance['display']['teaser']['settings']['trim_length'];
}
else {
// Use default value.
$trim_length = NULL;
}
// Generate an optionally trimmed summary of the body field.
$output = text_summary($output, $instance['settings']['text_processing'] ? $items[0]['format'] : NULL, $trim_length);
}
}
$replacements[$original] = $output;
}
break;
case 'language':
$langcode = entity_language('node', $node);
$replacements[$original] = $sanitize ? check_plain($langcode) : $langcode;
break;
case 'url':
$replacements[$original] = isset($node->nid) ? url('node/' . $node->nid, $url_options) : '';
break;
case 'edit-url':
$replacements[$original] = isset($node->nid) ? url('node/' . $node->nid . '/edit', $url_options) : '';
break;
// Default values for the chained tokens handled below.
case 'author':
$account = user_load($node->uid);
$name = format_username($account);
$replacements[$original] = $sanitize ? check_plain($name) : $name;
break;
case 'created':
$replacements[$original] = format_date($node->created, 'medium', '', NULL, $language_code);
break;
case 'changed':
$replacements[$original] = format_date($node->changed, 'medium', '', NULL, $language_code);
break;
}
}
if ($author_tokens = token_find_with_prefix($tokens, 'author')) {
$author = user_load($node->uid);
$replacements += token_generate('user', $author_tokens, array('user' => $author), $options);
}
if ($created_tokens = token_find_with_prefix($tokens, 'created')) {
$replacements += token_generate('date', $created_tokens, array('date' => $node->created), $options);
}
if ($changed_tokens = token_find_with_prefix($tokens, 'changed')) {
$replacements += token_generate('date', $changed_tokens, array('date' => $node->changed), $options);
}
}
return $replacements;
}
<?php
/**
* @file
* Default theme implementation to display a node.
*
* Available variables:
* - $title: the (sanitized) title of the node.
* - $content: An array of node items. Use render($content) to print them all,
* or print a subset such as render($content['field_example']). Use
* hide($content['field_example']) to temporarily suppress the printing of a
* given element.
* - $user_picture: The node author's picture from user-picture.tpl.php.
* - $date: Formatted creation date. Preprocess functions can reformat it by
* calling format_date() with the desired parameters on the $created variable.
* - $name: Themed username of node author output from theme_username().
* - $node_url: Direct URL of the current node.
* - $display_submitted: Whether submission information should be displayed.
* - $submitted: Submission information created from $name and $date during
* template_preprocess_node().
* - $classes: String of classes that can be used to style contextually through
* CSS. It can be manipulated through the variable $classes_array from
* preprocess functions. The default values can be one or more of the
* following:
* - node: The current template type; for example, "theming hook".
* - node-[type]: The current node type. For example, if the node is a
* "Blog entry" it would result in "node-blog". Note that the machine
* name will often be in a short form of the human readable label.
* - node-teaser: Nodes in teaser form.
* - node-preview: Nodes in preview mode.
* The following are controlled through the node publishing options.
* - node-promoted: Nodes promoted to the front page.
* - node-sticky: Nodes ordered above other non-sticky nodes in teaser
* listings.
* - node-unpublished: Unpublished nodes visible only to administrators.
* - $title_prefix (array): An array containing additional output populated by
* modules, intended to be displayed in front of the main title tag that
* appears in the template.
* - $title_suffix (array): An array containing additional output populated by
* modules, intended to be displayed after the main title tag that appears in
* the template.
*
* Other variables:
* - $node: Full node object. Contains data that may not be safe.
* - $type: Node type; for example, story, page, blog, etc.
* - $comment_count: Number of comments attached to the node.
* - $uid: User ID of the node author.
* - $created: Time the node was published formatted in Unix timestamp.
* - $classes_array: Array of html class attribute values. It is flattened
* into a string within the variable $classes.
* - $zebra: Outputs either "even" or "odd". Useful for zebra striping in
* teaser listings.
* - $id: Position of the node. Increments each time it's output.
*
* Node status variables:
* - $view_mode: View mode; for example, "full", "teaser".
* - $teaser: Flag for the teaser state (shortcut for $view_mode == 'teaser').
* - $page: Flag for the full page state.
* - $promote: Flag for front page promotion state.
* - $sticky: Flags for sticky post setting.
* - $status: Flag for published status.
* - $comment: State of comment settings for the node.
* - $readmore: Flags true if the teaser content of the node cannot hold the
* main body content.
* - $is_front: Flags true when presented in the front page.
* - $logged_in: Flags true when the current user is a logged-in member.
* - $is_admin: Flags true when the current user is an administrator.
*
* Field variables: for each field instance attached to the node a corresponding
* variable is defined; for example, $node->body becomes $body. When needing to
* access a field's raw values, developers/themers are strongly encouraged to
* use these variables. Otherwise they will have to explicitly specify the
* desired field language; for example, $node->body['en'], thus overriding any
* language negotiation rule that was previously applied.
*
* @see template_preprocess()
* @see template_preprocess_node()
* @see template_process()
*
* @ingroup themeable
*/
?>
<div id="node-<?php print $node->nid; ?>" class="<?php print $classes; ?> clearfix"<?php print $attributes; ?>>
<?php print $user_picture; ?>
<?php print render($title_prefix); ?>
<?php if (!$page): ?>
<h2<?php print $title_attributes; ?>><a href="<?php print $node_url; ?>"><?php print $title; ?></a></h2>
<?php endif; ?>
<?php print render($title_suffix); ?>
<?php if ($display_submitted): ?>
<div class="submitted">
<?php print $submitted; ?>
</div>
<?php endif; ?>
<div class="content"<?php print $content_attributes; ?>>
<?php
// We hide the comments and links now so that we can render them later.
hide($content['comments']);
hide($content['links']);
print render($content);
?>
</div>
<?php print render($content['links']); ?>
<?php print render($content['comments']); ?>
</div>
name = "Node module access tests"
description = "Support module for node permission testing."
package = Testing
version = VERSION
core = 7.x
hidden = TRUE
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
<?php
/**
* @file
* Install, update and uninstall functions for the node_access_test module.
*/
/**
* Implements hook_schema().
*/
function node_access_test_schema() {
$schema['node_access_test'] = array(
'description' => 'The base table for node_access_test.',
'fields' => array(
'nid' => array(
'description' => 'The {node}.nid this record affects.',
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
),
'private' => array(
'description' => 'Boolean indicating whether the node is private (visible to administrator) or not (visible to non-administrators).',
'type' => 'int',
'not null' => TRUE,
'default' => 0,
),
),
'indexes' => array(
'nid' => array('nid'),
),
'primary key' => array('nid'),
'foreign keys' => array(
'versioned_node' => array(
'table' => 'node',
'columns' => array('nid' => 'nid'),
),
),
);
return $schema;
}
<?php
/**
* @file
* A dummy module implementing node access related hooks for testing purposes.
*
* A dummy module implementing node access related hooks to test API interaction
* with the Node module. This module restricts view permission to those with
* a special 'node test view' permission.
*/
/**
* Implements hook_node_grants().
*/
function node_access_test_node_grants($account, $op) {
$grants = array();
// First grant a grant to the author for own content.
$grants['node_access_test_author'] = array($account->uid);
if ($op == 'view' && user_access('node test view', $account)) {
$grants['node_access_test'] = array(8888, 8889);
}
if ($op == 'view' && $account->uid == variable_get('node_test_node_access_all_uid', 0)) {
$grants['node_access_all'] = array(0);
}
return $grants;
}
/**
* Implements hook_node_access_records().
*/
function node_access_test_node_access_records($node) {
$grants = array();
// For NodeAccessBaseTableTestCase, only set records for private nodes.
if (!variable_get('node_access_test_private') || $node->private) {
$grants[] = array(
'realm' => 'node_access_test',
'gid' => 8888,
'grant_view' => 1,
'grant_update' => 0,
'grant_delete' => 0,
'priority' => 0,
);
$grants[] = array(
'realm' => 'node_access_test',
'gid' => 8889,
'grant_view' => 1,
'grant_update' => 0,
'grant_delete' => 0,
'priority' => 0,
);
// For the author realm, the GID is equivalent to a UID, which
// means there are many many groups of just 1 user.
$grants[] = array(
'realm' => 'node_access_test_author',
'gid' => $node->uid,
'grant_view' => 1,
'grant_update' => 1,
'grant_delete' => 1,
'priority' => 0,
);
}
return $grants;
}
/**
* Implements hook_permission().
*
* Sets up permissions for this module.
*/
function node_access_test_permission() {
return array('node test view' => array('title' => 'View content'));
}
/**
* Implements hook_menu().
*
* Sets up a page that lists nodes.
*/
function node_access_test_menu() {
$items = array();
$items['node_access_test_page'] = array(
'title' => 'Node access test',
'page callback' => 'node_access_test_page',
'access arguments' => array('access content'),
'type' => MENU_SUGGESTED_ITEM,
);
$items['node_access_entity_test_page'] = array(
'title' => 'Node access test',
'page callback' => 'node_access_entity_test_page',
'access arguments' => array('access content'),
'type' => MENU_SUGGESTED_ITEM,
);
return $items;
}
/**
* Page callback for node access test page.
*
* Page should say "No nodes" if there are no nodes, and "Yes, # nodes" (with
* the number filled in) if there were nodes the user could access. Also, the
* database query is shown, and a list of the node IDs, for debugging purposes.
* And if there is a query exception, the page says "Exception" and gives the
* error.
*/
function node_access_test_page() {
$output = '';
try {
$query = db_select('node', 'mytab')
->fields('mytab');
$query->addTag('node_access');
$result = $query->execute()->fetchAll();
if (count($result)) {
$output .= '<p>Yes, ' . count($result) . ' nodes</p>';
$output .= '<ul>';
foreach ($result as $item) {
$output .= '<li>' . $item->nid . '</li>';
}
$output .= '</ul>';
}
else {
$output .= '<p>No nodes</p>';
}
$output .= '<p>' . ((string) $query ) . '</p>';
}
catch (Exception $e) {
$output = '<p>Exception</p>';
$output .= '<p>' . $e->getMessage() . '</p>';
}
return $output;
}
/**
* Page callback for node access entity test page.
*
* Page should say "No nodes" if there are no nodes, and "Yes, # nodes" (with
* the number filled in) if there were nodes the user could access. Also, the
* database query is shown, and a list of the node IDs, for debugging purposes.
* And if there is a query exception, the page says "Exception" and gives the
* error.
*
* @see node_access_test_menu()
*/
function node_access_entity_test_page() {
$output = '';
try {
$query = new EntityFieldQuery;
$result = $query->fieldCondition('body', 'value', 'A', 'STARTS_WITH')->execute();
if (!empty($result['node'])) {
$output .= '<p>Yes, ' . count($result['node']) . ' nodes</p>';
$output .= '<ul>';
foreach ($result['node'] as $nid => $v) {
$output .= '<li>' . $nid . '</li>';
}
$output .= '</ul>';
}
else {
$output .= '<p>No nodes</p>';
}
}
catch (Exception $e) {
$output = '<p>Exception</p>';
$output .= '<p>' . $e->getMessage() . '</p>';
}
return $output;
}
/**
* Implements hook_form_BASE_FORM_ID_alter().
*/
function node_access_test_form_node_form_alter(&$form, $form_state) {
// Only show this checkbox for NodeAccessBaseTableTestCase.
if (variable_get('node_access_test_private')) {
$form['private'] = array(
'#type' => 'checkbox',
'#title' => t('Private'),
'#description' => t('Check here if this content should be set private and only shown to privileged users.'),
'#default_value' => isset($form['#node']->private) ? $form['#node']->private : FALSE,
);
}
}
/**
* Implements hook_node_load().
*/
function node_access_test_node_load($nodes, $types) {
$result = db_query('SELECT nid, private FROM {node_access_test} WHERE nid IN(:nids)', array(':nids' => array_keys($nodes)));
foreach ($result as $record) {
$nodes[$record->nid]->private = $record->private;
}
}
/**
* Implements hook_node_delete().
*/
function node_access_test_node_delete($node) {
db_delete('node_access_test')->condition('nid', $node->nid)->execute();
}
/**
* Implements hook_node_insert().
*/
function node_access_test_node_insert($node) {
_node_access_test_node_write($node);
}
/**
* Implements hook_node_update().
*/
function node_access_test_node_update($node) {
_node_access_test_node_write($node);
}
/**
* Helper for node insert/update.
*/
function _node_access_test_node_write($node) {
if (isset($node->private)) {
db_merge('node_access_test')
->key(array('nid' => $node->nid))
->fields(array('private' => (int) $node->private))
->execute();
}
}
name = "Node module tests"
description = "Support module for node related testing."
package = Testing
version = VERSION
core = 7.x
hidden = TRUE
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
<?php
/**
* @file
* A dummy module for testing node related hooks.
*
* This is a dummy module that implements node related hooks to test API
* interaction with the Node module.
*/
/**
* Implements hook_node_load().
*/
function node_test_node_load($nodes, $types) {
// Add properties to each loaded node which record the parameters that were
// passed in to this function, so the tests can check that (a) this hook was
// called, and (b) the parameters were what we expected them to be.
$nids = array_keys($nodes);
ksort($nids);
sort($types);
foreach ($nodes as $node) {
$node->node_test_loaded_nids = $nids;
$node->node_test_loaded_types = $types;
}
}
/**
* Implements hook_node_view().
*/
function node_test_node_view($node, $view_mode) {
if ($view_mode == 'rss') {
// Add RSS elements and namespaces when building the RSS feed.
$node->rss_elements[] = array(
'key' => 'testElement',
'value' => t('Value of testElement RSS element for node !nid.', array('!nid' => $node->nid)),
);
$node->rss_namespaces['xmlns:drupaltest'] = 'http://example.com/test-namespace';
// Add content that should be displayed only in the RSS feed.
$node->content['extra_feed_content'] = array(
'#markup' => '<p>' . t('Extra data that should appear only in the RSS feed for node !nid.', array('!nid' => $node->nid)) . '</p>',
'#weight' => 10,
);
}
if ($view_mode != 'rss') {
// Add content that should NOT be displayed in the RSS feed.
$node->content['extra_non_feed_content'] = array(
'#markup' => '<p>' . t('Extra data that should appear everywhere except the RSS feed for node !nid.', array('!nid' => $node->nid)) . '</p>',
);
}
}
/**
* Implements hook_node_grants().
*/
function node_test_node_grants($account, $op) {
// Give everyone full grants so we don't break other node tests.
// Our node access tests asserts three realms of access.
// See testGrantAlter().
return array(
'test_article_realm' => array(1),
'test_page_realm' => array(1),
'test_alter_realm' => array(2),
);
}
/**
* Implements hook_node_access_records().
*/
function node_test_node_access_records($node) {
// Return nothing when testing for empty responses.
if (!empty($node->disable_node_access)) {
return;
}
$grants = array();
if ($node->type == 'article') {
// Create grant in arbitrary article_realm for article nodes.
$grants[] = array(
'realm' => 'test_article_realm',
'gid' => 1,
'grant_view' => 1,
'grant_update' => 0,
'grant_delete' => 0,
'priority' => 0,
);
}
elseif ($node->type == 'page') {
// Create grant in arbitrary page_realm for page nodes.
$grants[] = array(
'realm' => 'test_page_realm',
'gid' => 1,
'grant_view' => 1,
'grant_update' => 0,
'grant_delete' => 0,
'priority' => 0,
);
}
return $grants;
}
/**
* Implements hook_node_access_records_alter().
*/
function node_test_node_access_records_alter(&$grants, $node) {
if (!empty($grants)) {
foreach ($grants as $key => $grant) {
// Alter grant from test_page_realm to test_alter_realm and modify the gid.
if ($grant['realm'] == 'test_page_realm' && $node->promote) {
$grants[$key]['realm'] = 'test_alter_realm';
$grants[$key]['gid'] = 2;
}
}
}
}
/**
* Implements hook_node_grants_alter().
*/
function node_test_node_grants_alter(&$grants, $account, $op) {
// Return an empty array of grants to prove that we can alter by reference.
$grants = array();
}
/**
* Implements hook_node_presave().
*/
function node_test_node_presave($node) {
if ($node->title == 'testing_node_presave') {
// Sun, 19 Nov 1978 05:00:00 GMT
$node->created = 280299600;
// Drupal 1.0 release.
$node->changed = 979534800;
}
// Determine changes.
if (!empty($node->original) && $node->original->title == 'test_changes') {
if ($node->original->title != $node->title) {
$node->title .= '_presave';
}
}
}
/**
* Implements hook_node_update().
*/
function node_test_node_update($node) {
// Determine changes on update.
if (!empty($node->original) && $node->original->title == 'test_changes') {
if ($node->original->title != $node->title) {
$node->title .= '_update';
}
}
}
/**
* Implements hook_entity_view_mode_alter().
*/
function node_test_entity_view_mode_alter(&$view_mode, $context) {
// Only alter the view mode if we are on the test callback.
if ($change_view_mode = variable_get('node_test_change_view_mode', '')) {
$view_mode = $change_view_mode;
}
}
/**
* Implements hook_node_insert().
*
* This tests saving a node on node insert.
*
* @see NodeSaveTest::testNodeSaveOnInsert()
*/
function node_test_node_insert($node) {
// Set the node title to the node ID and save.
if ($node->title == 'new') {
$node->title = 'Node '. $node->nid;
// Remove the is_new flag, so that the node is updated and not inserted
// again.
unset($node->is_new);
node_save($node);
}
}
name = "Node module exception tests"
description = "Support module for node related exception testing."
package = Testing
version = VERSION
core = 7.x
hidden = TRUE
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
<?php
/**
* @file
* A module implementing node related hooks to test API interaction.
*/
/**
* Implements hook_node_insert().
*/
function node_test_exception_node_insert($node) {
if ($node->title == 'testing_transaction_exception') {
throw new Exception('Test exception for rollback.');
}
}
PNG
IHDR a IDAT8c`%- Sbp!y 3 ƇCkP| G2 *?qihG6=f, j0S
D$' $W4Ir>zH6$=!A]oZ]
g $aF IENDB`
#edit-openid-identifier {
background-position: right 50%;
padding-left: 0;
padding-right: 20px;
}
#user-login .openid-links {
padding-right: 0;
}
html.js #user-login-form li.openid-link,
html.js #user-login li.openid-link {
margin-right: 0;
}
#user-login-form li.openid-link a,
#user-login li.openid-link a {
background-position: right top;
padding: 0 1.5em 0 0;
}
<?php
/**
* @file
* Hooks provided by the OpenID module.
*/
/**
* @addtogroup hooks
* @{
*/
/**
* Allow modules to modify the OpenID request parameters.
*
* @param $op
* The operation to be performed.
* Possible values:
* - request: Modify parameters before they are sent to the OpenID provider.
* @param $request
* An associative array of parameter defaults to which to modify or append.
* @return
* An associative array of parameters to be merged with the default list.
*
*/
function hook_openid($op, $request) {
if ($op == 'request') {
$request['openid.identity'] = 'http://myname.myopenid.com/';
}
return $request;
}
/**
* Allow modules to act upon a successful OpenID login.
*
* @param $response
* Response values from the OpenID Provider.
* @param $account
* The Drupal user account that logged in
*
*/
function hook_openid_response($response, $account) {
if (isset($response['openid.ns.ax'])) {
_mymodule_store_ax_fields($response, $account);
}
}
/**
* Allow modules to declare OpenID discovery methods.
*
* The discovery function callbacks will be called in turn with an unique
* parameter, the claimed identifier. They have to return an associative array
* with array of services and claimed identifier in the same form as returned by
* openid_discover(). The resulting array must contain following keys:
* - 'services' (required) an array of discovered services (including OpenID
* version, endpoint URI, etc).
* - 'claimed_id' (optional) new claimed identifer, found by following HTTP
* redirects during the services discovery.
*
* The first discovery method that succeed (return at least one services) will
* stop the discovery process.
*
* @return
* An associative array which keys are the name of the discovery methods and
* values are function callbacks.
*
* @see hook_openid_discovery_method_info_alter()
*/
function hook_openid_discovery_method_info() {
return array(
'new_discovery_idea' => '_my_discovery_method',
);
}
/**
* Allow modules to alter discovery methods.
*/
function hook_openid_discovery_method_info_alter(&$methods) {
// Remove XRI discovery scheme.
unset($methods['xri']);
}
/**
* Allow modules to declare OpenID normalization methods.
*
* The discovery function callbacks will be called in turn with an unique
* parameter, the identifier to normalize. They have to return a normalized
* identifier, or NULL if the identifier is not in a form they can handle.
*
* The first normalization method that succeed (return a value that is not NULL)
* will stop the normalization process.
*
* @return
* An array with a set of function callbacks, that will be called in turn
* when normalizing an OpenID identifier. The normalization functions have
* to return a normalized identifier, or NULL if the identifier is not in
* a form they can handle.
* @see hook_openid_normalization_method_info_alter()
*/
function hook_openid_normalization_method_info() {
return array(
'new_normalization_idea' => '_my_normalization_method',
);
}
/**
* Allow modules to alter normalization methods.
*/
function hook_openid_normalization_method_info_alter(&$methods) {
// Remove Google IDP normalization.
unset($methods['google_idp']);
}
/**
* @} End of "addtogroup hooks".
*/
#edit-openid-identifier {
background-image: url("login-bg.png");
background-position: left 50%; /* LTR */
background-repeat: no-repeat;
padding-left: 20px; /* LTR */
}
div.form-item-openid-identifier {
display: block;
}
html.js #user-login-form div.form-item-openid-identifier,
html.js #user-login div.form-item-openid-identifier {
display: none;
}
#user-login-form ul {
margin-top: 0;
}
#user-login ul {
margin: 0 0 5px;
}
#user-login ul li {
margin: 0;
}
#user-login-form .openid-links {
padding-bottom: 0;
}
#user-login .openid-links {
padding-left: 0; /* LTR */
}
#user-login-form .openid-links li,
#user-login .openid-links li {
display: none;
list-style: none;
}
html.js #user-login-form li.openid-link,
html.js #user-login li.openid-link {
display: block;
margin-left: 0; /* LTR */
}
#user-login-form li.openid-link a,
#user-login li.openid-link a {
background-image: url("login-bg.png");
background-position: left top; /* LTR */
background-repeat: no-repeat;
padding: 0 0 0 1.5em; /* LTR */
}
<?php
/**
* @file
* OpenID utility functions.
*/
/**
* Diffie-Hellman Key Exchange Default Value.
*
* This is used to establish an association between the Relying Party and the
* OpenID Provider.
*
* See RFC 2631: http://www.ietf.org/rfc/rfc2631.txt
*/
define('OPENID_DH_DEFAULT_MOD', '155172898181473697471232257763715539915724801' .
'966915404479707795314057629378541917580651227423698188993727816152646631' .
'438561595825688188889951272158842675419950341258706556549803580104870537' .
'681476726513255747040765857479291291572334510643245094715007229621094194' .
'349783925984760375594985848253359305585439638443');
/**
* Diffie-Hellman generator; used for Diffie-Hellman key exchange computations.
*/
define('OPENID_DH_DEFAULT_GEN', '2');
/**
* SHA-1 hash block size; used for Diffie-Hellman key exchange computations.
*/
define('OPENID_SHA1_BLOCKSIZE', 64);
/**
* Random number generator; used for Diffie-Hellman key exchange computations.
*/
define('OPENID_RAND_SOURCE', '/dev/urandom');
/**
* OpenID Authentication 2.0 namespace URL.
*/
define('OPENID_NS_2_0', 'http://specs.openid.net/auth/2.0');
/**
* OpenID Authentication 1.1 namespace URL; used for backwards-compatibility.
*/
define('OPENID_NS_1_1', 'http://openid.net/signon/1.1');
/**
* OpenID Authentication 1.0 namespace URL; used for backwards-compatibility.
*/
define('OPENID_NS_1_0', 'http://openid.net/signon/1.0');
/**
* OpenID namespace used in Yadis documents.
*/
define('OPENID_NS_OPENID', 'http://openid.net/xmlns/1.0');
/**
* OpenID Simple Registration extension.
*/
define('OPENID_NS_SREG', 'http://openid.net/extensions/sreg/1.1');
/**
* OpenID Attribute Exchange extension.
*/
define('OPENID_NS_AX', 'http://openid.net/srv/ax/1.0');
/**
* Extensible Resource Descriptor documents.
*/
define('OPENID_NS_XRD', 'xri://$xrd*($v*2.0)');
/**
* Performs an HTTP 302 redirect (for the 1.x protocol).
*/
function openid_redirect_http($url, $message) {
$query = array();
foreach ($message as $key => $val) {
$query[] = $key . '=' . urlencode($val);
}
$sep = (strpos($url, '?') === FALSE) ? '?' : '&';
header('Location: ' . $url . $sep . implode('&', $query), TRUE, 302);
drupal_exit();
}
/**
* Creates a js auto-submit redirect for (for the 2.x protocol)
*/
function openid_redirect($url, $message) {
global $language;
$output = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' . "\n";
$output .= '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="' . $language->language . '" lang="' . $language->language . '">' . "\n";
$output .= "<head>\n";
$output .= "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
$output .= "<title>" . t('OpenID redirect') . " \n";
$output .= "\n";
$output .= "\n";
$elements = drupal_get_form('openid_redirect_form', $url, $message);
$output .= drupal_render($elements);
$output .= '' . "\n";
$output .= "\n";
$output .= "\n";
print $output;
drupal_exit();
}
function openid_redirect_form($form, &$form_state, $url, $message) {
$form['#action'] = $url;
$form['#method'] = "post";
foreach ($message as $key => $value) {
$form[$key] = array(
'#type' => 'hidden',
'#name' => $key,
'#value' => $value,
);
}
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#prefix' => '',
'#suffix' => '
|iUs', $html, $matches);
if (isset($matches[3])) {
preg_match('|href=["\']([^"]+)["\']|iU', $matches[3], $href);
return trim($href[1]);
}
return FALSE;
}
/**
* Pull the http-equiv attribute out of an html meta element
*/
function _openid_meta_httpequiv($equiv, $html) {
preg_match('||iUs', $html, $matches);
if (isset($matches[1])) {
preg_match('|content=["\']([^"]+)["\']|iUs', $matches[1], $content);
if (isset($content[1])) {
return $content[1];
}
}
return FALSE;
}
/**
* Sign certain keys in a message
* @param $association - object loaded from openid_association or openid_server_association table
* - important fields are ->assoc_type and ->mac_key
* @param $message_array - array of entire message about to be sent
* @param $keys_to_sign - keys in the message to include in signature (without
* 'openid.' appended)
*/
function _openid_signature($association, $message_array, $keys_to_sign) {
$signature = '';
$sign_data = array();
foreach ($keys_to_sign as $key) {
if (isset($message_array['openid.' . $key])) {
$sign_data[$key] = $message_array['openid.' . $key];
}
}
$message = _openid_create_message($sign_data);
$secret = base64_decode((string) $association->mac_key);
$signature = _openid_hmac($secret, $message);
return base64_encode($signature);
}
function _openid_hmac($key, $text) {
if (strlen($key) > OPENID_SHA1_BLOCKSIZE) {
$key = sha1($key, TRUE);
}
$key = str_pad($key, OPENID_SHA1_BLOCKSIZE, chr(0x00));
$ipad = str_repeat(chr(0x36), OPENID_SHA1_BLOCKSIZE);
$opad = str_repeat(chr(0x5c), OPENID_SHA1_BLOCKSIZE);
$hash1 = sha1(($key ^ $ipad) . $text, TRUE);
$hmac = sha1(($key ^ $opad) . $hash1, TRUE);
return $hmac;
}
function _openid_dh_base64_to_long($str) {
$b64 = base64_decode($str);
return _openid_dh_binary_to_long($b64);
}
function _openid_dh_long_to_base64($str) {
return base64_encode(_openid_dh_long_to_binary($str));
}
function _openid_dh_binary_to_long($str) {
$bytes = array_merge(unpack('C*', $str));
$n = 0;
foreach ($bytes as $byte) {
$n = _openid_math_mul($n, pow(2, 8));
$n = _openid_math_add($n, $byte);
}
return $n;
}
function _openid_dh_long_to_binary($long) {
$cmp = _openid_math_cmp($long, 0);
if ($cmp < 0) {
return FALSE;
}
if ($cmp == 0) {
return "\x00";
}
$bytes = array();
while (_openid_math_cmp($long, 0) > 0) {
array_unshift($bytes, _openid_math_mod($long, 256));
$long = _openid_math_div($long, pow(2, 8));
}
if ($bytes && ($bytes[0] > 127)) {
array_unshift($bytes, 0);
}
$string = '';
foreach ($bytes as $byte) {
$string .= pack('C', $byte);
}
return $string;
}
function _openid_dh_xorsecret($shared, $secret) {
$dh_shared_str = _openid_dh_long_to_binary($shared);
$sha1_dh_shared = sha1($dh_shared_str, TRUE);
$xsecret = "";
for ($i = 0; $i < strlen($secret); $i++) {
$xsecret .= chr(ord($secret[$i]) ^ ord($sha1_dh_shared[$i]));
}
return $xsecret;
}
function _openid_dh_rand($stop) {
$duplicate_cache = &drupal_static(__FUNCTION__, array());
// Used as the key for the duplicate cache
$rbytes = _openid_dh_long_to_binary($stop);
if (isset($duplicate_cache[$rbytes])) {
list($duplicate, $nbytes) = $duplicate_cache[$rbytes];
}
else {
if ($rbytes[0] == "\x00") {
$nbytes = strlen($rbytes) - 1;
}
else {
$nbytes = strlen($rbytes);
}
$mxrand = _openid_math_pow(256, $nbytes);
// If we get a number less than this, then it is in the
// duplicated range.
$duplicate = _openid_math_mod($mxrand, $stop);
if (count($duplicate_cache) > 10) {
$duplicate_cache = array();
}
$duplicate_cache[$rbytes] = array($duplicate, $nbytes);
}
do {
$bytes = "\x00" . drupal_random_bytes($nbytes);
$n = _openid_dh_binary_to_long($bytes);
// Keep looping if this value is in the low duplicated range.
} while (_openid_math_cmp($n, $duplicate) < 0);
return _openid_math_mod($n, $stop);
}
function _openid_get_bytes($num_bytes) {
return drupal_random_bytes($num_bytes);
}
function _openid_response($str = NULL) {
$data = array();
if (isset($_SERVER['REQUEST_METHOD'])) {
$data = _openid_get_params($_SERVER['QUERY_STRING']);
if ($_SERVER['REQUEST_METHOD'] == 'POST') {
$str = file_get_contents('php://input');
$post = array();
if ($str !== FALSE) {
$post = _openid_get_params($str);
}
$data = array_merge($data, $post);
}
}
return $data;
}
function _openid_get_params($str) {
$chunks = explode("&", $str);
$data = array();
foreach ($chunks as $chunk) {
$parts = explode("=", $chunk, 2);
if (count($parts) == 2) {
list($k, $v) = $parts;
$data[$k] = urldecode($v);
}
}
return $data;
}
/**
* Extract all the parameters belonging to an extension in a response message.
*
* OpenID 2.0 defines a simple extension mechanism, based on a namespace prefix.
*
* Each request or response can define a prefix using:
* @code
* openid.ns.[prefix] = [extension_namespace]
* openid.[prefix].[key1] = [value1]
* openid.[prefix].[key2] = [value2]
* ...
* @endcode
*
* This function extracts all the keys belonging to an extension namespace in a
* response, optionally using a fallback prefix if none is provided in the response.
*
* Note that you cannot assume that a given extension namespace will use the same
* prefix on the response and the request: each party may use a different prefix
* to refer to the same namespace.
*
* @param $response
* The response array.
* @param $extension_namespace
* The namespace of the extension.
* @param $fallback_prefix
* An optional prefix that will be used in case no prefix is found for the
* target extension namespace.
* @param $only_signed
* Return only keys that are included in the message signature in openid.sig.
* Unsigned fields may have been modified or added by other parties than the
* OpenID Provider.
*
* @return
* An associative array containing all the parameters in the response message
* that belong to the extension. The keys are stripped from their namespace
* prefix.
*
* @see http://openid.net/specs/openid-authentication-2_0.html#extensions
*/
function openid_extract_namespace($response, $extension_namespace, $fallback_prefix = NULL, $only_signed = FALSE) {
$signed_keys = explode(',', $response['openid.signed']);
// Find the namespace prefix.
$prefix = $fallback_prefix;
foreach ($response as $key => $value) {
if ($value == $extension_namespace && preg_match('/^openid\.ns\.([^.]+)$/', $key, $matches)) {
$prefix = $matches[1];
if ($only_signed && !in_array('ns.' . $matches[1], $signed_keys)) {
// The namespace was defined but was not signed as required. In this
// case we do not fall back to $fallback_prefix.
$prefix = NULL;
}
break;
}
}
// Now extract the namespace keys from the response.
$output = array();
if (!isset($prefix)) {
return $output;
}
foreach ($response as $key => $value) {
if (preg_match('/^openid\.' . $prefix . '\.(.+)$/', $key, $matches)) {
$local_key = $matches[1];
if (!$only_signed || in_array($prefix . '.' . $local_key, $signed_keys)) {
$output[$local_key] = $value;
}
}
}
return $output;
}
/**
* Extracts values from an OpenID AX Response.
*
* The values can be returned in two forms:
* - only openid.ax.value. (for single-valued answers)
* - both openid.ax.count. and openid.ax.value.. (for both
* single and multiple-valued answers)
*
* @param $values
* An array as returned by openid_extract_namespace(..., OPENID_NS_AX).
* @param $uris
* An array of identifier URIs.
* @return
* An array of values.
* @see http://openid.net/specs/openid-attribute-exchange-1_0.html#fetch_response
*/
function openid_extract_ax_values($values, $uris) {
$output = array();
foreach ($values as $key => $value) {
if (in_array($value, $uris) && preg_match('/^type\.([^.]+)$/', $key, $matches)) {
$alias = $matches[1];
if (isset($values['count.' . $alias])) {
for ($i = 1; $i <= $values['count.' . $alias]; $i++) {
$output[] = $values['value.' . $alias . '.' . $i];
}
}
elseif (isset($values['value.' . $alias])) {
$output[] = $values['value.' . $alias];
}
break;
}
}
return $output;
}
/**
* Determine the available math library GMP vs. BCMath, favouring GMP for performance.
*/
function _openid_get_math_library() {
// Not drupal_static(), because a function is not going to disappear and
// change the output of this under any circumstances.
static $library;
if (empty($library)) {
if (function_exists('gmp_add')) {
$library = 'gmp';
}
elseif (function_exists('bcadd')) {
$library = 'bcmath';
}
}
return $library;
}
/**
* Calls the add function from the available math library for OpenID.
*/
function _openid_math_add($x, $y) {
$library = _openid_get_math_library();
switch ($library) {
case 'gmp':
return gmp_strval(gmp_add($x, $y));
case 'bcmath':
return bcadd($x, $y);
}
}
/**
* Calls the mul function from the available math library for OpenID.
*/
function _openid_math_mul($x, $y) {
$library = _openid_get_math_library();
switch ($library) {
case 'gmp':
return gmp_mul($x, $y);
case 'bcmath':
return bcmul($x, $y);
}
}
/**
* Calls the div function from the available math library for OpenID.
*/
function _openid_math_div($x, $y) {
$library = _openid_get_math_library();
switch ($library) {
case 'gmp':
return gmp_div($x, $y);
case 'bcmath':
return bcdiv($x, $y);
}
}
/**
* Calls the cmp function from the available math library for OpenID.
*/
function _openid_math_cmp($x, $y) {
$library = _openid_get_math_library();
switch ($library) {
case 'gmp':
return gmp_cmp($x, $y);
case 'bcmath':
return bccomp($x, $y);
}
}
/**
* Calls the mod function from the available math library for OpenID.
*/
function _openid_math_mod($x, $y) {
$library = _openid_get_math_library();
switch ($library) {
case 'gmp':
return gmp_mod($x, $y);
case 'bcmath':
return bcmod($x, $y);
}
}
/**
* Calls the pow function from the available math library for OpenID.
*/
function _openid_math_pow($x, $y) {
$library = _openid_get_math_library();
switch ($library) {
case 'gmp':
return gmp_pow($x, $y);
case 'bcmath':
return bcpow($x, $y);
}
}
/**
* Calls the mul function from the available math library for OpenID.
*/
function _openid_math_powmod($x, $y, $z) {
$library = _openid_get_math_library();
switch ($library) {
case 'gmp':
return gmp_powm($x, $y, $z);
case 'bcmath':
return bcpowmod($x, $y, $z);
}
}
/**
* Provides transition for accounts with possibly invalid OpenID identifiers in authmap.
*
* This function provides a less safe but more unobtrusive procedure for users
* who cannot login with their OpenID identifiers. OpenID identifiers in the
* authmap could be incomplete due to invalid OpenID implementation in previous
* versions of Drupal (e.g. fragment part of the identifier could be missing).
* For more information see http://drupal.org/node/1120290.
*
* @param string $identity
* The user's claimed OpenID identifier.
*
* @return
* A fully-loaded user object if the user is found or FALSE if not found.
*/
function _openid_invalid_openid_transition($identity, $response) {
$account = FALSE;
$fallback_account = NULL;
$fallback_identity = $identity;
// Try to strip the fragment if it is present.
if (strpos($fallback_identity, '#') !== FALSE) {
$fallback_identity = preg_replace('/#.*/', '', $fallback_identity);
$fallback_account = user_external_load($fallback_identity);
}
// Try to replace HTTPS with HTTP. OpenID providers often redirect
// from http to https, but Drupal didn't follow the redirect.
if (!$fallback_account && strpos($fallback_identity, 'https://') !== FALSE) {
$fallback_identity = str_replace('https://', 'http://', $fallback_identity);
$fallback_account = user_external_load($fallback_identity);
}
// Try to use original identifier.
if (!$fallback_account && isset($_SESSION['openid']['user_login_values']['openid_identifier'])) {
$fallback_identity = openid_normalize($_SESSION['openid']['user_login_values']['openid_identifier']);
$fallback_account = user_external_load($fallback_identity);
}
if ($fallback_account) {
// Try to extract e-mail address from Simple Registration (SREG) or
// Attribute Exchanges (AX) keys.
$email = '';
$sreg_values = openid_extract_namespace($response, OPENID_NS_SREG, 'sreg', TRUE);
$ax_values = openid_extract_namespace($response, OPENID_NS_AX, 'ax', TRUE);
if (!empty($sreg_values['email']) && valid_email_address($sreg_values['email'])) {
$email = $sreg_values['email'];
}
elseif ($ax_mail_values = openid_extract_ax_values($ax_values, array('http://axschema.org/contact/email', 'http://schema.openid.net/contact/email'))) {
$email = current($ax_mail_values);
}
// If this e-mail address is the same as the e-mail address found in user
// account, login the user and update the claimed identifier.
if ($email && ($email == $fallback_account->mail || $email == $fallback_account->init)) {
$query = db_insert('authmap')
->fields(array(
'authname' => $identity,
'uid' => $fallback_account->uid,
'module' => 'openid',
))
->execute();
drupal_set_message(t('New OpenID identifier %identity was added as a replacement for invalid identifier %invalid_identity. To finish the invalid OpenID transition process, please go to your OpenID identities page and remove the old identifier %invalid_identity.', array('%invalid_identity' => $fallback_identity, '%identity' => $identity, '@openid_url' => 'user/' . $fallback_account->uid . '/openid')));
// Set the account to the found one.
$account = $fallback_account;
}
else {
drupal_set_message(t('There is already an existing account associated with the OpenID identifier that you have provided. However, due to a bug in the previous version of the authentication system, we can\'t be sure that this account belongs to you. If you are new on this site, please continue registering the new user account. If you already have a registered account on this site associated with the provided OpenID identifier, please try to reset the password or contact the site administrator.', array('@url_password' => 'user/password')), 'warning');
}
}
return $account;
}
name = OpenID
description = "Allows users to log into your site using OpenID."
version = VERSION
package = Core
core = 7.x
files[] = openid.test
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
'Stores temporary shared key association information for OpenID authentication.',
'fields' => array(
'idp_endpoint_uri' => array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'description' => 'Primary Key: URI of the OpenID Provider endpoint.',
),
'assoc_handle' => array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'description' => 'Used to refer to this association in subsequent messages.',
),
'assoc_type' => array(
'type' => 'varchar',
'length' => 32,
'description' => 'The signature algorithm used: one of HMAC-SHA1 or HMAC-SHA256.',
),
'session_type' => array(
'type' => 'varchar',
'length' => 32,
'description' => 'Valid association session types: "no-encryption", "DH-SHA1", and "DH-SHA256".',
),
'mac_key' => array(
'type' => 'varchar',
'length' => 255,
'description' => 'The MAC key (shared secret) for this association.',
),
'created' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'UNIX timestamp for when the association was created.',
),
'expires_in' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'The lifetime, in seconds, of this association.',
),
),
'primary key' => array('idp_endpoint_uri'),
'unique keys' => array(
'assoc_handle' => array('assoc_handle'),
),
);
$schema['openid_nonce'] = array(
'description' => 'Stores received openid.response_nonce per OpenID endpoint URL to prevent replay attacks.',
'fields' => array(
'idp_endpoint_uri' => array(
'type' => 'varchar',
'length' => 255,
'description' => 'URI of the OpenID Provider endpoint.',
),
'nonce' => array(
'type' => 'varchar',
'length' => 255,
'description' => 'The value of openid.response_nonce.',
),
'expires' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'A Unix timestamp indicating when the entry should expire.',
),
),
'indexes' => array(
'nonce' => array('nonce'),
'expires' => array('expires'),
),
);
return $schema;
}
/**
* Implements hook_requirements().
*/
function openid_requirements($phase) {
$requirements = array();
if ($phase == 'runtime') {
// Check for the PHP BC Math library.
if (!function_exists('bcadd') && !function_exists('gmp_add')) {
$requirements['openid_math'] = array(
'value' => t('Not installed'),
'severity' => REQUIREMENT_ERROR,
'description' => t('OpenID suggests the use of either the GMP Math (recommended for performance) or BC Math libraries to enable OpenID associations.', array('@gmp' => 'http://php.net/manual/en/book.gmp.php', '@bc' => 'http://www.php.net/manual/en/book.bc.php')),
);
}
elseif (!function_exists('gmp_add')) {
$requirements['openid_math'] = array(
'value' => t('Not optimized'),
'severity' => REQUIREMENT_WARNING,
'description' => t('OpenID suggests the use of the GMP Math library for PHP for optimal performance. Check the GMP Math Library documentation for installation instructions.', array('@url' => 'http://www.php.net/manual/en/book.gmp.php')),
);
}
else {
$requirements['openid_math'] = array(
'value' => t('Installed'),
'severity' => REQUIREMENT_OK,
);
}
$requirements['openid_math']['title'] = t('OpenID Math library');
}
return $requirements;
}
/**
* @addtogroup updates-6.x-to-7.x
* @{
*/
/**
* Add a table to store nonces.
*/
function openid_update_6000() {
$schema['openid_nonce'] = array(
'description' => 'Stores received openid.response_nonce per OpenID endpoint URL to prevent replay attacks.',
'fields' => array(
'idp_endpoint_uri' => array(
'type' => 'varchar',
'length' => 255,
'description' => 'URI of the OpenID Provider endpoint.',
),
'nonce' => array(
'type' => 'varchar',
'length' => 255,
'description' => 'The value of openid.response_nonce'
),
'expires' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'A Unix timestamp indicating when the entry should expire.',
),
),
'indexes' => array(
'nonce' => array('nonce'),
'expires' => array('expires'),
),
);
db_create_table('openid_nonce', $schema['openid_nonce']);
}
/**
* @} End of "addtogroup updates-6.x-to-7.x".
*/
/**
* @addtogroup updates-7.x-extra
* @{
*/
/**
* Bind associations to their providers.
*/
function openid_update_7000() {
db_drop_table('openid_association');
$schema = array(
'description' => 'Stores temporary shared key association information for OpenID authentication.',
'fields' => array(
'idp_endpoint_uri' => array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'description' => 'Primary Key: URI of the OpenID Provider endpoint.',
),
'assoc_handle' => array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'description' => 'Used to refer to this association in subsequent messages.',
),
'assoc_type' => array(
'type' => 'varchar',
'length' => 32,
'description' => 'The signature algorithm used: one of HMAC-SHA1 or HMAC-SHA256.',
),
'session_type' => array(
'type' => 'varchar',
'length' => 32,
'description' => 'Valid association session types: "no-encryption", "DH-SHA1", and "DH-SHA256".',
),
'mac_key' => array(
'type' => 'varchar',
'length' => 255,
'description' => 'The MAC key (shared secret) for this association.',
),
'created' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'UNIX timestamp for when the association was created.',
),
'expires_in' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'The lifetime, in seconds, of this association.',
),
),
'primary key' => array('idp_endpoint_uri'),
'unique keys' => array(
'assoc_handle' => array('assoc_handle'),
),
);
db_create_table('openid_association', $schema);
}
/**
* @} End of "addtogroup updates-7.x-extra".
*/
(function ($) {
Drupal.behaviors.openid = {
attach: function (context) {
var loginElements = $('.form-item-name, .form-item-pass, li.openid-link');
var openidElements = $('.form-item-openid-identifier, li.user-link');
var cookie = $.cookie('Drupal.visitor.openid_identifier');
// This behavior attaches by ID, so is only valid once on a page.
if (!$('#edit-openid-identifier.openid-processed').length) {
if (cookie) {
$('#edit-openid-identifier').val(cookie);
}
if ($('#edit-openid-identifier').val() || location.hash == '#openid-login') {
$('#edit-openid-identifier').addClass('openid-processed');
loginElements.hide();
// Use .css('display', 'block') instead of .show() to be Konqueror friendly.
openidElements.css('display', 'block');
}
}
$('li.openid-link:not(.openid-processed)', context)
.addClass('openid-processed')
.click(function () {
loginElements.hide();
openidElements.css('display', 'block');
// Remove possible error message.
$('#edit-name, #edit-pass').removeClass('error');
$('div.messages.error').hide();
// Set focus on OpenID Identifier field.
$('#edit-openid-identifier')[0].focus();
return false;
});
$('li.user-link:not(.openid-processed)', context)
.addClass('openid-processed')
.click(function () {
openidElements.hide();
loginElements.css('display', 'block');
// Clear OpenID Identifier field and remove possible error message.
$('#edit-openid-identifier').val('').removeClass('error');
$('div.messages.error').css('display', 'block');
// Set focus on username field.
$('#edit-name')[0].focus();
return false;
});
}
};
})(jQuery);
'OpenID Login',
'page callback' => 'openid_authentication_page',
'access callback' => 'user_is_anonymous',
'type' => MENU_CALLBACK,
'file' => 'openid.pages.inc',
);
$items['user/%user/openid'] = array(
'title' => 'OpenID identities',
'page callback' => 'openid_user_identities',
'page arguments' => array(1),
'access callback' => 'user_edit_access',
'access arguments' => array(1),
'type' => MENU_LOCAL_TASK,
'file' => 'openid.pages.inc',
);
$items['user/%user/openid/delete'] = array(
'title' => 'Delete OpenID',
'page callback' => 'drupal_get_form',
'page arguments' => array('openid_user_delete_form', 1),
'access callback' => 'user_edit_access',
'access arguments' => array(1),
'file' => 'openid.pages.inc',
);
return $items;
}
/**
* Implements hook_menu_site_status_alter().
*/
function openid_menu_site_status_alter(&$menu_site_status, $path) {
// Allow access to openid/authenticate even if site is in offline mode.
if ($menu_site_status == MENU_SITE_OFFLINE && user_is_anonymous() && $path == 'openid/authenticate') {
$menu_site_status = MENU_SITE_ONLINE;
}
}
/**
* Implements hook_admin_paths().
*/
function openid_admin_paths() {
$paths = array(
'user/*/openid' => TRUE,
'user/*/openid/delete' => TRUE,
);
return $paths;
}
/**
* Implements hook_help().
*/
function openid_help($path, $arg) {
switch ($path) {
case 'user/%/openid':
$output = '' . t('This site supports OpenID , a secure way to log in to many websites using a single username and password. OpenID can reduce the necessity of managing many usernames and passwords for many websites.', array('@openid-net' => 'http://openid.net')) . '
';
$output .= '' . t('To use OpenID you must first establish an identity on a public or private OpenID server. If you do not have an OpenID and would like one, look into one of the free public providers . You can find out more about OpenID at this website .', array('@openid-providers' => 'http://openid.net/get/', '@openid-net' => 'http://openid.net')) . '
';
$output .= '' . t('If you already have an OpenID, enter the URL to your OpenID server below (e.g. myusername.openidprovider.com). Next time you log in, you will be able to use this URL instead of a regular username and password. You can have multiple OpenID servers if you like; just keep adding them here.') . '
';
return $output;
case 'admin/help#openid':
$output = '';
$output .= '' . t('About') . ' ';
$output .= '' . t('The OpenID module allows users to log in using the OpenID single sign on service. OpenID is a secure method for logging into many websites with a single username and password. It does not require special software, and it does not share passwords with any site to which it is associated, including the site being logged into. The main benefit to users is that they can have a single password that they can use on many websites. This means they can easily update their single password from a centralized location, rather than having to change dozens of passwords individually. For more information, see the online handbook entry for OpenID module .', array('@openid-net' => 'http://openid.net', '@handbook' => 'http://drupal.org/documentation/modules/openid')) . '
';
$output .= '' . t('Uses') . ' ';
$output .= '';
$output .= '' . t('Logging in with OpenID') . ' ';
$output .= '' . t("To log in using OpenID, a user must already have an OpenID account. Users can then create site accounts using their OpenID, assign one or more OpenIDs to an existing account, and log in using an OpenID. This lowers the barrier to registration, which helps increase the user base, and offers convenience and security to the users. Because OpenID cannot guarantee a user is legitimate, email verification is still necessary. When logging in, users are presented with the option of entering their OpenID URL, which will look like myusername.openidprovider.com . The site then communicates with the OpenID server, asking it to verify the identity of the user. If the user is logged into their OpenID server, the server communicates back to your site, verifying the user. If they are not logged in, the OpenID server will ask the user for their password. At no point does the site being logged into record the user's OpenID password.") . ' ';
$output .= ' ';
return $output;
}
}
/**
* Implements hook_user_insert().
*/
function openid_user_insert(&$edit, $account, $category) {
if (!empty($edit['openid_claimed_id'])) {
// The user has registered after trying to log in via OpenID.
if (variable_get('user_email_verification', TRUE)) {
drupal_set_message(t('Once you have verified your e-mail address, you may log in via OpenID.'));
}
user_set_authmaps($account, array('authname_openid' => $edit['openid_claimed_id']));
unset($_SESSION['openid']);
unset($edit['openid_claimed_id']);
}
}
/**
* Implements hook_user_login().
*
* Save openid_identifier to visitor cookie.
*/
function openid_user_login(&$edit, $account) {
if (isset($_SESSION['openid'])) {
// The user has logged in via OpenID.
user_cookie_save(array_intersect_key($_SESSION['openid']['user_login_values'], array_flip(array('openid_identifier'))));
unset($_SESSION['openid']);
}
}
/**
* Implements hook_user_logout().
*
* Delete any openid_identifier in visitor cookie.
*/
function openid_user_logout($account) {
if (isset($_COOKIE['Drupal_visitor_openid_identifier'])) {
user_cookie_delete('openid_identifier');
}
}
/**
* Implements hook_form_FORM_ID_alter().
*/
function openid_form_user_login_block_alter(&$form, &$form_state) {
_openid_user_login_form_alter($form, $form_state);
}
/**
* Implements hook_form_FORM_ID_alter().
*/
function openid_form_user_login_alter(&$form, &$form_state) {
_openid_user_login_form_alter($form, $form_state);
}
function _openid_user_login_form_alter(&$form, &$form_state) {
$form['#attached']['css'][] = drupal_get_path('module', 'openid') . '/openid.css';
$form['#attached']['js'][] = drupal_get_path('module', 'openid') . '/openid.js';
$form['#attached']['library'][] = array('system', 'jquery.cookie');
if (!empty($form_state['input']['openid_identifier'])) {
$form['name']['#required'] = FALSE;
$form['pass']['#required'] = FALSE;
unset($form['#submit']);
$form['#validate'] = array('openid_login_validate');
}
$items = array();
$items[] = array(
'data' => l(t('Log in using OpenID'), '#openid-login', array('external' => TRUE)),
'class' => array('openid-link'),
);
$items[] = array(
'data' => l(t('Cancel OpenID login'), '#', array('external' => TRUE)),
'class' => array('user-link'),
);
$form['openid_links'] = array(
'#theme' => 'item_list',
'#items' => $items,
'#attributes' => array('class' => array('openid-links')),
'#weight' => 1,
);
$form['links']['#weight'] = 2;
$form['openid_identifier'] = array(
'#type' => 'textfield',
'#title' => t('Log in using OpenID'),
'#size' => $form['name']['#size'],
'#maxlength' => 255,
'#weight' => -1,
'#description' => l(t('What is OpenID?'), 'http://openid.net/', array('external' => TRUE)),
);
$form['openid.return_to'] = array('#type' => 'hidden', '#value' => url('openid/authenticate', array('absolute' => TRUE, 'query' => user_login_destination())));
}
/**
* Implements hook_form_FORM_ID_alter().
*
* Prefills the login form with values acquired via OpenID.
*/
function openid_form_user_register_form_alter(&$form, &$form_state) {
if (isset($_SESSION['openid']['response'])) {
module_load_include('inc', 'openid');
$response = $_SESSION['openid']['response'];
// Extract Simple Registration keys from the response. We only include
// signed keys as required by OpenID Simple Registration Extension 1.0,
// section 4.
$sreg_values = openid_extract_namespace($response, OPENID_NS_SREG, 'sreg', TRUE);
// Extract Attribute Exchanges keys from the response. We only include
// signed keys. This is not required by the specification, but it is
// recommended by Google, see
// http://googlecode.blogspot.com/2011/05/security-advisory-to-websites-using.html
$ax_values = openid_extract_namespace($response, OPENID_NS_AX, 'ax', TRUE);
if (!empty($sreg_values['nickname'])) {
// Use the nickname returned by Simple Registration if available.
$form['account']['name']['#default_value'] = $sreg_values['nickname'];
}
elseif ($ax_name_values = openid_extract_ax_values($ax_values, array('http://axschema.org/namePerson/friendly', 'http://schema.openid.net/namePerson/friendly'))) {
// Else, use the first nickname returned by AX if available.
$form['account']['name']['#default_value'] = current($ax_name_values);
}
else {
$form['account']['name']['#default_value'] = '';
}
if (!empty($sreg_values['email'])) {
// Use the email returned by Simple Registration if available.
$form['account']['mail']['#default_value'] = $sreg_values['email'];
}
elseif ($ax_mail_values = openid_extract_ax_values($ax_values, array('http://axschema.org/contact/email', 'http://schema.openid.net/contact/email'))) {
// Else, use the first nickname returned by AX if available.
$form['account']['mail']['#default_value'] = current($ax_mail_values);
}
// If user_email_verification is off, hide the password field and just fill
// with random password to avoid confusion.
if (!variable_get('user_email_verification', TRUE)) {
$form['account']['pass']['#type'] = 'hidden';
$form['account']['pass']['#value'] = user_password();
}
$form['openid_claimed_id'] = array(
'#type' => 'value',
'#default_value' => $response['openid.claimed_id'],
);
$form['openid_display'] = array(
'#type' => 'item',
'#title' => t('Your OpenID'),
'#description' => t('This OpenID will be attached to your account after registration.'),
'#markup' => check_plain($response['openid.claimed_id']),
);
}
}
/**
* Login form _validate hook
*/
function openid_login_validate($form, &$form_state) {
$return_to = $form_state['values']['openid.return_to'];
if (empty($return_to)) {
$return_to = url('', array('absolute' => TRUE));
}
openid_begin($form_state['values']['openid_identifier'], $return_to, $form_state['values']);
}
/**
* The initial step of OpenID authentication responsible for the following:
* - Perform discovery on the claimed OpenID.
* - If possible, create an association with the Provider's endpoint.
* - Create the authentication request.
* - Perform the appropriate redirect.
*
* @param $claimed_id The OpenID to authenticate
* @param $return_to The endpoint to return to from the OpenID Provider
*/
function openid_begin($claimed_id, $return_to = '', $form_values = array()) {
module_load_include('inc', 'openid');
$service = NULL;
$claimed_id = openid_normalize($claimed_id);
$discovery = openid_discovery($claimed_id);
if (!empty($discovery['services'])) {
$service = _openid_select_service($discovery['services']);
}
// Quit if the discovery result was empty or if we can't select any service.
if (!$discovery || !$service) {
form_set_error('openid_identifier', t('Sorry, that is not a valid OpenID. Ensure you have spelled your ID correctly.'));
return;
}
// Set claimed id from discovery.
if (!empty($discovery['claimed_id'])) {
$claimed_id = $discovery['claimed_id'];
}
// Store discovered information in the users' session so we don't have to rediscover.
$_SESSION['openid']['service'] = $service;
// Store the claimed id
$_SESSION['openid']['claimed_id'] = $claimed_id;
// Store the login form values so we can pass them to
// user_exteral_login later.
$_SESSION['openid']['user_login_values'] = $form_values;
// If a supported math library is present, then create an association.
$assoc_handle = '';
if (_openid_get_math_library()) {
$assoc_handle = openid_association($service['uri']);
}
if (in_array('http://specs.openid.net/auth/2.0/server', $service['types'])) {
// User entered an OP Identifier.
$claimed_id = $identity = 'http://specs.openid.net/auth/2.0/identifier_select';
}
else {
// Use Claimed ID and/or OP-Local Identifier from service description, if
// available.
if (!empty($service['claimed_id'])) {
$claimed_id = $service['claimed_id'];
}
$identity = !empty($service['identity']) ? $service['identity'] : $claimed_id;
}
$request = openid_authentication_request($claimed_id, $identity, $return_to, $assoc_handle, $service);
if ($service['version'] == 2) {
openid_redirect($service['uri'], $request);
}
else {
openid_redirect_http($service['uri'], $request);
}
}
/**
* Completes OpenID authentication by validating returned data from the OpenID
* Provider.
*
* @param $response Array of returned values from the OpenID Provider.
*
* @return $response Response values for further processing with
* $response['status'] set to one of 'success', 'failed' or 'cancel'.
*/
function openid_complete($response = array()) {
module_load_include('inc', 'openid');
if (count($response) == 0) {
$response = _openid_response();
}
// Default to failed response
$response['status'] = 'failed';
if (isset($_SESSION['openid']['service']['uri']) && isset($_SESSION['openid']['claimed_id'])) {
$service = $_SESSION['openid']['service'];
$claimed_id = $_SESSION['openid']['claimed_id'];
unset($_SESSION['openid']['service']);
unset($_SESSION['openid']['claimed_id']);
if (isset($response['openid.mode'])) {
if ($response['openid.mode'] == 'cancel') {
$response['status'] = 'cancel';
}
else {
if (openid_verify_assertion($service, $response)) {
// OpenID Authentication, section 7.3.2.3 and Appendix A.5:
// The CanonicalID specified in the XRDS document must be used as the
// account key. We rely on the XRI proxy resolver to verify that the
// provider is authorized to respond on behalf of the specified
// identifer (required per Extensible Resource Identifier (XRI)
// (XRI) Resolution Version 2.0, section 14.3):
if (!empty($service['claimed_id'])) {
$response['openid.claimed_id'] = $service['claimed_id'];
}
elseif ($service['version'] == 2) {
// Returned Claimed Identifier could contain unique fragment
// identifier to allow identifier recycling so we need to preserve
// it in the response.
$response_claimed_id = openid_normalize($response['openid.claimed_id']);
// OpenID Authentication, section 11.2:
// If the returned Claimed Identifier is different from the one sent
// to the OpenID Provider, we need to do discovery on the returned
// identififer to make sure that the provider is authorized to
// respond on behalf of this.
if ($response_claimed_id != $claimed_id || $response_claimed_id != $response['openid.identity']) {
$discovery = openid_discovery($response['openid.claimed_id']);
$uris = array();
if ($discovery && !empty($discovery['services'])) {
foreach ($discovery['services'] as $discovered_service) {
if (!in_array('http://specs.openid.net/auth/2.0/server', $discovered_service['types']) && !in_array('http://specs.openid.net/auth/2.0/signon', $discovered_service['types'])) {
continue;
}
// The OP-Local Identifier (if different than the Claimed
// Identifier) must be present in the XRDS document.
if ($response_claimed_id != $response['openid.identity'] && (!isset($discovered_service['identity']) || $discovered_service['identity'] != $response['openid.identity'])) {
continue;
}
$uris[] = $discovered_service['uri'];
}
}
if (!in_array($service['uri'], $uris)) {
return $response;
}
}
}
else {
$response['openid.claimed_id'] = $claimed_id;
}
$response['status'] = 'success';
}
}
}
}
return $response;
}
/**
* Perform discovery on a claimed ID to determine the OpenID provider endpoint.
*
* Discovery methods are provided by the hook_openid_discovery_method_info and
* could be further altered using the hook_openid_discovery_method_info_alter.
*
* @param $claimed_id
* The OpenID URL to perform discovery on.
*
* @return
* The resulting discovery array from the first successful discovery method,
* which must contain following keys:
* - 'services' (required) an array of discovered services (including OpenID
* version, endpoint URI, etc).
* - 'claimed_id' (optional) new claimed identifer, found by following HTTP
* redirects during the services discovery.
* If all the discovery method fails or if no appropriate discovery method is
* found, FALSE is returned.
*/
function openid_discovery($claimed_id) {
module_load_include('inc', 'openid');
$methods = module_invoke_all('openid_discovery_method_info');
drupal_alter('openid_discovery_method_info', $methods);
// Execute each method in turn and return first successful discovery.
foreach ($methods as $method) {
$discovery = $method($claimed_id);
if (!empty($discovery)) {
return $discovery;
}
}
return FALSE;
}
/**
* Implements hook_openid_discovery_method_info().
*
* Define standard discovery methods.
*/
function openid_openid_discovery_method_info() {
// The discovery process will stop as soon as one discovery method succeed.
// We first attempt to discover XRI-based identifiers, then standard XRDS
// identifiers via Yadis and HTML-based discovery, conforming to the OpenID 2.0
// specification.
return array(
'xri' => '_openid_xri_discovery',
'xrds' => '_openid_xrds_discovery',
);
}
/**
* OpenID discovery method: perform an XRI discovery.
*
* @see http://openid.net/specs/openid-authentication-2_0.html#discovery
* @see hook_openid_discovery_method_info()
* @see openid_discovery()
*
* @return
* An array of discovered services and claimed identifier or NULL. See
* openid_discovery() for more specific information.
*/
function _openid_xri_discovery($claimed_id) {
if (_openid_is_xri($claimed_id)) {
// Resolve XRI using a proxy resolver (Extensible Resource Identifier (XRI)
// Resolution Version 2.0, section 11.2 and 14.3).
$xrds_url = variable_get('xri_proxy_resolver', 'http://xri.net/') . rawurlencode($claimed_id) . '?_xrd_r=application/xrds+xml';
$discovery = _openid_xrds_discovery($xrds_url);
if (!empty($discovery['services']) && is_array($discovery['services'])) {
foreach ($discovery['services'] as $i => &$service) {
$status = $service['xrd']->children(OPENID_NS_XRD)->Status;
if ($status && $status->attributes()->cid == 'verified') {
$service['claimed_id'] = openid_normalize((string)$service['xrd']->children(OPENID_NS_XRD)->CanonicalID);
}
else {
// Ignore service if the Canonical ID could not be verified.
unset($discovery['services'][$i]);
}
}
if (!empty($discovery['services'])) {
return $discovery;
}
}
}
}
/**
* OpenID discovery method: perform a XRDS discovery.
*
* @see http://openid.net/specs/openid-authentication-2_0.html#discovery
* @see hook_openid_discovery_method_info()
* @see openid_discovery()
*
* @return
* An array of discovered services and claimed identifier or NULL. See
* openid_discovery() for more specific information.
*/
function _openid_xrds_discovery($claimed_id) {
$services = array();
$xrds_url = $claimed_id;
$scheme = @parse_url($xrds_url, PHP_URL_SCHEME);
if ($scheme == 'http' || $scheme == 'https') {
// For regular URLs, try Yadis resolution first, then HTML-based discovery
$headers = array('Accept' => 'application/xrds+xml');
$result = drupal_http_request($xrds_url, array('headers' => $headers));
// Check for HTTP error and make sure, that we reach the target. If the
// maximum allowed redirects are exhausted, final destination URL isn't
// reached, but drupal_http_request() doesn't return any error.
// @todo Remove the check for 200 HTTP result code after the following issue
// will be fixed: http://drupal.org/node/1096890.
if (!isset($result->error) && $result->code == 200) {
// Replace the user-entered claimed_id if we received a redirect.
if (!empty($result->redirect_url)) {
$claimed_id = openid_normalize($result->redirect_url);
}
if (isset($result->headers['content-type']) && preg_match("/application\/xrds\+xml/", $result->headers['content-type'])) {
// Parse XML document to find URL
$services = _openid_xrds_parse($result->data);
}
else {
$xrds_url = NULL;
if (isset($result->headers['x-xrds-location'])) {
$xrds_url = $result->headers['x-xrds-location'];
}
else {
// Look for meta http-equiv link in HTML head
$xrds_url = _openid_meta_httpequiv('X-XRDS-Location', $result->data);
}
if (!empty($xrds_url)) {
$headers = array('Accept' => 'application/xrds+xml');
$xrds_result = drupal_http_request($xrds_url, array('headers' => $headers));
if (!isset($xrds_result->error)) {
$services = _openid_xrds_parse($xrds_result->data);
}
}
}
// Check for HTML delegation
if (count($services) == 0) {
// Look for 2.0 links
$uri = _openid_link_href('openid2.provider', $result->data);
$identity = _openid_link_href('openid2.local_id', $result->data);
$type = 'http://specs.openid.net/auth/2.0/signon';
// 1.x links
if (empty($uri)) {
$uri = _openid_link_href('openid.server', $result->data);
$identity = _openid_link_href('openid.delegate', $result->data);
$type = 'http://openid.net/signon/1.1';
}
if (!empty($uri)) {
$services[] = array(
'uri' => $uri,
'identity' => $identity,
'types' => array($type),
);
}
}
}
}
if (!empty($services)) {
return array(
'services' => $services,
'claimed_id' => $claimed_id,
);
}
}
/**
* Implements hook_openid_normalization_method_info().
*
* Define standard normalization methods.
*/
function openid_openid_normalization_method_info() {
// OpenID Authentication 2.0, section 7.2:
// If the User-supplied Identifier looks like an XRI, treat it as such;
// otherwise treat it as an HTTP URL.
return array(
'xri' => '_openid_xri_normalize',
'url' => '_openid_url_normalize',
);
}
/**
* Attempt to create a shared secret with the OpenID Provider.
*
* @param $op_endpoint URL of the OpenID Provider endpoint.
*
* @return $assoc_handle The association handle.
*/
function openid_association($op_endpoint) {
module_load_include('inc', 'openid');
// Remove Old Associations:
db_delete('openid_association')
->where('created + expires_in < :request_time', array(':request_time' => REQUEST_TIME))
->execute();
// Check to see if we have an association for this IdP already
$assoc_handle = db_query("SELECT assoc_handle FROM {openid_association} WHERE idp_endpoint_uri = :endpoint", array(':endpoint' => $op_endpoint))->fetchField();
if (empty($assoc_handle)) {
$mod = OPENID_DH_DEFAULT_MOD;
$gen = OPENID_DH_DEFAULT_GEN;
$r = _openid_dh_rand($mod);
$private = _openid_math_add($r, 1);
$public = _openid_math_powmod($gen, $private, $mod);
// If there is no existing association, then request one
$assoc_request = openid_association_request($public);
$assoc_message = _openid_encode_message(_openid_create_message($assoc_request));
$assoc_options = array(
'headers' => array('Content-Type' => 'application/x-www-form-urlencoded; charset=utf-8'),
'method' => 'POST',
'data' => $assoc_message,
);
$assoc_result = drupal_http_request($op_endpoint, $assoc_options);
if (isset($assoc_result->error)) {
return FALSE;
}
$assoc_response = _openid_parse_message($assoc_result->data);
if (isset($assoc_response['mode']) && $assoc_response['mode'] == 'error') {
return FALSE;
}
if ($assoc_response['session_type'] == 'DH-SHA1') {
$spub = _openid_dh_base64_to_long($assoc_response['dh_server_public']);
$enc_mac_key = base64_decode($assoc_response['enc_mac_key']);
$shared = _openid_math_powmod($spub, $private, $mod);
$assoc_response['mac_key'] = base64_encode(_openid_dh_xorsecret($shared, $enc_mac_key));
}
db_insert('openid_association')
->fields(array(
'idp_endpoint_uri' => $op_endpoint,
'session_type' => $assoc_response['session_type'],
'assoc_handle' => $assoc_response['assoc_handle'],
'assoc_type' => $assoc_response['assoc_type'],
'expires_in' => $assoc_response['expires_in'],
'mac_key' => $assoc_response['mac_key'],
'created' => REQUEST_TIME,
))
->execute();
$assoc_handle = $assoc_response['assoc_handle'];
}
return $assoc_handle;
}
/**
* Authenticate a user or attempt registration.
*
* @param $response Response values from the OpenID Provider.
*/
function openid_authentication($response) {
$identity = $response['openid.claimed_id'];
$account = user_external_load($identity);
// Tries to load user account if user_external_load fails due to possibly
// incompletely stored OpenID identifier in the authmap.
if (!isset($account->uid) && variable_get('openid_less_obtrusive_transition', FALSE)) {
module_load_include('inc', 'openid');
$account = _openid_invalid_openid_transition($identity, $response);
}
if (isset($account->uid)) {
if (!variable_get('user_email_verification', TRUE) || $account->login) {
// Check if user is blocked.
$state['values']['name'] = $account->name;
user_login_name_validate(array(), $state);
if (!form_get_errors()) {
// Load global $user and perform final login tasks.
$form_state['uid'] = $account->uid;
user_login_submit(array(), $form_state);
// Let other modules act on OpenID login
module_invoke_all('openid_response', $response, $account);
}
}
else {
drupal_set_message(t('You must validate your email address for this account before logging in via OpenID.'));
}
}
elseif (variable_get('user_register', USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL)) {
// Register new user.
// Save response for use in openid_form_user_register_form_alter().
$_SESSION['openid']['response'] = $response;
$form_state['values'] = array();
$form_state['values']['op'] = t('Create new account');
drupal_form_submit('user_register_form', $form_state);
if (!empty($form_state['user'])) {
module_invoke_all('openid_response', $response, $form_state['user']);
drupal_goto();
}
$messages = drupal_get_messages('error');
if (empty($form_state['values']['name']) || empty($form_state['values']['mail'])) {
// If the OpenID provider did not provide both a user name and an email
// address, ask the user to complete the registration manually instead of
// showing the error messages about the missing values generated by FAPI.
drupal_set_message(t('Complete the registration by filling out the form below. If you already have an account, you can log in now and add your OpenID under "My account".', array('@login' => url('user/login'))), 'warning');
}
else {
drupal_set_message(t('Account registration using the information provided by your OpenID provider failed due to the reasons listed below. Complete the registration by filling out the form below. If you already have an account, you can log in now and add your OpenID under "My account".', array('@login' => url('user/login'))), 'warning');
// Append form validation errors below the above warning.
foreach ($messages['error'] as $message) {
drupal_set_message($message, 'error');
}
}
// We were unable to register a valid new user. Redirect to the normal
// registration page and prefill with the values we received.
$destination = drupal_get_destination();
unset($_GET['destination']);
drupal_goto('user/register', array('query' => $destination));
}
else {
drupal_set_message(t('Only site administrators can create new user accounts.'), 'error');
}
drupal_goto();
}
function openid_association_request($public) {
module_load_include('inc', 'openid');
$request = array(
'openid.ns' => OPENID_NS_2_0,
'openid.mode' => 'associate',
'openid.session_type' => 'DH-SHA1',
'openid.assoc_type' => 'HMAC-SHA1'
);
if ($request['openid.session_type'] == 'DH-SHA1' || $request['openid.session_type'] == 'DH-SHA256') {
$cpub = _openid_dh_long_to_base64($public);
$request['openid.dh_consumer_public'] = $cpub;
}
return $request;
}
function openid_authentication_request($claimed_id, $identity, $return_to, $assoc_handle, $service) {
global $base_url;
module_load_include('inc', 'openid');
$request = array(
'openid.mode' => 'checkid_setup',
'openid.identity' => $identity,
'openid.assoc_handle' => $assoc_handle,
'openid.return_to' => $return_to,
);
if ($service['version'] == 2) {
$request['openid.ns'] = OPENID_NS_2_0;
$request['openid.claimed_id'] = $claimed_id;
$request['openid.realm'] = $base_url .'/';
}
else {
$request['openid.trust_root'] = $base_url .'/';
}
// Always request Simple Registration. The specification doesn't mandate
// that the Endpoint advertise OPENID_NS_SREG in the service description.
$request['openid.ns.sreg'] = OPENID_NS_SREG;
$request['openid.sreg.required'] = 'nickname,email';
// Request Attribute Exchange, if available.
// We only request the minimum attributes we need here, contributed modules
// can alter the request to add more attribute, and map them to profile fields.
if (in_array(OPENID_NS_AX, $service['types'])) {
$request['openid.ns.ax'] = OPENID_NS_AX;
$request['openid.ax.mode'] = 'fetch_request';
$request['openid.ax.required'] = 'mail_ao,name_ao,mail_son,name_son';
// Implementors disagree on which URIs to use, even for simple
// attributes like name and email (*sigh*). We ask for both axschema.org
// attributes (which are supposed to be newer), and schema.openid.net ones
// (which are supposed to be legacy).
// Attributes as defined by axschema.org.
$request['openid.ax.type.mail_ao'] = 'http://axschema.org/contact/email';
$request['openid.ax.type.name_ao'] = 'http://axschema.org/namePerson/friendly';
// Attributes as defined by schema.openid.net.
$request['openid.ax.type.mail_son'] = 'http://schema.openid.net/contact/email';
$request['openid.ax.type.name_son'] = 'http://schema.openid.net/namePerson/friendly';
}
$request = array_merge($request, module_invoke_all('openid', 'request', $request));
// module_invoke_all() uses array_merge_recursive() which might return nested
// arrays if two or more modules alter a given parameter, resulting in an
// invalid request format. To ensure this doesn't happen, we flatten the returned
// value by taking the last entry in the array if an array is returned.
$flattened_request = array();
foreach ($request as $key => $value) {
if (is_array($value)) {
$flattened_request[$key] = end($value);
}
else {
$flattened_request[$key] = $value;
}
}
return $flattened_request;
}
/**
* Attempt to verify the response received from the OpenID Provider.
*
* @param $service
* Array describing the OpenID provider.
* @param $response
* Array of response values from the provider.
*
* @return boolean
* @see http://openid.net/specs/openid-authentication-2_0.html#rfc.section.11.4
*/
function openid_verify_assertion($service, $response) {
module_load_include('inc', 'openid');
// http://openid.net/specs/openid-authentication-2_0.html#rfc.section.11.3
// Check the Nonce to protect against replay attacks.
if (!openid_verify_assertion_nonce($service, $response)) {
return FALSE;
}
// http://openid.net/specs/openid-authentication-2_0.html#rfc.section.11.1
// Verifying the return URL.
if (!openid_verify_assertion_return_url($service, $response)) {
return FALSE;
}
// http://openid.net/specs/openid-authentication-2_0.html#rfc.section.11.4
// Verify the signatures.
$valid = FALSE;
$association = FALSE;
// If the OP returned a openid.invalidate_handle, we have to proceed with
// direct verification: ignore the openid.assoc_handle, even if present.
// See http://openid.net/specs/openid-authentication-2_0.html#rfc.section.11.4.1
if (!empty($response['openid.assoc_handle']) && empty($response['openid.invalidate_handle'])) {
$association = db_query("SELECT * FROM {openid_association} WHERE idp_endpoint_uri = :endpoint AND assoc_handle = :assoc_handle", array(':endpoint' => $service['uri'], ':assoc_handle' => $response['openid.assoc_handle']))->fetchObject();
}
if ($association && isset($association->session_type)) {
// http://openid.net/specs/openid-authentication-2_0.html#rfc.section.11.4.2
// Verification using an association.
$valid = openid_verify_assertion_signature($service, $association, $response);
}
else {
// http://openid.net/specs/openid-authentication-2_0.html#rfc.section.11.4.2
// Direct verification.
// The verification requests contain all the fields from the response,
// except openid.mode.
$request = $response;
$request['openid.mode'] = 'check_authentication';
$message = _openid_create_message($request);
$options = array(
'headers' => array('Content-Type' => 'application/x-www-form-urlencoded; charset=utf-8'),
'method' => 'POST',
'data' => _openid_encode_message($message),
);
$result = drupal_http_request($service['uri'], $options);
if (!isset($result->error)) {
$response = _openid_parse_message($result->data);
if (strtolower(trim($response['is_valid'])) == 'true') {
$valid = TRUE;
if (!empty($response['invalidate_handle'])) {
// This association handle has expired on the OP side, remove it from the
// database to avoid reusing it again on a subsequent authentication request.
// See http://openid.net/specs/openid-authentication-2_0.html#rfc.section.11.4.2.2
db_delete('openid_association')
->condition('idp_endpoint_uri', $service['uri'])
->condition('assoc_handle', $response['invalidate_handle'])
->execute();
}
}
else {
$valid = FALSE;
}
}
}
return $valid;
}
/**
* Verify the signature of the response received from the OpenID provider.
*
* @param $service
* Array describing the OpenID provider.
* @param $association
* Information on the association with the OpenID provider.
* @param $response
* Array of response values from the provider.
*
* @return
* TRUE if the signature is valid and covers all fields required to be signed.
* @see http://openid.net/specs/openid-authentication-2_0.html#rfc.section.11.4
*/
function openid_verify_assertion_signature($service, $association, $response) {
if ($service['version'] == 2) {
// OpenID Authentication 2.0, section 10.1:
// These keys must always be signed.
$mandatory_keys = array('op_endpoint', 'return_to', 'response_nonce', 'assoc_handle');
if (isset($response['openid.claimed_id'])) {
// If present, these two keys must also be signed. According to the spec,
// they are either both present or both absent.
$mandatory_keys[] = 'claimed_id';
$mandatory_keys[] = 'identity';
}
}
else {
// OpenID Authentication 1.1. section 4.3.3.
$mandatory_keys = array('identity', 'return_to');
}
$keys_to_sign = explode(',', $response['openid.signed']);
if (count(array_diff($mandatory_keys, $keys_to_sign)) > 0) {
return FALSE;
}
return _openid_signature($association, $response, $keys_to_sign) === $response['openid.sig'];
}
/**
* Verify that the nonce has not been used in earlier assertions from the same OpenID provider.
*
* @param $service
* Array describing the OpenID provider.
* @param $response
* Array of response values from the provider.
*
* @return
* TRUE if the nonce has not expired and has not been used earlier.
*/
function openid_verify_assertion_nonce($service, $response) {
if ($service['version'] != 2) {
return TRUE;
}
if (preg_match('/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})Z/', $response['openid.response_nonce'], $matches)) {
list(, $year, $month, $day, $hour, $minutes, $seconds) = $matches;
$nonce_timestamp = gmmktime($hour, $minutes, $seconds, $month, $day, $year);
}
else {
watchdog('openid', 'Nonce from @endpoint rejected because it is not correctly formatted, nonce: @nonce.', array('@endpoint' => $service['uri'], '@nonce' => $response['openid.response_nonce']), WATCHDOG_WARNING);
return FALSE;
}
// A nonce with a timestamp to far in the past or future will already have
// been removed and cannot be checked for single use anymore.
$time = time();
$expiry = 900;
if ($nonce_timestamp <= $time - $expiry || $nonce_timestamp >= $time + $expiry) {
watchdog('openid', 'Nonce received from @endpoint is out of range (time difference: @intervals). Check possible clock skew.', array('@endpoint' => $service['uri'], '@interval' => $time - $nonce_timestamp), WATCHDOG_WARNING);
return FALSE;
}
// Record that this nonce was used.
db_insert('openid_nonce')
->fields(array(
'idp_endpoint_uri' => $service['uri'],
'nonce' => $response['openid.response_nonce'],
'expires' => $nonce_timestamp + $expiry,
))
->execute();
// Count the number of times this nonce was used.
$count_used = db_query("SELECT COUNT(*) FROM {openid_nonce} WHERE nonce = :nonce AND idp_endpoint_uri = :idp_endpoint_uri", array(
':nonce' => $response['openid.response_nonce'],
':idp_endpoint_uri' => $service['uri'],
))->fetchField();
if ($count_used == 1) {
return TRUE;
}
else {
watchdog('openid', 'Nonce replay attempt blocked from @ip, nonce: @nonce.', array('@ip' => ip_address(), '@nonce' => $response['openid.response_nonce']), WATCHDOG_CRITICAL);
return FALSE;
}
}
/**
* Verify that openid.return_to matches the current URL.
*
* See OpenID Authentication 2.0, section 11.1. While OpenID Authentication
* 1.1, section 4.3 does not mandate return_to verification, the received
* return_to should still match these constraints.
*
* @param $service
* Array describing the OpenID provider.
* @param $response
* Array of response values from the provider.
*
* @return
* TRUE if return_to is valid, FALSE otherwise.
*/
function openid_verify_assertion_return_url($service, $response) {
global $base_url;
$return_to_parts = parse_url($response['openid.return_to']);
$base_url_parts = parse_url($base_url);
$current_parts = parse_url($base_url_parts['scheme'] .'://'. $base_url_parts['host'] . request_uri());
if ($return_to_parts['scheme'] != $current_parts['scheme'] || $return_to_parts['host'] != $current_parts['host'] || $return_to_parts['path'] != $current_parts['path']) {
return FALSE;
}
// Verify that all query parameters in the openid.return_to URL have
// the same value in the current URL. In addition, the current URL
// contains a number of other parameters added by the OpenID Provider.
parse_str(isset($return_to_parts['query']) ? $return_to_parts['query'] : '', $return_to_query_parameters);
foreach ($return_to_query_parameters as $name => $value) {
if (!isset($_GET[$name]) || $_GET[$name] != $value) {
return FALSE;
}
}
return TRUE;
}
/**
* Remove expired nonces from the database.
*
* Implements hook_cron().
*/
function openid_cron() {
db_delete('openid_nonce')
->condition('expires', REQUEST_TIME, '<')
->execute();
}
fields(array(
'uid' => $account->uid,
'authname' => $identity,
'module' => 'openid',
))
->execute();
drupal_set_message(t('Successfully added %identity', array('%identity' => $identity)));
}
$header = array(t('OpenID'), t('Operations'));
$rows = array();
$result = db_query("SELECT * FROM {authmap} WHERE module='openid' AND uid=:uid", array(':uid' => $account->uid));
foreach ($result as $identity) {
$rows[] = array(check_plain($identity->authname), l(t('Delete'), 'user/' . $account->uid . '/openid/delete/' . $identity->aid));
}
$build['openid_table'] = array(
'#theme' => 'table',
'#header' => $header,
'#rows' => $rows,
'#empty' => t('No OpenID identities available for this account.'),
);
$build['openid_user_add'] = drupal_get_form('openid_user_add');
return $build;
}
/**
* Form builder; Add an OpenID identity.
*
* @ingroup forms
* @see openid_user_add_validate()
*/
function openid_user_add() {
$form['openid_identifier'] = array(
'#type' => 'textfield',
'#title' => t('OpenID'),
);
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array('#type' => 'submit', '#value' => t('Add an OpenID'));
return $form;
}
function openid_user_add_validate($form, &$form_state) {
// Check for existing entries.
$claimed_id = openid_normalize($form_state['values']['openid_identifier']);
if (db_query("SELECT authname FROM {authmap} WHERE authname = :authname", (array(':authname' => $claimed_id)))->fetchField()) {
form_set_error('openid_identifier', t('That OpenID is already in use on this site.'));
}
}
function openid_user_add_submit($form, &$form_state) {
$return_to = url('user/' . arg(1) . '/openid', array('absolute' => TRUE));
openid_begin($form_state['values']['openid_identifier'], $return_to);
}
/**
* Menu callback; Delete the specified OpenID identity from the system.
*/
function openid_user_delete_form($form, $form_state, $account, $aid = 0) {
$authname = db_query("SELECT authname FROM {authmap} WHERE uid = :uid AND aid = :aid AND module = 'openid'", array(
':uid' => $account->uid,
':aid' => $aid,
))
->fetchField();
return confirm_form(array(), t('Are you sure you want to delete the OpenID %authname for %user?', array('%authname' => $authname, '%user' => $account->name)), 'user/' . $account->uid . '/openid');
}
function openid_user_delete_form_submit($form, &$form_state) {
$query = db_delete('authmap')
->condition('uid', $form_state['build_info']['args'][0]->uid)
->condition('aid', $form_state['build_info']['args'][1])
->condition('module', 'openid')
->execute();
if ($query) {
drupal_set_message(t('OpenID deleted.'));
}
$form_state['redirect'] = 'user/' . $form_state['build_info']['args'][0]->uid . '/openid';
}
$identity);
$this->drupalPost('', $edit, t('Log in'));
// Check we are on the OpenID redirect form.
$this->assertTitle(t('OpenID redirect'), 'OpenID redirect page was displayed.');
// Submit form to the OpenID Provider Endpoint.
$this->drupalPost(NULL, array(), t('Send'));
}
/**
* Parses the last sent e-mail and returns the one-time login link URL.
*/
function getPasswordResetURLFromMail() {
$mails = $this->drupalGetMails();
$mail = end($mails);
preg_match('@.+user/reset/.+@', $mail['body'], $matches);
return $matches[0];
}
}
/**
* Test discovery and login using OpenID
*/
class OpenIDFunctionalTestCase extends OpenIDWebTestCase {
protected $web_user;
public static function getInfo() {
return array(
'name' => 'OpenID discovery and login',
'description' => "Adds an identity to a user's profile and uses it to log in.",
'group' => 'OpenID'
);
}
function setUp() {
parent::setUp('openid', 'openid_test');
// User doesn't need special permissions; only the ability to log in.
$this->web_user = $this->drupalCreateUser(array());
}
/**
* Test discovery of OpenID Provider Endpoint via Yadis and HTML.
*/
function testDiscovery() {
$this->drupalLogin($this->web_user);
// The User-supplied Identifier entered by the user may indicate the URL of
// the OpenID Provider Endpoint in various ways, as described in OpenID
// Authentication 2.0 and Yadis Specification 1.0.
// Note that all of the tested identifiers refer to the same endpoint, so
// only the first will trigger an associate request in openid_association()
// (association is only done the first time Drupal encounters a given
// endpoint).
// Yadis discovery (see Yadis Specification 1.0, section 6.2.5):
// If the User-supplied Identifier is a URL, it may be a direct or indirect
// reference to an XRDS document (a Yadis Resource Descriptor) that contains
// the URL of the OpenID Provider Endpoint.
// Identifier is the URL of an XRDS document.
// On HTTP test environments, the URL scheme is stripped in order to test
// that the supplied identifier is normalized in openid_begin().
$identity = url('openid-test/yadis/xrds', array('absolute' => TRUE));
$this->addIdentity(preg_replace('@^http://@', '', $identity), 2, 'http://example.com/xrds', $identity);
$identity = url('openid-test/yadis/xrds/delegate', array('absolute' => TRUE));
$this->addIdentity(preg_replace('@^http://@', '', $identity), 2, 'http://example.com/xrds-delegate', $identity);
// Identifier is the URL of an XRDS document containing an OP Identifier
// Element. The Relying Party sends the special value
// "http://specs.openid.net/auth/2.0/identifier_select" as Claimed
// Identifier. The OpenID Provider responds with the actual identifier
// including the fragment.
$identity = url('openid-test/yadis/xrds/dummy-user', array('absolute' => TRUE, 'fragment' => $this->randomName()));
// Tell openid_test.module to respond with this identifier. If the fragment
// part is present in the identifier, it should be retained.
variable_set('openid_test_response', array('openid.claimed_id' => $identity, 'openid.identity' => openid_normalize($identity)));
$this->addIdentity(url('openid-test/yadis/xrds/server', array('absolute' => TRUE)), 2, 'http://specs.openid.net/auth/2.0/identifier_select', $identity);
variable_set('openid_test_response', array());
// Identifier is the URL of an HTML page that is sent with an HTTP header
// that contains the URL of an XRDS document.
$this->addIdentity(url('openid-test/yadis/x-xrds-location', array('absolute' => TRUE)), 2);
// Identifier is the URL of an HTML page containing a log in now and add your OpenID under "My account".', array('@login' => url('user/login'))), 'User was asked to complete the registration process manually.');
$this->assertRaw(t('The name %name is already taken.', array('%name' => $web_user->name)), 'Form validation error for username was displayed.');
$this->assertRaw(t('The e-mail address %mail is not valid.', array('%mail' => 'mail@invalid#')), 'Form validation error for e-mail address was displayed.');
// Enter username and e-mail address manually.
$edit = array('name' => 'john', 'mail' => 'john@example.com');
$this->drupalPost(NULL, $edit, t('Create new account'));
$this->assertRaw(t('Once you have verified your e-mail address, you may log in via OpenID.'), 'User was asked to verify e-mail address.');
$reset_url = $this->getPasswordResetURLFromMail();
$user = user_load_by_name('john');
$this->assertTrue($user, 'User was registered with right username.');
$this->assertFalse($user->data, 'No additional user info was saved.');
// Follow the one-time login that was sent in the welcome e-mail.
$this->drupalGet($reset_url);
$this->drupalPost(NULL, array(), t('Log in'));
// The user is taken to user/%uid/edit.
$this->assertFieldByName('mail', 'john@example.com', 'User was registered with right e-mail address.');
$this->clickLink(t('OpenID identities'));
$this->assertRaw($identity, 'OpenID identity was registered.');
}
/**
* Test OpenID auto-registration with a provider that does not supply SREG
* information (i.e. no username or e-mail address).
*/
function testRegisterUserWithoutSreg() {
// Load the front page to get the user login block.
$this->drupalGet('');
// Use a User-supplied Identity that is the URL of an XRDS document.
$identity = url('openid-test/yadis/xrds', array('absolute' => TRUE));
$this->submitLoginForm($identity);
$this->assertRaw(t('Complete the registration by filling out the form below. If you already have an account, you can log in now and add your OpenID under "My account".', array('@login' => url('user/login'))), 'User was asked to complete the registration process manually.');
$this->assertNoRaw(t('You must enter a username.'), 'Form validation error for username was not displayed.');
$this->assertNoRaw(t('You must enter an e-mail address.'), 'Form validation error for e-mail address was not displayed.');
// Enter username and e-mail address manually.
$edit = array('name' => 'john', 'mail' => 'john@example.com');
$this->drupalPost(NULL, $edit, t('Create new account'));
$this->assertRaw(t('Once you have verified your e-mail address, you may log in via OpenID.'), 'User was asked to verify e-mail address.');
$reset_url = $this->getPasswordResetURLFromMail();
$user = user_load_by_name('john');
$this->assertTrue($user, 'User was registered with right username.');
$this->assertFalse($user->data, 'No additional user info was saved.');
// Follow the one-time login that was sent in the welcome e-mail.
$this->drupalGet($reset_url);
$this->drupalPost(NULL, array(), t('Log in'));
// The user is taken to user/%uid/edit.
$this->assertFieldByName('mail', 'john@example.com', 'User was registered with right e-mail address.');
$this->clickLink(t('OpenID identities'));
$this->assertRaw($identity, 'OpenID identity was registered.');
}
/**
* Test OpenID auto-registration with a provider that supplies AX information,
* but no SREG.
*/
function testRegisterUserWithAXButNoSREG() {
variable_set('user_email_verification', FALSE);
// Tell openid_test.module to respond with these AX fields.
variable_set('openid_test_response', array(
'openid.ns.ext123' => 'http://openid.net/srv/ax/1.0',
'openid.ext123.type.mail456' => 'http://axschema.org/contact/email',
'openid.ext123.value.mail456' => 'john@example.com',
'openid.ext123.type.name789' => 'http://schema.openid.net/namePerson/friendly',
'openid.ext123.count.name789' => '1',
'openid.ext123.value.name789.1' => 'john',
));
// Use a User-supplied Identity that is the URL of an XRDS document.
$identity = url('openid-test/yadis/xrds', array('absolute' => TRUE));
$this->submitLoginForm($identity);
$this->assertLink(t('Log out'), 0, 'User was logged in.');
$user = user_load_by_name('john');
$this->assertTrue($user, 'User was registered with right username.');
$this->assertEqual($user->mail, 'john@example.com', 'User was registered with right email address.');
}
}
/**
* Test account registration using Simple Registration and Attribute Exchange.
*/
class OpenIDInvalidIdentifierTransitionTestCase extends OpenIDFunctionalTestCase {
public static function getInfo() {
return array(
'name' => 'OpenID account update',
'description' => 'Tries to correct OpenID identifiers attached to accounts if their identifiers were stripped.',
'group' => 'OpenID',
);
}
function setUp() {
parent::setUp('openid', 'openid_test');
variable_set('user_register', USER_REGISTER_VISITORS);
variable_set('openid_less_obtrusive_transition', TRUE);
}
/**
* Test OpenID transition with e-mail mismatch.
*/
function testStrippedFragmentAccountEmailMismatch() {
$this->drupalLogin($this->web_user);
// Use a User-supplied Identity that is the URL of an XRDS document.
$identity = url('openid-test/yadis/xrds', array('absolute' => TRUE, 'fragment' => $this->randomName()));
$identity_stripped = preg_replace('/#.*/', '', $identity);
// Add invalid identifier to the authmap (identifier has stripped fragment).
$this->addIdentity($identity_stripped);
$this->drupalLogout();
// Test logging in via the login form, provider will respond with full
// identifier (including fragment) but with different email, so we can't
// provide auto-update.
variable_set('openid_test_response', array(
'openid.claimed_id' => $identity,
'openid.sreg.nickname' => $this->web_user->name,
'openid.sreg.email' => 'invalid-' . $this->web_user->mail));
$edit = array('openid_identifier' => $identity_stripped);
$this->submitLoginForm($identity_stripped);
// Verify user was redirected away from user login to an accessible page.
$this->assertResponse(200);
// Verify the message.
$this->assertRaw(t('There is already an existing account associated with the OpenID identifier that you have provided.'), 'Message that OpenID identifier must be updated manually was displayed.');
}
/**
* Test OpenID auto transition with e-mail.
*/
function testStrippedFragmentAccountAutoUpdateSreg() {
$this->drupalLogin($this->web_user);
// Use a User-supplied Identity that is the URL of an XRDS document.
$identity = url('openid-test/yadis/xrds', array('absolute' => TRUE, 'fragment' => $this->randomName()));
$identity_stripped = preg_replace('/#.*/', '', $identity);
// Add invalid identifier to the authmap (identifier has stripped fragment).
$this->addIdentity($identity_stripped);
$this->drupalLogout();
// Test logging in via the login form, provider will respond with full
// identifier (including fragment) but with different email, so we can't
// provide auto-update.
variable_set('openid_test_response', array(
'openid.claimed_id' => $identity,
'openid.sreg.nickname' => $this->web_user->name,
'openid.sreg.email' => $this->web_user->mail));
$this->submitLoginForm($identity_stripped);
// Verify user was redirected away from user login to an accessible page.
$this->assertResponse(200);
// Verify the message.
$this->assertRaw(t('New OpenID identifier %identity was added as a replacement for invalid identifier %invalid_identity.', array('%invalid_identity' => $identity_stripped, '%identity' => $identity)), 'Message that OpenID identifier was added automatically was displayed.');
}
}
/**
* Test internal helper functions.
*/
class OpenIDTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'OpenID helper functions',
'description' => 'Test OpenID helper functions.',
'group' => 'OpenID'
);
}
function setUp() {
parent::setUp('openid');
module_load_include('inc', 'openid');
}
/**
* Test _openid_dh_XXX_to_XXX() functions.
*/
function testConversion() {
$this->assertIdentical(_openid_dh_long_to_base64('12345678901234567890123456789012345678901234567890'), 'CHJ/Y2mq+DyhUCZ0evjH8ZbOPwrS', '_openid_dh_long_to_base64() returned expected result.');
$this->assertIdentical(_openid_dh_base64_to_long('BsH/g8Nrpn2dtBSdu/sr1y8hxwyx'), '9876543210987654321098765432109876543210987654321', '_openid_dh_base64_to_long() returned expected result.');
$this->assertIdentical(_openid_dh_long_to_binary('12345678901234567890123456789012345678901234567890'), "\x08r\x7fci\xaa\xf8<\xa1P&tz\xf8\xc7\xf1\x96\xce?\x0a\xd2", '_openid_dh_long_to_binary() returned expected result.');
$this->assertIdentical(_openid_dh_binary_to_long("\x06\xc1\xff\x83\xc3k\xa6}\x9d\xb4\x14\x9d\xbb\xfb+\xd7/!\xc7\x0c\xb1"), '9876543210987654321098765432109876543210987654321', '_openid_dh_binary_to_long() returned expected result.');
}
/**
* Test _openid_dh_xorsecret().
*/
function testOpenidDhXorsecret() {
$this->assertEqual(_openid_dh_xorsecret('123456790123456790123456790', "abc123ABC\x00\xFF"), "\xa4'\x06\xbe\xf1.\x00y\xff\xc2\xc1", '_openid_dh_xorsecret() returned expected result.');
}
/**
* Test _openid_signature().
*/
function testOpenidSignature() {
// Test that signature is calculated according to OpenID Authentication 2.0,
// section 6.1. In the following array, only the two first entries should be
// included in the calculation, because the substring following the period
// is mentioned in the third argument for _openid_signature(). The last
// entry should not be included, because it does not start with "openid.".
$response = array(
'openid.foo' => 'abc1',
'openid.bar' => 'abc2',
'openid.baz' => 'abc3',
'foobar.foo' => 'abc4',
);
$association = new stdClass();
$association->mac_key = "1234567890abcdefghij\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\xF0\xF1\xF2\xF3\xF4\xF5\xF6\xF7\xF8\xF9";
$this->assertEqual(_openid_signature($association, $response, array('foo', 'bar')), 'QnKZQzSFstT+GNiJDFOptdcZjrc=', 'Expected signature calculated.');
}
/**
* Test _openid_is_xri().
*/
function testOpenidXRITest() {
// Test that the XRI test is according to OpenID Authentication 2.0,
// section 7.2. If the user-supplied string starts with xri:// it should be
// stripped and the resulting string should be treated as an XRI when it
// starts with "=", "@", "+", "$", "!" or "(".
$this->assertTrue(_openid_is_xri('xri://=foo'), '_openid_is_xri() returned expected result for an xri identifier with xri scheme.');
$this->assertTrue(_openid_is_xri('xri://@foo'), '_openid_is_xri() returned expected result for an xri identifier with xri scheme.');
$this->assertTrue(_openid_is_xri('xri://+foo'), '_openid_is_xri() returned expected result for an xri identifier with xri scheme.');
$this->assertTrue(_openid_is_xri('xri://$foo'), '_openid_is_xri() returned expected result for an xri identifier with xri scheme.');
$this->assertTrue(_openid_is_xri('xri://!foo'), '_openid_is_xri() returned expected result for an xri identifier with xri scheme..');
$this->assertTrue(_openid_is_xri('xri://(foo'), '_openid_is_xri() returned expected result for an xri identifier with xri scheme..');
$this->assertTrue(_openid_is_xri('=foo'), '_openid_is_xri() returned expected result for an xri identifier.');
$this->assertTrue(_openid_is_xri('@foo'), '_openid_is_xri() returned expected result for an xri identifier.');
$this->assertTrue(_openid_is_xri('+foo'), '_openid_is_xri() returned expected result for an xri identifier.');
$this->assertTrue(_openid_is_xri('$foo'), '_openid_is_xri() returned expected result for an xri identifier.');
$this->assertTrue(_openid_is_xri('!foo'), '_openid_is_xri() returned expected result for an xri identifier.');
$this->assertTrue(_openid_is_xri('(foo'), '_openid_is_xri() returned expected result for an xri identifier.');
$this->assertFalse(_openid_is_xri('foo'), '_openid_is_xri() returned expected result for an http URL.');
$this->assertFalse(_openid_is_xri('xri://foo'), '_openid_is_xri() returned expected result for an http URL.');
$this->assertFalse(_openid_is_xri('http://foo/'), '_openid_is_xri() returned expected result for an http URL.');
$this->assertFalse(_openid_is_xri('http://example.com/'), '_openid_is_xri() returned expected result for an http URL.');
$this->assertFalse(_openid_is_xri('user@example.com/'), '_openid_is_xri() returned expected result for an http URL.');
$this->assertFalse(_openid_is_xri('http://user@example.com/'), '_openid_is_xri() returned expected result for an http URL.');
}
/**
* Test openid_normalize().
*/
function testOpenidNormalize() {
// Test that the normalization is according to OpenID Authentication 2.0,
// section 7.2 and 11.5.2.
$this->assertEqual(openid_normalize('$foo'), '$foo', 'openid_normalize() correctly normalized an XRI.');
$this->assertEqual(openid_normalize('xri://$foo'), '$foo', 'openid_normalize() correctly normalized an XRI with an xri:// scheme.');
$this->assertEqual(openid_normalize('example.com/'), 'http://example.com/', 'openid_normalize() correctly normalized a URL with a missing scheme.');
$this->assertEqual(openid_normalize('example.com'), 'http://example.com/', 'openid_normalize() correctly normalized a URL with a missing scheme and empty path.');
$this->assertEqual(openid_normalize('http://example.com'), 'http://example.com/', 'openid_normalize() correctly normalized a URL with an empty path.');
$this->assertEqual(openid_normalize('http://example.com/path'), 'http://example.com/path', 'openid_normalize() correctly normalized a URL with a path.');
$this->assertEqual(openid_normalize('http://example.com/path#fragment'), 'http://example.com/path', 'openid_normalize() correctly normalized a URL with a fragment.');
}
/**
* Test openid_extract_namespace().
*/
function testOpenidExtractNamespace() {
$response = array(
'openid.sreg.nickname' => 'john',
'openid.ns.ext1' => OPENID_NS_SREG,
'openid.ext1.nickname' => 'george',
'openid.ext1.email' => 'george@example.com',
'openid.ns.ext2' => 'http://example.com/ns/ext2',
'openid.ext2.foo' => '123',
'openid.ext2.bar' => '456',
'openid.signed' => 'sreg.nickname,ns.ext1,ext1.email,ext2.foo',
);
$values = openid_extract_namespace($response, 'http://example.com/ns/dummy', NULL, FALSE);
$this->assertEqual($values, array(), 'Nothing found for unused namespace.');
$values = openid_extract_namespace($response, 'http://example.com/ns/dummy', 'sreg', FALSE);
$this->assertEqual($values, array('nickname' => 'john'), 'Value found for fallback prefix.');
$values = openid_extract_namespace($response, OPENID_NS_SREG, 'sreg', FALSE);
$this->assertEqual($values, array('nickname' => 'george', 'email' => 'george@example.com'), 'Namespace takes precedence over fallback prefix.');
// ext1.email is signed, but ext1.nickname is not.
$values = openid_extract_namespace($response, OPENID_NS_SREG, 'sreg', TRUE);
$this->assertEqual($values, array('email' => 'george@example.com'), 'Unsigned namespaced fields ignored.');
$values = openid_extract_namespace($response, 'http://example.com/ns/ext2', 'sreg', FALSE);
$this->assertEqual($values, array('foo' => '123', 'bar' => '456'), 'Unsigned fields found.');
// ext2.foo and ext2.bar are ignored, because ns.ext2 is not signed. The
// fallback prefix is not used, because the namespace is specified.
$values = openid_extract_namespace($response, 'http://example.com/ns/ext2', 'sreg', TRUE);
$this->assertEqual($values, array(), 'Unsigned fields ignored.');
}
}
name = OpenID dummy provider
description = "OpenID provider used for testing."
package = Testing
version = VERSION
core = 7.x
dependencies[] = openid
hidden = TRUE
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
'XRDS service document',
'page callback' => 'openid_test_yadis_xrds',
'access callback' => TRUE,
'type' => MENU_CALLBACK,
);
$items['openid-test/yadis/x-xrds-location'] = array(
'title' => 'Yadis discovery using X-XRDS-Location header',
'page callback' => 'openid_test_yadis_x_xrds_location',
'access callback' => TRUE,
'type' => MENU_CALLBACK,
);
$items['openid-test/yadis/http-equiv'] = array(
'title' => 'Yadis discovery using
xri://@
http://example.com/user
http://example.com/this-is-ignored
http://openid.net/signon/1.0
http://example.com/this-is-only-openid-1.0
http://specs.openid.net/auth/2.0/signon
http://openid.net/srv/ax/1.0
' . url('openid-test/endpoint', array('absolute' => TRUE)) . '
http://example.com/xrds
http://specs.openid.net/auth/2.0/signon
http://example.com/this-has-too-low-priority
http://specs.openid.net/auth/2.0/signon
http://example.com/this-has-too-low-priority
';
if (arg(3) == 'server') {
print '
http://specs.openid.net/auth/2.0/server
http://example.com/this-has-too-low-priority
http://specs.openid.net/auth/2.0/server
' . url('openid-test/endpoint', array('absolute' => TRUE)) . '
' . url('openid-test/yadis/xrds/server', array('absolute' => TRUE)) . '
';
}
elseif (arg(3) == 'delegate') {
print '
http://specs.openid.net/auth/2.0/signon
http://openid.net/srv/ax/1.0
' . url('openid-test/endpoint', array('absolute' => TRUE)) . '
http://example.com/xrds-delegate
';
}
print '
';
}
else {
return t('This is a regular HTML page. If the client sends an Accept: application/xrds+xml header when requesting this URL, an XRDS document is returned.');
}
}
/**
* Menu callback; regular HTML page with an X-XRDS-Location HTTP header.
*/
function openid_test_yadis_x_xrds_location() {
drupal_add_http_header('X-XRDS-Location', url('openid-test/yadis/xrds', array('absolute' => TRUE)));
return t('This page includes an X-RDS-Location HTTP header containing the URL of an XRDS document.');
}
/**
* Menu callback; regular HTML page with
').appendTo(document.body);
var el2 = $('
').appendTo(el1);
Drupal.overlay.leftSidedScrollbarOffset = parseInt(el2[0].offsetLeft - el1[0].offsetLeft);
el1.remove();
}
}
// Consider any element that should be visible above the overlay (such as
// a toolbar).
$('.overlay-displace-top, .overlay-displace-bottom').each(function () {
var data = $(this).data();
var maxWidth = documentWidth;
// In IE, Shadow filter makes element to overlap the scrollbar with 1px.
if (this.filters && this.filters.length && this.filters.item('DXImageTransform.Microsoft.Shadow')) {
maxWidth -= 1;
}
if (Drupal.overlay.leftSidedScrollbarOffset) {
$(this).css('left', Drupal.overlay.leftSidedScrollbarOffset);
}
// Prevent displaced elements overlapping window's scrollbar.
var currentMaxWidth = parseInt($(this).css(maxWidthName));
if ((data.drupalOverlay && data.drupalOverlay.maxWidth) || isNaN(currentMaxWidth) || currentMaxWidth > maxWidth || currentMaxWidth <= 0) {
$(this).css(maxWidthName, maxWidth);
(data.drupalOverlay = data.drupalOverlay || {}).maxWidth = true;
}
// Use a more rigorous approach if the displaced element still overlaps
// window's scrollbar; clip the element on the right.
var offset = $(this).offset();
var offsetRight = offset.left + $(this).outerWidth();
if ((data.drupalOverlay && data.drupalOverlay.clip) || offsetRight > maxWidth) {
if (Drupal.overlay.leftSidedScrollbarOffset) {
$(this).css('clip', 'rect(auto, auto, ' + (documentHeight - offset.top) + 'px, ' + (Drupal.overlay.leftSidedScrollbarOffset + 2) + 'px)');
}
else {
$(this).css('clip', 'rect(auto, ' + (maxWidth - offset.left) + 'px, ' + (documentHeight - offset.top) + 'px, auto)');
}
(data.drupalOverlay = data.drupalOverlay || {}).clip = true;
}
});
};
/**
* Event handler: restores size of displaced elements as they were before
* overlay was opened.
*
* @param event
* Event being triggered, with the following restrictions:
* - event.type: any
* - event.currentTarget: any
*/
Drupal.overlay.eventhandlerRestoreDisplacedElements = function (event) {
var $displacedElements = $('.overlay-displace-top, .overlay-displace-bottom');
try {
$displacedElements.css({ maxWidth: '', clip: '' });
}
// IE bug that doesn't allow unsetting style.clip (http://dev.jquery.com/ticket/6512).
catch (err) {
$displacedElements.attr('style', function (index, attr) {
return attr.replace(/clip\s*:\s*rect\([^)]+\);?/i, '');
});
}
};
/**
* Event handler: overrides href of administrative links to be opened in
* the overlay.
*
* This click event handler should be bound to any document (for example the
* overlay iframe) of which you want links to open in the overlay.
*
* @param event
* Event being triggered, with the following restrictions:
* - event.type: click, mouseup
* - event.currentTarget: document
*
* @see Drupal.overlayChild.behaviors.addClickHandler
*/
Drupal.overlay.eventhandlerOverrideLink = function (event) {
// In some browsers the click event isn't fired for right-clicks. Use the
// mouseup event for right-clicks and the click event for everything else.
if ((event.type == 'click' && event.button == 2) || (event.type == 'mouseup' && event.button != 2)) {
return;
}
var $target = $(event.target);
// Only continue if clicked target (or one of its parents) is a link.
if (!$target.is('a')) {
$target = $target.closest('a');
if (!$target.length) {
return;
}
}
// Never open links in the overlay that contain the overlay-exclude class.
if ($target.hasClass('overlay-exclude')) {
return;
}
// Close the overlay when the link contains the overlay-close class.
if ($target.hasClass('overlay-close')) {
// Clearing the overlay URL fragment will close the overlay.
$.bbq.removeState('overlay');
return;
}
var target = $target[0];
var href = target.href;
// Only handle links that have an href attribute and use the HTTP(S) protocol.
if (href != undefined && href != '' && target.protocol.match(/^https?\:/)) {
var anchor = href.replace(target.ownerDocument.location.href, '');
// Skip anchor links.
if (anchor.length == 0 || anchor.charAt(0) == '#') {
return;
}
// Open admin links in the overlay.
else if (this.isAdminLink(href)) {
// If the link contains the overlay-restore class and the overlay-context
// state is set, also update the parent window's location.
var parentLocation = ($target.hasClass('overlay-restore') && typeof $.bbq.getState('overlay-context') == 'string')
? this.getInternalUrl($.bbq.getState('overlay-context'))
: null;
href = this.fragmentizeLink($target.get(0), parentLocation);
// Only override default behavior when left-clicking and user is not
// pressing the ALT, CTRL, META (Command key on the Macintosh keyboard)
// or SHIFT key.
if (event.button == 0 && !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
// Redirect to a fragmentized href. This will trigger a hashchange event.
this.redirect(href);
// Prevent default action and further propagation of the event.
return false;
}
// Otherwise alter clicked link's href. This is being picked up by
// the default action handler.
else {
$target
// Restore link's href attribute on blur or next click.
.one('blur mousedown', { target: target, href: target.href }, function (event) { $(event.data.target).attr('href', event.data.href); })
.attr('href', href);
}
}
// Non-admin links should close the overlay and open in the main window,
// which is the default action for a link. We only need to handle them
// if the overlay is open and the clicked link is inside the overlay iframe.
else if (this.isOpen && target.ownerDocument === this.iframeWindow.document) {
// Open external links in the immediate parent of the frame, unless the
// link already has a different target.
if (target.hostname != window.location.hostname) {
if (!$target.attr('target')) {
$target.attr('target', '_parent');
}
}
else {
// Add the overlay-context state to the link, so "overlay-restore" links
// can restore the context.
if ($target[0].hash) {
// Leave links with an existing fragment alone. Adding an extra
// parameter to a link like "node/1#section-1" breaks the link.
}
else {
// For links with no existing fragment, add the overlay context.
$target.attr('href', $.param.fragment(href, { 'overlay-context': this.getPath(window.location) + window.location.search }));
}
// When the link has a destination query parameter and that destination
// is an admin link we need to fragmentize it. This will make it reopen
// in the overlay.
var params = $.deparam.querystring(href);
if (params.destination && this.isAdminLink(params.destination)) {
var fragmentizedDestination = $.param.fragment(this.getPath(window.location), { overlay: params.destination });
$target.attr('href', $.param.querystring(href, { destination: fragmentizedDestination }));
}
// Make the link open in the immediate parent of the frame, unless the
// link already has a different target.
if (!$target.attr('target')) {
$target.attr('target', '_parent');
}
}
}
}
};
/**
* Event handler: opens or closes the overlay based on the current URL fragment.
*
* @param event
* Event being triggered, with the following restrictions:
* - event.type: hashchange
* - event.currentTarget: document
*/
Drupal.overlay.eventhandlerOperateByURLFragment = function (event) {
// If we changed the hash to reflect an internal redirect in the overlay,
// its location has already been changed, so don't do anything.
if ($.data(window.location, window.location.href) === 'redirect') {
$.data(window.location, window.location.href, null);
return;
}
// Get the overlay URL from the current URL fragment.
var internalUrl = null;
var state = $.bbq.getState('overlay');
if (state) {
internalUrl = this.getInternalUrl(state);
}
if (internalUrl) {
// Append render variable, so the server side can choose the right
// rendering and add child frame code to the page if needed.
var url = $.param.querystring(internalUrl, { render: 'overlay' });
this.open(url);
this.resetActiveClass(this.getPath(Drupal.settings.basePath + state));
}
// If there is no overlay URL in the fragment and the overlay is (still)
// open, close the overlay.
else if (this.isOpen && !this.isClosing) {
this.close();
this.resetActiveClass(this.getPath(window.location));
}
};
/**
* Event handler: makes sure the internal overlay URL is reflected in the parent
* URL fragment.
*
* Normally the parent URL fragment determines the overlay location. However, if
* the overlay redirects internally, the parent doesn't get informed, and the
* parent URL fragment will be out of date. This is a sanity check to make
* sure we're in the right place.
*
* The parent URL fragment is also not updated automatically when overlay's
* open, close or load functions are used directly (instead of through
* eventhandlerOperateByURLFragment).
*
* @param event
* Event being triggered, with the following restrictions:
* - event.type: drupalOverlayReady, drupalOverlayClose
* - event.currentTarget: document
*/
Drupal.overlay.eventhandlerSyncURLFragment = function (event) {
if (this.isOpen) {
var expected = $.bbq.getState('overlay');
// This is just a sanity check, so we're comparing paths, not query strings.
if (this.getPath(Drupal.settings.basePath + expected) != this.getPath(this.iframeWindow.document.location)) {
// There may have been a redirect inside the child overlay window that the
// parent wasn't aware of. Update the parent URL fragment appropriately.
var newLocation = Drupal.overlay.fragmentizeLink(this.iframeWindow.document.location);
// Set a 'redirect' flag on the new location so the hashchange event handler
// knows not to change the overlay's content.
$.data(window.location, newLocation, 'redirect');
// Use location.replace() so we don't create an extra history entry.
window.location.replace(newLocation);
}
}
else {
$.bbq.removeState('overlay');
}
};
/**
* Event handler: if the child window suggested that the parent refresh on
* close, force a page refresh.
*
* @param event
* Event being triggered, with the following restrictions:
* - event.type: drupalOverlayClose
* - event.currentTarget: document
*/
Drupal.overlay.eventhandlerRefreshPage = function (event) {
if (Drupal.overlay.refreshPage) {
window.location.reload(true);
}
};
/**
* Event handler: dispatches events to the overlay document.
*
* @param event
* Event being triggered, with the following restrictions:
* - event.type: any
* - event.currentTarget: any
*/
Drupal.overlay.eventhandlerDispatchEvent = function (event) {
if (this.iframeWindow && this.iframeWindow.document) {
this.iframeWindow.jQuery(this.iframeWindow.document).trigger(event);
}
};
/**
* Make a regular admin link into a URL that will trigger the overlay to open.
*
* @param link
* A JavaScript Link object (i.e. an element).
* @param parentLocation
* (optional) URL to override the parent window's location with.
*
* @return
* A URL that will trigger the overlay (in the form
* /node/1#overlay=admin/config).
*/
Drupal.overlay.fragmentizeLink = function (link, parentLocation) {
// Don't operate on links that are already overlay-ready.
var params = $.deparam.fragment(link.href);
if (params.overlay) {
return link.href;
}
// Determine the link's original destination. Set ignorePathFromQueryString to
// true to prevent transforming this link into a clean URL while clean URLs
// may be disabled.
var path = this.getPath(link, true);
// Preserve existing query and fragment parameters in the URL, except for
// "render=overlay" which is re-added in Drupal.overlay.eventhandlerOperateByURLFragment.
var destination = path + link.search.replace(/&?render=overlay/, '').replace(/\?$/, '') + link.hash;
// Assemble and return the overlay-ready link.
return $.param.fragment(parentLocation || window.location.href, { overlay: destination });
};
/**
* Refresh any regions of the page that are displayed outside the overlay.
*
* @param data
* An array of objects with information on the page regions to be refreshed.
* For each object, the key is a CSS class identifying the region to be
* refreshed, and the value represents the section of the Drupal $page array
* corresponding to this region.
*/
Drupal.overlay.refreshRegions = function (data) {
$.each(data, function () {
var region_info = this;
$.each(region_info, function (regionClass) {
var regionName = region_info[regionClass];
var regionSelector = '.' + regionClass;
// Allow special behaviors to detach.
Drupal.detachBehaviors($(regionSelector));
$.get(Drupal.settings.basePath + Drupal.settings.overlay.ajaxCallback + '/' + regionName, function (newElement) {
$(regionSelector).replaceWith($(newElement));
Drupal.attachBehaviors($(regionSelector), Drupal.settings);
});
});
});
};
/**
* Reset the active class on links in displaced elements according to
* given path.
*
* @param activePath
* Path to match links against.
*/
Drupal.overlay.resetActiveClass = function(activePath) {
var self = this;
var windowDomain = window.location.protocol + window.location.hostname;
$('.overlay-displace-top, .overlay-displace-bottom')
.find('a[href]')
// Remove active class from all links in displaced elements.
.removeClass('active')
// Add active class to links that match activePath.
.each(function () {
var linkDomain = this.protocol + this.hostname;
var linkPath = self.getPath(this);
// A link matches if it is part of the active trail of activePath, except
// for frontpage links.
if (linkDomain == windowDomain && (activePath + '/').indexOf(linkPath + '/') === 0 && (linkPath !== '' || activePath === '')) {
$(this).addClass('active');
}
});
};
/**
* Helper function to get the (corrected) Drupal path of a link.
*
* @param link
* Link object or string to get the Drupal path from.
* @param ignorePathFromQueryString
* Boolean whether to ignore path from query string if path appears empty.
*
* @return
* The Drupal path.
*/
Drupal.overlay.getPath = function (link, ignorePathFromQueryString) {
if (typeof link == 'string') {
// Create a native Link object, so we can use its object methods.
link = $(link.link(link)).get(0);
}
var path = link.pathname;
// Ensure a leading slash on the path, omitted in some browsers.
if (path.charAt(0) != '/') {
path = '/' + path;
}
path = path.replace(new RegExp(Drupal.settings.basePath + '(?:index.php)?'), '');
if (path == '' && !ignorePathFromQueryString) {
// If the path appears empty, it might mean the path is represented in the
// query string (clean URLs are not used).
var match = new RegExp('([?&])q=(.+)([&#]|$)').exec(link.search);
if (match && match.length == 4) {
path = match[2];
}
}
return path;
};
/**
* Get the total displacement of given region.
*
* @param region
* Region name. Either "top" or "bottom".
*
* @return
* The total displacement of given region in pixels.
*/
Drupal.overlay.getDisplacement = function (region) {
var displacement = 0;
var lastDisplaced = $('.overlay-displace-' + region + ':last');
if (lastDisplaced.length) {
displacement = lastDisplaced.offset().top + lastDisplaced.outerHeight();
// In modern browsers (including IE9), when box-shadow is defined, use the
// normal height.
var cssBoxShadowValue = lastDisplaced.css('box-shadow');
var boxShadow = (typeof cssBoxShadowValue !== 'undefined' && cssBoxShadowValue !== 'none');
// In IE8 and below, we use the shadow filter to apply box-shadow styles to
// the toolbar. It adds some extra height that we need to remove.
if (!boxShadow && /DXImageTransform\.Microsoft\.Shadow/.test(lastDisplaced.css('filter'))) {
displacement -= lastDisplaced[0].filters.item('DXImageTransform.Microsoft.Shadow').strength;
displacement = Math.max(0, displacement);
}
}
return displacement;
};
/**
* Makes elements outside the overlay unreachable via the tab key.
*
* @param context
* The part of the DOM that should have its tabindexes changed. Defaults to
* the entire page.
*/
Drupal.overlay.makeDocumentUntabbable = function (context) {
// Manipulating tabindexes for the entire document is unacceptably slow in IE6
// and IE7, so in those browsers, the underlying page will still be reachable
// via the tab key. However, we still make the links within the Disable
// message unreachable, because the same message also exists within the
// child document. The duplicate copy in the underlying document is only for
// assisting screen-reader users navigating the document with reading commands
// that follow markup order rather than tab order.
if (jQuery.browser.msie && parseInt(jQuery.browser.version, 10) < 8) {
$('#overlay-disable-message a', context).attr('tabindex', -1);
return;
}
context = context || document.body;
var $overlay, $tabbable, $hasTabindex;
// Determine which elements on the page already have a tabindex.
$hasTabindex = $('[tabindex] :not(.overlay-element)', context);
// Record the tabindex for each element, so we can restore it later.
$hasTabindex.each(Drupal.overlay._recordTabindex);
// Add the tabbable elements from the current context to any that we might
// have previously recorded.
Drupal.overlay._hasTabindex = $hasTabindex.add(Drupal.overlay._hasTabindex);
// Set tabindex to -1 on everything outside the overlay and toolbars, so that
// the underlying page is unreachable.
// By default, browsers make a, area, button, input, object, select, textarea,
// and iframe elements reachable via the tab key.
$tabbable = $('a, area, button, input, object, select, textarea, iframe');
// If another element (like a div) has a tabindex, it's also tabbable.
$tabbable = $tabbable.add($hasTabindex);
// Leave links inside the overlay and toolbars alone.
$overlay = $('.overlay-element, #overlay-container, .overlay-displace-top, .overlay-displace-bottom').find('*');
$tabbable = $tabbable.not($overlay);
// We now have a list of everything in the underlying document that could
// possibly be reachable via the tab key. Make it all unreachable.
$tabbable.attr('tabindex', -1);
};
/**
* Restores the original tabindex value of a group of elements.
*
* @param context
* The part of the DOM that should have its tabindexes restored. Defaults to
* the entire page.
*/
Drupal.overlay.makeDocumentTabbable = function (context) {
// Manipulating tabindexes is unacceptably slow in IE6 and IE7. In those
// browsers, the underlying page was never made unreachable via tab, so
// there is no work to be done here.
if (jQuery.browser.msie && parseInt(jQuery.browser.version, 10) < 8) {
return;
}
var $needsTabindex;
context = context || document.body;
// Make the underlying document tabbable again by removing all existing
// tabindex attributes.
var $tabindex = $('[tabindex]', context);
if (jQuery.browser.msie && parseInt(jQuery.browser.version, 10) < 8) {
// removeAttr('tabindex') is broken in IE6-7, but the DOM function
// removeAttribute works.
var i;
var length = $tabindex.length;
for (i = 0; i < length; i++) {
$tabindex[i].removeAttribute('tabIndex');
}
}
else {
$tabindex.removeAttr('tabindex');
}
// Restore the tabindex attributes that existed before the overlay was opened.
$needsTabindex = $(Drupal.overlay._hasTabindex, context);
$needsTabindex.each(Drupal.overlay._restoreTabindex);
Drupal.overlay._hasTabindex = Drupal.overlay._hasTabindex.not($needsTabindex);
};
/**
* Record the tabindex for an element, using $.data.
*
* Meant to be used as a jQuery.fn.each callback.
*/
Drupal.overlay._recordTabindex = function () {
var $element = $(this);
var tabindex = $(this).attr('tabindex');
$element.data('drupalOverlayOriginalTabIndex', tabindex);
};
/**
* Restore an element's original tabindex.
*
* Meant to be used as a jQuery.fn.each callback.
*/
Drupal.overlay._restoreTabindex = function () {
var $element = $(this);
var tabindex = $element.data('drupalOverlayOriginalTabIndex');
$element.attr('tabindex', tabindex);
};
/**
* Theme function to create the overlay iframe element.
*/
Drupal.theme.prototype.overlayContainer = function () {
return '';
};
/**
* Theme function to create an overlay iframe element.
*/
Drupal.theme.prototype.overlayElement = function (url) {
return '';
};
})(jQuery);
#overlay=admin/modules on hook_init().
$_SESSION['overlay_enable_redirect'] = 1;
}
}
' . t('About') . '';
$output .= '' . t('The Overlay module makes the administration pages on your site display in a JavaScript overlay of the page you were viewing when you clicked the administrative link, instead of replacing the page in your browser window. Use the close link on the overlay to return to the page you were viewing when you clicked the link. For more information, see the online handbook entry for Overlay module .', array('@overlay' => 'http://drupal.org/documentation/modules/overlay')) . '
';
return $output;
}
}
/**
* Implements hook_menu().
*/
function overlay_menu() {
$items['overlay-ajax/%'] = array(
'title' => '',
'page callback' => 'overlay_ajax_render_region',
'page arguments' => array(1),
'access arguments' => array('access overlay'),
'type' => MENU_CALLBACK,
);
$items['overlay/dismiss-message'] = array(
'title' => '',
'page callback' => 'overlay_user_dismiss_message',
'access arguments' => array('access overlay'),
'type' => MENU_CALLBACK,
);
return $items;
}
/**
* Implements hook_admin_paths().
*/
function overlay_admin_paths() {
$paths = array(
// This is marked as an administrative path so that if it is visited from
// within the overlay, the user will stay within the overlay while the
// callback is being processed.
'overlay/dismiss-message' => TRUE,
);
return $paths;
}
/**
* Implements hook_permission().
*/
function overlay_permission() {
return array(
'access overlay' => array(
'title' => t('Access the administrative overlay'),
'description' => t('View administrative pages in the overlay.'),
),
);
}
/**
* Implements hook_theme().
*/
function overlay_theme() {
return array(
'overlay' => array(
'render element' => 'page',
'template' => 'overlay',
),
'overlay_disable_message' => array(
'render element' => 'element',
),
);
}
/**
* Implements hook_form_alter().
*/
function overlay_form_alter(&$form, &$form_state) {
// Add a hidden element to prevent dropping out of the overlay when a form is
// submitted inside the overlay using a GET method.
if (isset($form['#method']) && $form['#method'] == 'get' && isset($_REQUEST['render']) && $_REQUEST['render'] == 'overlay' && !isset($form['render'])) {
$form['render'] = array(
'#type' => 'hidden',
'#value' => 'overlay',
);
}
}
/**
* Implements hook_form_FORM_ID_alter().
*/
function overlay_form_user_profile_form_alter(&$form, &$form_state) {
if ($form['#user_category'] == 'account') {
$account = $form['#user'];
if (user_access('access overlay', $account)) {
$form['overlay_control'] = array(
'#type' => 'fieldset',
'#title' => t('Administrative overlay'),
'#weight' => 4,
'#collapsible' => TRUE,
);
$form['overlay_control']['overlay'] = array(
'#type' => 'checkbox',
'#title' => t('Use the overlay for administrative pages.'),
'#description' => t('Show administrative pages on top of the page you started from.'),
'#default_value' => isset($account->data['overlay']) ? $account->data['overlay'] : 1,
);
}
}
}
/**
* Implements hook_user_presave().
*/
function overlay_user_presave(&$edit, $account, $category) {
if (isset($edit['overlay'])) {
$edit['data']['overlay'] = $edit['overlay'];
}
}
/**
* Implements hook_init().
*
* Determine whether the current page request is destined to appear in the
* parent window or in the overlay window, and format the page accordingly.
*
* @see overlay_set_mode()
*/
function overlay_init() {
global $user;
$mode = overlay_get_mode();
// Only act if the user has access to the overlay and a mode was not already
// set. Other modules can also enable the overlay directly for other uses.
$use_overlay = !isset($user->data['overlay']) || $user->data['overlay'];
if (empty($mode) && user_access('access overlay') && $use_overlay) {
$current_path = current_path();
// After overlay is enabled on the modules page, redirect to
// #overlay=admin/modules to actually enable the overlay.
if (isset($_SESSION['overlay_enable_redirect']) && $_SESSION['overlay_enable_redirect']) {
unset($_SESSION['overlay_enable_redirect']);
drupal_goto('', array('fragment' => 'overlay=' . $current_path));
}
if (isset($_GET['render']) && $_GET['render'] == 'overlay') {
// If a previous page requested that we close the overlay, close it and
// redirect to the final destination.
if (isset($_SESSION['overlay_close_dialog'])) {
call_user_func_array('overlay_close_dialog', $_SESSION['overlay_close_dialog']);
unset($_SESSION['overlay_close_dialog']);
}
// If this page shouldn't be rendered inside the overlay, redirect to the
// parent.
elseif (!path_is_admin($current_path)) {
// Prevent open redirects by ensuring the current path is not an absolute URL.
if (url_is_external($current_path)) {
$current_path = '';
}
overlay_close_dialog($current_path, array('query' => drupal_get_query_parameters(NULL, array('q', 'render'))));
}
// Indicate that we are viewing an overlay child page.
overlay_set_mode('child');
// Unset the render parameter to avoid it being included in URLs on the page.
unset($_GET['render']);
}
// Do not enable the overlay if we already are on an admin page.
elseif (!path_is_admin($current_path)) {
// Otherwise add overlay parent code and our behavior.
overlay_set_mode('parent');
}
}
}
/**
* Implements hook_exit().
*
* When viewing an overlay child page, check if we need to trigger a refresh of
* the supplemental regions of the overlay on the next page request.
*/
function overlay_exit() {
// Check that we are in an overlay child page. Note that this should never
// return TRUE on a cached page view, since the child mode is not set until
// overlay_init() is called.
if (overlay_get_mode() == 'child') {
// Load any markup that was stored earlier in the page request, via calls
// to overlay_store_rendered_content(). If none was stored, this is not a
// page request where we expect any changes to the overlay supplemental
// regions to have occurred, so we do not need to proceed any further.
$original_markup = overlay_get_rendered_content();
if (!empty($original_markup)) {
// Compare the original markup to the current markup that we get from
// rendering each overlay supplemental region now. If they don't match,
// something must have changed, so we request a refresh of that region
// within the parent window on the next page request.
foreach (overlay_supplemental_regions() as $region) {
if (!isset($original_markup[$region]) || $original_markup[$region] != overlay_render_region($region)) {
overlay_request_refresh($region);
}
}
}
}
}
/**
* Implements hook_library().
*/
function overlay_library() {
$module_path = drupal_get_path('module', 'overlay');
// Overlay parent.
$libraries['parent'] = array(
'title' => 'Overlay: Parent',
'website' => 'http://drupal.org/documentation/modules/overlay',
'version' => '1.0',
'js' => array(
$module_path . '/overlay-parent.js' => array(),
),
'css' => array(
$module_path . '/overlay-parent.css' => array(),
),
'dependencies' => array(
array('system', 'ui'),
array('system', 'jquery.bbq'),
),
);
// Overlay child.
$libraries['child'] = array(
'title' => 'Overlay: Child',
'website' => 'http://drupal.org/documentation/modules/overlay',
'version' => '1.0',
'js' => array(
$module_path . '/overlay-child.js' => array(),
),
'css' => array(
$module_path . '/overlay-child.css' => array(),
),
);
return $libraries;
}
/**
* Implements hook_drupal_goto_alter().
*/
function overlay_drupal_goto_alter(&$path, &$options, &$http_response_code) {
if (overlay_get_mode() == 'child') {
// The authorize.php script bootstraps Drupal to a very low level, where
// the PHP code that is necessary to close the overlay properly will not be
// loaded. Therefore, if we are redirecting to authorize.php inside the
// overlay, instead redirect back to the current page with instructions to
// close the overlay there before redirecting to the final destination; see
// overlay_init().
if ($path == system_authorized_get_url() || $path == system_authorized_batch_processing_url()) {
$_SESSION['overlay_close_dialog'] = array($path, $options);
$path = current_path();
$options = drupal_get_query_parameters();
}
// If the current page request is inside the overlay, add ?render=overlay
// to the new path, so that it appears correctly inside the overlay.
if (isset($options['query'])) {
$options['query'] += array('render' => 'overlay');
}
else {
$options['query'] = array('render' => 'overlay');
}
}
}
/**
* Implements hook_batch_alter().
*
* If the current page request is inside the overlay, add ?render=overlay to
* the success callback URL, so that it appears correctly within the overlay.
*
* @see overlay_get_mode()
*/
function overlay_batch_alter(&$batch) {
if (overlay_get_mode() == 'child') {
if (isset($batch['url_options']['query'])) {
$batch['url_options']['query']['render'] = 'overlay';
}
else {
$batch['url_options']['query'] = array('render' => 'overlay');
}
}
}
/**
* Implements hook_page_alter().
*/
function overlay_page_alter(&$page) {
// If we are limiting rendering to a subset of page regions, deny access to
// all other regions so that they will not be processed.
if ($regions_to_render = overlay_get_regions_to_render()) {
$skipped_regions = array_diff(element_children($page), $regions_to_render);
foreach ($skipped_regions as $skipped_region) {
$page[$skipped_region]['#access'] = FALSE;
}
}
$mode = overlay_get_mode();
if ($mode == 'child') {
// Add the overlay wrapper before the html wrapper.
array_unshift($page['#theme_wrappers'], 'overlay');
}
elseif ($mode == 'parent' && ($message = overlay_disable_message())) {
$page['page_top']['disable_overlay'] = $message;
}
}
/**
* Page callback: Dismisses the overlay accessibility message for this user.
*
* @return
* A render array for a page containing a list of content.
*/
function overlay_user_dismiss_message() {
global $user;
// It's unlikely, but possible that "access overlay" permission is granted to
// the anonymous role. In this case, we do not display the message to disable
// the overlay, so there is nothing to dismiss. Also, protect against
// cross-site request forgeries by validating a token.
if (empty($user->uid) || !isset($_GET['token']) || !drupal_valid_token($_GET['token'], 'overlay')) {
return MENU_ACCESS_DENIED;
}
else {
user_save(user_load($user->uid), array('data' => array('overlay_message_dismissed' => 1)));
drupal_set_message(t('The message has been dismissed. You can change your overlay settings at any time by visiting your profile page.'));
// Destination is normally given. Go to the user profile as a fallback.
drupal_goto('user/' . $user->uid . '/edit');
}
}
/**
* Returns a renderable array representing a message for disabling the overlay.
*
* If the current user can access the overlay and has not previously indicated
* that this message should be dismissed, this function returns a message
* containing a link to disable the overlay. Nothing is returned for anonymous
* users, because the links control per-user settings. Because some screen
* readers are unable to properly read overlay contents, site builders are
* discouraged from granting the "access overlay" permission to the anonymous
* role.
*
* @see http://drupal.org/node/890284
*/
function overlay_disable_message() {
global $user;
if (!empty($user->uid) && empty($user->data['overlay_message_dismissed']) && (!isset($user->data['overlay']) || $user->data['overlay']) && user_access('access overlay')) {
$build = array(
'#theme' => 'overlay_disable_message',
'#weight' => -99,
// Link to the user's profile page, where the overlay can be disabled.
'profile_link' => array(
'#type' => 'link',
'#title' => t('If you have problems accessing administrative pages on this site, disable the overlay on your profile page.'),
'#href' => 'user/' . $user->uid . '/edit',
'#options' => array(
'query' => drupal_get_destination(),
'fragment' => 'edit-overlay-control',
'attributes' => array(
'id' => 'overlay-profile-link',
// Prevent the target page from being opened in the overlay.
'class' => array('overlay-exclude'),
),
),
),
// Link to a menu callback that allows this message to be permanently
// dismissed for the current user.
'dismiss_message_link' => array(
'#type' => 'link',
'#title' => t('Dismiss this message.'),
'#href' => 'overlay/dismiss-message',
'#options' => array(
'query' => drupal_get_destination() + array(
// Add a token to protect against cross-site request forgeries.
'token' => drupal_get_token('overlay'),
),
'attributes' => array(
'id' => 'overlay-dismiss-message',
// If this message is being displayed outside the overlay, prevent
// this link from opening the overlay.
'class' => (overlay_get_mode() == 'parent') ? array('overlay-exclude') : array(),
),
),
)
);
}
else {
$build = array();
}
return $build;
}
/**
* Returns the HTML for the message about how to disable the overlay.
*
* @param $variables
* An associative array with an 'element' element, which itself is an
* associative array containing:
* - profile_link: The link to this user's account.
* - dismiss_message_link: The link to dismiss the overlay.
*
* @ingroup themeable
*/
function theme_overlay_disable_message($variables) {
$element = $variables['element'];
// Add CSS classes to hide the links from most sighted users, while keeping
// them accessible to screen-reader users and keyboard-only users. To assist
// screen-reader users, this message appears in both the parent and child
// documents, but only the one in the child document is part of the tab order.
foreach (array('profile_link', 'dismiss_message_link') as $key) {
$element[$key]['#options']['attributes']['class'][] = 'element-invisible';
if (overlay_get_mode() == 'child') {
$element[$key]['#options']['attributes']['class'][] = 'element-focusable';
}
}
// Render the links.
$output = drupal_render($element['profile_link']) . ' ' . drupal_render($element['dismiss_message_link']);
// Add a heading for screen-reader users. The heading doesn't need to be seen
// by sighted users.
$output = '' . t('Options for the administrative overlay') . ' ' . $output;
// Wrap in a container for styling.
$output = '' . $output . '
';
return $output;
}
/**
* Implements hook_block_list_alter().
*/
function overlay_block_list_alter(&$blocks) {
// If we are limiting rendering to a subset of page regions, hide all blocks
// which appear in regions not on that list. Note that overlay_page_alter()
// does a more comprehensive job of preventing unwanted regions from being
// displayed (regardless of whether they contain blocks or not), but the
// reason for duplicating effort here is performance; we do not even want
// these blocks to be built if they are not going to be displayed.
if ($regions_to_render = overlay_get_regions_to_render()) {
foreach ($blocks as $bid => $block) {
if (!in_array($block->region, $regions_to_render)) {
unset($blocks[$bid]);
}
}
}
}
/**
* Implements hook_system_info_alter().
*
* Add default regions for the overlay.
*/
function overlay_system_info_alter(&$info, $file, $type) {
if ($type == 'theme') {
$info['overlay_regions'][] = 'content';
$info['overlay_regions'][] = 'help';
}
}
/**
* Implements hook_preprocess_html().
*
* If the current page request is inside the overlay, add appropriate classes
* to the element, and simplify the page title.
*
* @see overlay_get_mode()
*/
function overlay_preprocess_html(&$variables) {
if (overlay_get_mode() == 'child') {
// Add overlay class, so themes can react to being displayed in the overlay.
$variables['classes_array'][] = 'overlay';
}
}
/**
* Implements hook_preprocess_maintenance_page().
*
* If the current page request is inside the overlay, add appropriate classes
* to the element, and simplify the page title.
*
* @see overlay_preprocess_maintenance_page()
*/
function overlay_preprocess_maintenance_page(&$variables) {
overlay_preprocess_html($variables);
}
/**
* Implements template_preprocess_HOOK() for overlay.tpl.php
*
* If the current page request is inside the overlay, add appropriate classes
* to the element, and simplify the page title.
*
* @see template_process_overlay()
* @see overlay.tpl.php
*/
function template_preprocess_overlay(&$variables) {
$variables['tabs'] = menu_primary_local_tasks();
$variables['title'] = drupal_get_title();
$variables['disable_overlay'] = overlay_disable_message();
$variables['content_attributes_array']['class'][] = 'clearfix';
}
/**
* Implements template_process_HOOK() for overlay.tpl.php
*
* Places the rendered HTML for the page body into a top level variable.
*
* @see template_preprocess_overlay()
* @see overlay.tpl.php
*/
function template_process_overlay(&$variables) {
$variables['page'] = $variables['page']['#children'];
}
/**
* Implements hook_preprocess_page().
*
* If the current page request is inside the overlay, hide the tabs.
*
* @see overlay_get_mode()
*/
function overlay_preprocess_page(&$variables) {
if (overlay_get_mode() == 'child') {
unset($variables['tabs']['#primary']);
}
}
/**
* Stores and returns whether an empty page override is needed.
*
* This is used to prevent a page request which closes the overlay (for
* example, a form submission) from being fully re-rendered before the overlay
* is closed. Instead, we store a variable which will cause the page to be
* rendered by a delivery callback function that does not actually print
* visible HTML (but rather only the bare minimum scripts and styles necessary
* to trigger the overlay to close), thereby allowing the dialog to be closed
* faster and with less interruption, and also allowing the display of messages
* to be deferred to the parent window (rather than displaying them in the
* child window, which will close before the user has had a chance to read
* them).
*
* @param $value
* By default, an empty page will not be displayed. Set to TRUE to request
* an empty page display, or FALSE to disable the empty page display (if it
* was previously enabled on this page request).
*
* @return
* TRUE if the current behavior is to display an empty page, or FALSE if not.
*
* @see overlay_page_delivery_callback_alter()
*/
function overlay_display_empty_page($value = NULL) {
$display_empty_page = &drupal_static(__FUNCTION__, FALSE);
if (isset($value)) {
$display_empty_page = $value;
}
return $display_empty_page;
}
/**
* Implements hook_page_delivery_callback_alter().
*/
function overlay_page_delivery_callback_alter(&$callback) {
if (overlay_display_empty_page()) {
$callback = 'overlay_deliver_empty_page';
}
}
/**
* Prints an empty page.
*
* This function is used to print out a bare minimum empty page which still has
* the scripts and styles necessary in order to trigger the overlay to close.
*/
function overlay_deliver_empty_page() {
$empty_page = '', variable_get('site_frontpage', 'node'), $type);
}
drupal_add_js(array('overlay' => array('paths' => $paths)), 'setting');
$path_prefixes = array();
if (module_exists('locale') && variable_get('locale_language_negotiation_url_part', LOCALE_LANGUAGE_NEGOTIATION_URL_PREFIX) == LOCALE_LANGUAGE_NEGOTIATION_URL_PREFIX) {
// Get languages grouped by status and select only the enabled ones.
$languages = language_list('enabled');
$languages = $languages[1];
$path_prefixes = array();
foreach ($languages as $language) {
if ($language->prefix) {
$path_prefixes[] = $language->prefix;
}
}
}
drupal_add_js(array('overlay' => array('pathPrefixes' => $path_prefixes)), 'setting');
// Pass along the Ajax callback for rerendering sections of the parent window.
drupal_add_js(array('overlay' => array('ajaxCallback' => 'overlay-ajax')), 'setting');
}
/**
* Implements hook_overlay_child_initialize().
*/
function overlay_overlay_child_initialize() {
// Check if the parent window needs to refresh any page regions on this page
// request.
overlay_trigger_refresh();
// If this is a POST request, or a GET request with a token parameter, we
// have an indication that something in the supplemental regions of the
// overlay might change during the current page request. We therefore store
// the initial rendered content of those regions here, so that we can compare
// it to the same content rendered in overlay_exit(), at the end of the page
// request. This allows us to check if anything actually did change, and, if
// so, trigger an immediate Ajax refresh of the parent window.
if (!empty($_POST) || isset($_GET['token'])) {
foreach (overlay_supplemental_regions() as $region) {
overlay_store_rendered_content($region, overlay_render_region($region));
}
// In addition, notify the parent window that when the overlay closes,
// the entire parent window should be refreshed.
overlay_request_page_refresh();
}
// Indicate that when the main page rendering occurs later in the page
// request, only the regions that appear within the overlay should be
// rendered.
overlay_set_regions_to_render(overlay_regions());
}
/**
* Requests that the overlay closes when the page is displayed.
*
* @param $redirect
* (optional) The path that should open in the parent window after the
* overlay closes. If not set, no redirect will be performed on the parent
* window.
*
* @param $redirect_options
* (optional) An associative array of options to use when generating the
* redirect URL.
*/
function overlay_close_dialog($redirect = NULL, $redirect_options = array()) {
$settings = array(
'overlayChild' => array(
'closeOverlay' => TRUE,
),
);
// Tell the child window to perform the redirection when requested to.
if (isset($redirect)) {
$settings['overlayChild']['redirect'] = url($redirect, $redirect_options);
}
drupal_add_js($settings, array('type' => 'setting'));
// Since we are closing the overlay as soon as the page is displayed, we do
// not want to show any of the page's actual content.
overlay_display_empty_page(TRUE);
}
/**
* Returns a list of page regions that appear in the overlay.
*
* Overlay regions correspond to the entire contents of the overlay child
* window and are refreshed each time a new page request is made within the
* overlay.
*
* @return
* An array of region names that correspond to those which appear in the
* overlay, within the theme that is being used to display the current page.
*
* @see overlay_supplemental_regions()
*/
function overlay_regions() {
return _overlay_region_list('overlay_regions');
}
/**
* Returns a list of supplemental page regions for the overlay.
*
* Supplemental overlay regions are those which are technically part of the
* parent window, but appear to the user as being related to the overlay
* (usually because they are displayed next to, rather than underneath, the
* main overlay regions) and therefore need to be dynamically refreshed if any
* administrative actions taken within the overlay change their contents.
*
* An example of a typical overlay supplemental region would be the 'page_top'
* region, in the case where a toolbar is being displayed there.
*
* @return
* An array of region names that correspond to supplemental overlay regions,
* within the theme that is being used to display the current page.
*
* @see overlay_regions()
*/
function overlay_supplemental_regions() {
return _overlay_region_list('overlay_supplemental_regions');
}
/**
* Returns a list of page regions related to the overlay.
*
* @param $type
* The type of regions to return. This can either be 'overlay_regions' or
* 'overlay_supplemental_regions'.
*
* @return
* An array of region names of the given type, within the theme that is being
* used to display the current page.
*
* @see overlay_regions()
* @see overlay_supplemental_regions()
*/
function _overlay_region_list($type) {
// Obtain the current theme. We need to first make sure the theme system is
// initialized, since this function can be called early in the page request.
drupal_theme_initialize();
$themes = list_themes();
$theme = $themes[$GLOBALS['theme']];
// Return the list of regions stored within the theme's info array, or an
// empty array if no regions of the appropriate type are defined.
return !empty($theme->info[$type]) ? $theme->info[$type] : array();
}
/**
* Returns a list of page regions that rendering should be limited to.
*
* @return
* An array containing the names of the regions that will be rendered when
* drupal_render_page() is called. If empty, then no limits will be imposed,
* and all regions of the page will be rendered.
*
* @see overlay_page_alter()
* @see overlay_block_list_alter()
* @see overlay_set_regions_to_render()
*/
function overlay_get_regions_to_render() {
return overlay_set_regions_to_render();
}
/**
* Sets the regions of the page that rendering will be limited to.
*
* @param $regions
* (Optional) An array containing the names of the regions that should be
* rendered when drupal_render_page() is called. Pass in an empty array to
* remove all limits and cause drupal_render_page() to render all page
* regions (the default behavior). If this parameter is omitted, no change
* will be made to the current list of regions to render.
*
* @return
* The current list of regions to render, or an empty array if the regions
* are not being limited.
*
* @see overlay_page_alter()
* @see overlay_block_list_alter()
* @see overlay_get_regions_to_render()
*/
function overlay_set_regions_to_render($regions = NULL) {
$regions_to_render = &drupal_static(__FUNCTION__, array());
if (isset($regions)) {
$regions_to_render = $regions;
}
return $regions_to_render;
}
/**
* Renders an individual page region.
*
* This function is primarily intended to be used for checking the content of
* supplemental overlay regions (e.g., a region containing a toolbar). Passing
* in a region that is intended to display the main page content is not
* supported; the region will be rendered by this function, but the main page
* content will not appear in it. In addition, although this function returns
* the rendered HTML for the provided region, it does not place it on the final
* page, nor add any of its associated JavaScript or CSS to the page.
*
* @param $region
* The name of the page region that should be rendered.
*
* @return
* The rendered HTML of the provided region.
*/
function overlay_render_region($region) {
// Indicate the region that we will be rendering, so that other regions will
// be hidden by overlay_page_alter() and overlay_block_list_alter().
overlay_set_regions_to_render(array($region));
// Do what is necessary to force drupal_render_page() to only display HTML
// from the requested region. Specifically, declare that the main page
// content does not need to automatically be added to the page, and pass in
// a page array that has all theme functions removed (so that overall HTML
// for the page will not be added either).
$system_main_content_added = &drupal_static('system_main_content_added');
$system_main_content_added = TRUE;
$page = array(
'#type' => 'page',
'#theme' => NULL,
'#theme_wrappers' => array(),
);
// Render the region, but do not cache any JavaScript or CSS associated with
// it. This region might not be included the next time drupal_render_page()
// is called, and we do not want its JavaScript or CSS to erroneously appear
// on the final rendered page.
$original_js = drupal_add_js();
$original_css = drupal_add_css();
$original_libraries = drupal_static('drupal_add_library');
$js = &drupal_static('drupal_add_js');
$css = &drupal_static('drupal_add_css');
$libraries = &drupal_static('drupal_add_library');
$markup = drupal_render_page($page);
$js = $original_js;
$css = $original_css;
$libraries = $original_libraries;
// Indicate that the main page content has not, in fact, been displayed, so
// that future calls to drupal_render_page() will be able to render it
// correctly.
$system_main_content_added = FALSE;
// Restore the original behavior of rendering all regions for the next time
// drupal_render_page() is called.
overlay_set_regions_to_render(array());
return $markup;
}
/**
* Returns any rendered content that was stored earlier in the page request.
*
* @return
* An array of all rendered HTML that was stored earlier in the page request,
* keyed by the identifier with which it was stored. If no content was
* stored, an empty array is returned.
*
* @see overlay_store_rendered_content()
*/
function overlay_get_rendered_content() {
return overlay_store_rendered_content();
}
/**
* Stores strings representing rendered HTML content.
*
* This function is used to keep a static cache of rendered content that can be
* referred to later in the page request.
*
* @param $id
* (Optional) An identifier for the content which is being stored, which will
* be used as an array key in the returned array. If omitted, no change will
* be made to the current stored data.
* @param $content
* (Optional) A string representing the rendered data to store. This only has
* an effect if $id is also provided.
*
* @return
* An array representing all data that is currently being stored, or an empty
* array if there is none.
*
* @see overlay_get_rendered_content()
*/
function overlay_store_rendered_content($id = NULL, $content = NULL) {
$rendered_content = &drupal_static(__FUNCTION__, array());
if (isset($id)) {
$rendered_content[$id] = $content;
}
return $rendered_content;
}
/**
* Requests that the parent window refreshes a particular page region.
*
* @param $region
* The name of the page region to refresh. The parent window will trigger a
* refresh of this region on the next page load.
*
* @see overlay_trigger_refresh()
* @see Drupal.overlay.refreshRegions()
*/
function overlay_request_refresh($region) {
$class = drupal_region_class($region);
$_SESSION['overlay_regions_to_refresh'][] = array($class => $region);
}
/**
* Requests that the entire parent window is reloaded when the overlay closes.
*
* @see overlay_trigger_refresh()
*/
function overlay_request_page_refresh() {
$_SESSION['overlay_refresh_parent'] = TRUE;
}
/**
* Checks if the parent window needs to be refreshed on this page load.
*
* If the previous page load requested that any page regions be refreshed, or
* if it requested that the entire page be refreshed when the overlay closes,
* pass that request via JavaScript to the child window, so it can in turn pass
* the request to the parent window.
*
* @see overlay_request_refresh()
* @see overlay_request_page_refresh()
* @see Drupal.overlay.refreshRegions()
*/
function overlay_trigger_refresh() {
if (!empty($_SESSION['overlay_regions_to_refresh'])) {
$settings = array(
'overlayChild' => array(
'refreshRegions' => $_SESSION['overlay_regions_to_refresh'],
),
);
drupal_add_js($settings, array('type' => 'setting'));
unset($_SESSION['overlay_regions_to_refresh']);
}
if (!empty($_SESSION['overlay_refresh_parent'])) {
drupal_add_js(array('overlayChild' => array('refreshPage' => TRUE)), array('type' => 'setting'));
unset($_SESSION['overlay_refresh_parent']);
}
}
/**
* Prints the markup obtained by rendering a single region of the page.
*
* This function is intended to be called via Ajax.
*
* @param $region
* The name of the page region to render.
*
* @see Drupal.overlay.refreshRegions()
*/
function overlay_ajax_render_region($region) {
print overlay_render_region($region);
}
:language', 0, 1, array(':language' => LANGUAGE_NONE))->fetchField();
$multilanguage = (module_exists('locale') || $alias_exists);
$header = array();
$header[] = array('data' => t('Alias'), 'field' => 'alias', 'sort' => 'asc');
$header[] = array('data' => t('System'), 'field' => 'source');
if ($multilanguage) {
$header[] = array('data' => t('Language'), 'field' => 'language');
}
$header[] = array('data' => t('Operations'));
$query = db_select('url_alias')->extend('PagerDefault')->extend('TableSort');
if ($keys) {
// Replace wildcards with PDO wildcards.
$query->condition('alias', '%' . preg_replace('!\*+!', '%', $keys) . '%', 'LIKE');
}
$result = $query
->fields('url_alias')
->orderByHeader($header)
->limit(50)
->execute();
$rows = array();
$destination = drupal_get_destination();
foreach ($result as $data) {
$row = array();
$row['data']['alias'] = l($data->alias, $data->source);
$row['data']['source'] = l($data->source, $data->source, array('alias' => TRUE));
if ($multilanguage) {
$row['data']['language'] = module_invoke('locale', 'language_name', $data->language);
}
$operations = array();
$operations['edit'] = array(
'title' => t('edit'),
'href' => "admin/config/search/path/edit/$data->pid",
'query' => $destination,
);
$operations['delete'] = array(
'title' => t('delete'),
'href' => "admin/config/search/path/delete/$data->pid",
'query' => $destination,
);
$row['data']['operations'] = array(
'data' => array(
'#theme' => 'links',
'#links' => $operations,
'#attributes' => array('class' => array('links', 'inline', 'nowrap')),
),
);
// If the system path maps to a different URL alias, highlight this table
// row to let the user know of old aliases.
if ($data->alias != drupal_get_path_alias($data->source, $data->language)) {
$row['class'] = array('warning');
}
$rows[] = $row;
}
$build['path_table'] = array(
'#theme' => 'table',
'#header' => $header,
'#rows' => $rows,
'#empty' => t('No URL aliases available. Add URL alias .', array('@link' => url('admin/config/search/path/add'))),
);
$build['path_pager'] = array('#theme' => 'pager');
return $build;
}
/**
* Page callback: Returns a form creating or editing a path alias.
*
* @param $path
* An array containing the path ID, source, alias, and language code.
*
* @return
* A form for adding or editing a URL alias.
*
* @see path_menu()
*/
function path_admin_edit($path = array()) {
if ($path) {
drupal_set_title($path['alias']);
$output = drupal_get_form('path_admin_form', $path);
}
else {
$output = drupal_get_form('path_admin_form');
}
return $output;
}
/**
* Form constructor for the path administration form.
*
* @param $path
* An array containing the path ID, source, alias, and language code.
*
* @ingroup forms
* @see path_admin_form_validate()
* @see path_admin_form_submit()
* @see path_admin_form_delete_submit()
*/
function path_admin_form($form, &$form_state, $path = array('source' => '', 'alias' => '', 'language' => LANGUAGE_NONE, 'pid' => NULL)) {
$form['source'] = array(
'#type' => 'textfield',
'#title' => t('Existing system path'),
'#default_value' => $path['source'],
'#maxlength' => 255,
'#size' => 45,
'#description' => t('Specify the existing path you wish to alias. For example: node/28, forum/1, taxonomy/term/1.'),
'#field_prefix' => url(NULL, array('absolute' => TRUE)) . (variable_get('clean_url', 0) ? '' : '?q='),
'#required' => TRUE,
);
$form['alias'] = array(
'#type' => 'textfield',
'#title' => t('Path alias'),
'#default_value' => $path['alias'],
'#maxlength' => 255,
'#size' => 45,
'#description' => t('Specify an alternative path by which this data can be accessed. For example, type "about" when writing an about page. Use a relative path and don\'t add a trailing slash or the URL alias won\'t work.'),
'#field_prefix' => url(NULL, array('absolute' => TRUE)) . (variable_get('clean_url', 0) ? '' : '?q='),
'#required' => TRUE,
);
// This will be a hidden value unless locale module is enabled.
$form['language'] = array(
'#type' => 'value',
'#value' => $path['language']
);
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Save'),
);
if ($path['pid']) {
$form['pid'] = array(
'#type' => 'hidden',
'#value' => $path['pid'],
);
$form['actions']['delete'] = array(
'#type' => 'submit',
'#value' => t('Delete'),
'#submit' => array('path_admin_form_delete_submit'),
);
}
return $form;
}
/**
* Form submission handler for the 'Delete' button on path_admin_form().
*
* @see path_admin_form_validate()
* @see path_admin_form_submit()
*/
function path_admin_form_delete_submit($form, &$form_state) {
$destination = array();
if (isset($_GET['destination'])) {
$destination = drupal_get_destination();
unset($_GET['destination']);
}
$form_state['redirect'] = array('admin/config/search/path/delete/' . $form_state['values']['pid'], array('query' => $destination));
}
/**
* Form validation handler for path_admin_form().
*
* @see path_admin_form_submit()
* @see path_admin_form_delete_submit()
*/
function path_admin_form_validate($form, &$form_state) {
$source = &$form_state['values']['source'];
$source = drupal_get_normal_path($source);
$alias = $form_state['values']['alias'];
$pid = isset($form_state['values']['pid']) ? $form_state['values']['pid'] : 0;
// Language is only set if locale module is enabled, otherwise save for all languages.
$language = isset($form_state['values']['language']) ? $form_state['values']['language'] : LANGUAGE_NONE;
$has_alias = db_query("SELECT COUNT(alias) FROM {url_alias} WHERE pid <> :pid AND alias = :alias AND language = :language", array(
':pid' => $pid,
':alias' => $alias,
':language' => $language,
))
->fetchField();
if ($has_alias) {
form_set_error('alias', t('The alias %alias is already in use in this language.', array('%alias' => $alias)));
}
if (!drupal_valid_path($source)) {
form_set_error('source', t("The path '@link_path' is either invalid or you do not have access to it.", array('@link_path' => $source)));
}
}
/**
* Form submission handler for path_admin_form().
*
* @see path_admin_form_validate()
* @see path_admin_form_delete_submit()
*/
function path_admin_form_submit($form, &$form_state) {
// Remove unnecessary values.
form_state_values_clean($form_state);
path_save($form_state['values']);
drupal_set_message(t('The alias has been saved.'));
$form_state['redirect'] = 'admin/config/search/path';
}
/**
* Form constructor for the path deletion form.
*
* @param $path
* The path alias that will be deleted.
*
* @see path_admin_delete_confirm_submit()
*/
function path_admin_delete_confirm($form, &$form_state, $path) {
if (user_access('administer url aliases')) {
$form_state['path'] = $path;
return confirm_form(
$form,
t('Are you sure you want to delete path alias %title?',
array('%title' => $path['alias'])),
'admin/config/search/path'
);
}
return array();
}
/**
* Form submission handler for path_admin_delete_confirm().
*/
function path_admin_delete_confirm_submit($form, &$form_state) {
if ($form_state['values']['confirm']) {
path_delete($form_state['path']['pid']);
$form_state['redirect'] = 'admin/config/search/path';
}
}
/**
* Form constructor for the path admin overview filter form.
*
* @ingroup forms
* @see path_admin_filter_form_submit_filter()
* @see path_admin_filter_form_submit_reset()
*/
function path_admin_filter_form($form, &$form_state, $keys = '') {
$form['#attributes'] = array('class' => array('search-form'));
$form['basic'] = array('#type' => 'fieldset',
'#title' => t('Filter aliases'),
'#attributes' => array('class' => array('container-inline')),
);
$form['basic']['filter'] = array(
'#type' => 'textfield',
'#title' => 'Path alias',
'#title_display' => 'invisible',
'#default_value' => $keys,
'#maxlength' => 128,
'#size' => 25,
);
$form['basic']['submit'] = array(
'#type' => 'submit',
'#value' => t('Filter'),
'#submit' => array('path_admin_filter_form_submit_filter'),
);
if ($keys) {
$form['basic']['reset'] = array(
'#type' => 'submit',
'#value' => t('Reset'),
'#submit' => array('path_admin_filter_form_submit_reset'),
);
}
return $form;
}
/**
* Form submission handler for the path_admin_filter_form() Filter button.
*
* @see path_admin_filter_form_submit_reset()
*/
function path_admin_filter_form_submit_filter($form, &$form_state) {
$form_state['redirect'] = 'admin/config/search/path/list/' . trim($form_state['values']['filter']);
}
/**
* Form submission handler for the path_admin_filter_form() Reset button.
*
* @see path_admin_filter_form_submit_filter()
*/
function path_admin_filter_form_submit_reset($form, &$form_state) {
$form_state['redirect'] = 'admin/config/search/path/list';
}
fields(array(
'alias' => $path['alias'],
'pid' => $path['pid'],
))
->execute();
}
/**
* Respond to a path being updated.
*
* @param $path
* An associative array containing the following keys:
* - source: The internal system path.
* - alias: The URL alias.
* - pid: Unique path alias identifier.
* - language: The language of the alias.
*
* @see path_save()
*/
function hook_path_update($path) {
db_update('mytable')
->fields(array('alias' => $path['alias']))
->condition('pid', $path['pid'])
->execute();
}
/**
* Respond to a path being deleted.
*
* @param $path
* An associative array containing the following keys:
* - source: The internal system path.
* - alias: The URL alias.
* - pid: Unique path alias identifier.
* - language: The language of the alias.
*
* @see path_delete()
*/
function hook_path_delete($path) {
db_delete('mytable')
->condition('pid', $path['pid'])
->execute();
}
/**
* @} End of "addtogroup hooks".
*/
name = Path
description = Allows users to rename URLs.
package = Core
version = VERSION
core = 7.x
files[] = path.test
configure = admin/config/search/path
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
/**
* @file
* Attaches behaviors for the Path module.
*/
(function ($) {
Drupal.behaviors.pathFieldsetSummaries = {
attach: function (context) {
$('fieldset.path-form', context).drupalSetSummary(function (context) {
var path = $('.form-item-path-alias input').val();
return path ?
Drupal.t('Alias: @alias', { '@alias': path }) :
Drupal.t('No alias');
});
}
};
})(jQuery);
' . t('About') . '';
$output .= '' . t('The Path module allows you to specify an alias, or custom URL, for any existing internal system path. Aliases should not be confused with URL redirects, which allow you to forward a changed or inactive URL to a new URL. In addition to making URLs more readable, aliases also help search engines index content more effectively. Multiple aliases may be used for a single internal system path. To automate the aliasing of paths, you can install the contributed module Pathauto . For more information, see the online handbook entry for the Path module .', array('@path' => 'http://drupal.org/documentation/modules/path', '@pathauto' => 'http://drupal.org/project/pathauto')) . '
';
$output .= '' . t('Uses') . ' ';
$output .= '';
$output .= '' . t('Creating aliases') . ' ';
$output .= '' . t('Users with sufficient permissions can create aliases under the URL path settings section when they create or edit content. Some examples of aliases are: ', array('@permissions' => url('admin/people/permissions', array('fragment' => 'module-path'))));
$output .= '' . t('member/jane-smith aliased to internal path user/123 ') . ' ';
$output .= '' . t('about-us/team aliased to internal path node/456 ') . ' ';
$output .= ' ';
$output .= '' . t('Managing aliases') . ' ';
$output .= '' . t('The Path module provides a way to search and view a list of all aliases that are in use on your website. Aliases can be added, edited and deleted through this list.', array('@aliases' => url('admin/config/search/path'))) . ' ';
$output .= ' ';
return $output;
case 'admin/config/search/path':
return '' . t("An alias defines a different name for an existing URL path - for example, the alias 'about' for the URL path 'node/1'. A URL path can have multiple aliases.") . '
';
case 'admin/config/search/path/add':
return '' . t('Enter the path you wish to create the alias for, followed by the name of the new alias.') . '
';
}
}
/**
* Implements hook_permission().
*/
function path_permission() {
return array(
'administer url aliases' => array(
'title' => t('Administer URL aliases'),
),
'create url aliases' => array(
'title' => t('Create and edit URL aliases'),
),
);
}
/**
* Implements hook_menu().
*/
function path_menu() {
$items['admin/config/search/path'] = array(
'title' => 'URL aliases',
'description' => "Change your site's URL paths by aliasing them.",
'page callback' => 'path_admin_overview',
'access arguments' => array('administer url aliases'),
'weight' => -5,
'file' => 'path.admin.inc',
);
$items['admin/config/search/path/edit/%path'] = array(
'title' => 'Edit alias',
'page callback' => 'path_admin_edit',
'page arguments' => array(5),
'access arguments' => array('administer url aliases'),
'file' => 'path.admin.inc',
);
$items['admin/config/search/path/delete/%path'] = array(
'title' => 'Delete alias',
'page callback' => 'drupal_get_form',
'page arguments' => array('path_admin_delete_confirm', 5),
'access arguments' => array('administer url aliases'),
'file' => 'path.admin.inc',
);
$items['admin/config/search/path/list'] = array(
'title' => 'List',
'type' => MENU_DEFAULT_LOCAL_TASK,
'weight' => -10,
);
$items['admin/config/search/path/add'] = array(
'title' => 'Add alias',
'page callback' => 'path_admin_edit',
'access arguments' => array('administer url aliases'),
'type' => MENU_LOCAL_ACTION,
'file' => 'path.admin.inc',
);
return $items;
}
/**
* Implements hook_form_BASE_FORM_ID_alter() for node_form().
*
* @see path_form_element_validate()
*/
function path_form_node_form_alter(&$form, $form_state) {
$path = array();
if (!empty($form['#node']->nid)) {
$conditions = array('source' => 'node/' . $form['#node']->nid);
$langcode = entity_language('node', $form['#node']);
if ($langcode != LANGUAGE_NONE) {
$conditions['language'] = $langcode;
}
$path = path_load($conditions);
if ($path === FALSE) {
$path = array();
}
}
$path += array(
'pid' => NULL,
'source' => isset($form['#node']->nid) ? 'node/' . $form['#node']->nid : NULL,
'alias' => '',
'language' => isset($langcode) ? $langcode : LANGUAGE_NONE,
);
$form['path'] = array(
'#type' => 'fieldset',
'#title' => t('URL path settings'),
'#collapsible' => TRUE,
'#collapsed' => empty($path['alias']),
'#group' => 'additional_settings',
'#attributes' => array(
'class' => array('path-form'),
),
'#attached' => array(
'js' => array(drupal_get_path('module', 'path') . '/path.js'),
),
'#access' => user_access('create url aliases') || user_access('administer url aliases'),
'#weight' => 30,
'#tree' => TRUE,
'#element_validate' => array('path_form_element_validate'),
);
$form['path']['alias'] = array(
'#type' => 'textfield',
'#title' => t('URL alias'),
'#default_value' => $path['alias'],
'#maxlength' => 255,
'#description' => t('Optionally specify an alternative URL by which this content can be accessed. For example, type "about" when writing an about page. Use a relative path and don\'t add a trailing slash or the URL alias won\'t work.'),
);
$form['path']['pid'] = array('#type' => 'value', '#value' => $path['pid']);
$form['path']['source'] = array('#type' => 'value', '#value' => $path['source']);
$form['path']['language'] = array('#type' => 'value', '#value' => $path['language']);
}
/**
* Form element validation handler for URL alias form element.
*
* @see path_form_node_form_alter()
*/
function path_form_element_validate($element, &$form_state, $complete_form) {
// Trim the submitted value.
$alias = trim($form_state['values']['path']['alias']);
if (!empty($alias)) {
form_set_value($element['alias'], $alias, $form_state);
// Node language (Locale module) needs special care. Since the language of
// the URL alias depends on the node language, and the node language can be
// switched right within the same form, we need to conditionally overload
// the originally assigned URL alias language.
// @todo Remove this after converting Path module to a field, and, after
// stopping Locale module from abusing the content language system.
if (isset($form_state['values']['language'])) {
form_set_value($element['language'], $form_state['values']['language'], $form_state);
}
$path = $form_state['values']['path'];
// Ensure that the submitted alias does not exist yet.
$query = db_select('url_alias')
->condition('alias', $path['alias'])
->condition('language', $path['language']);
if (!empty($path['source'])) {
$query->condition('source', $path['source'], '<>');
}
$query->addExpression('1');
$query->range(0, 1);
if ($query->execute()->fetchField()) {
form_error($element, t('The alias is already in use.'));
}
}
}
/**
* Implements hook_node_insert().
*/
function path_node_insert($node) {
if (isset($node->path) && isset($node->path['alias'])) {
$path = $node->path;
$path['alias'] = trim($path['alias']);
// Only save a non-empty alias.
if (!empty($path['alias'])) {
// Ensure fields for programmatic executions.
$langcode = entity_language('node', $node);
$path['source'] = 'node/' . $node->nid;
$path['language'] = isset($langcode) ? $langcode : LANGUAGE_NONE;
path_save($path);
}
}
}
/**
* Implements hook_node_update().
*/
function path_node_update($node) {
if (isset($node->path)) {
$path = $node->path;
$path['alias'] = isset($path['alias']) ? trim($path['alias']) : '';
// Delete old alias if user erased it.
if (!empty($path['pid']) && !$path['alias']) {
path_delete($path['pid']);
}
path_node_insert($node);
}
}
/**
* Implements hook_node_delete().
*/
function path_node_delete($node) {
// Delete all aliases associated with this node.
path_delete(array('source' => 'node/' . $node->nid));
}
/**
* Implements hook_form_FORM_ID_alter() for taxonomy_form_term().
*/
function path_form_taxonomy_form_term_alter(&$form, $form_state) {
// Make sure this does not show up on the delete confirmation form.
if (empty($form_state['confirm_delete'])) {
$langcode = entity_language('taxonomy_term', (object) $form['#term']);
$langcode = !empty($langcode) ? $langcode : LANGUAGE_NONE;
$conditions = array('source' => 'taxonomy/term/' . $form['#term']['tid'], 'language' => $langcode);
$path = (isset($form['#term']['tid']) ? path_load($conditions) : array());
if ($path === FALSE) {
$path = array();
}
$path += array(
'pid' => NULL,
'source' => isset($form['#term']['tid']) ? 'taxonomy/term/' . $form['#term']['tid'] : NULL,
'alias' => '',
'language' => $langcode,
);
$form['path'] = array(
'#access' => user_access('create url aliases') || user_access('administer url aliases'),
'#tree' => TRUE,
'#element_validate' => array('path_form_element_validate'),
);
$form['path']['alias'] = array(
'#type' => 'textfield',
'#title' => t('URL alias'),
'#default_value' => $path['alias'],
'#maxlength' => 255,
'#weight' => 0,
'#description' => t("Optionally specify an alternative URL by which this term can be accessed. Use a relative path and don't add a trailing slash or the URL alias won't work."),
);
$form['path']['pid'] = array('#type' => 'value', '#value' => $path['pid']);
$form['path']['source'] = array('#type' => 'value', '#value' => $path['source']);
$form['path']['language'] = array('#type' => 'value', '#value' => $path['language']);
}
}
/**
* Implements hook_taxonomy_term_insert().
*/
function path_taxonomy_term_insert($term) {
if (isset($term->path)) {
$path = $term->path;
$path['alias'] = trim($path['alias']);
// Only save a non-empty alias.
if (!empty($path['alias'])) {
// Ensure fields for programmatic executions.
$path['source'] = 'taxonomy/term/' . $term->tid;
// Core does not provide a way to store the term language but contrib
// modules can do it so we need to take this into account.
$langcode = entity_language('taxonomy_term', $term);
$path['language'] = !empty($langcode) ? $langcode : LANGUAGE_NONE;
path_save($path);
}
}
}
/**
* Implements hook_taxonomy_term_update().
*/
function path_taxonomy_term_update($term) {
if (isset($term->path)) {
$path = $term->path;
$path['alias'] = trim($path['alias']);
// Delete old alias if user erased it.
if (!empty($path['pid']) && empty($path['alias'])) {
path_delete($path['pid']);
}
// Only save a non-empty alias.
if (!empty($path['alias'])) {
// Ensure fields for programmatic executions.
$path['source'] = 'taxonomy/term/' . $term->tid;
// Core does not provide a way to store the term language but contrib
// modules can do it so we need to take this into account.
$langcode = entity_language('taxonomy_term', $term);
$path['language'] = !empty($langcode) ? $langcode : LANGUAGE_NONE;
path_save($path);
}
}
}
/**
* Implements hook_taxonomy_term_delete().
*/
function path_taxonomy_term_delete($term) {
// Delete all aliases associated with this term.
path_delete(array('source' => 'taxonomy/term/' . $term->tid));
}
'Path alias functionality',
'description' => 'Add, edit, delete, and change alias and verify its consistency in the database.',
'group' => 'Path',
);
}
function setUp() {
parent::setUp('path');
// Create test user and login.
$web_user = $this->drupalCreateUser(array('create page content', 'edit own page content', 'administer url aliases', 'create url aliases', 'access content overview'));
$this->drupalLogin($web_user);
}
/**
* Tests the path cache.
*/
function testPathCache() {
// Create test node.
$node1 = $this->drupalCreateNode();
// Create alias.
$edit = array();
$edit['source'] = 'node/' . $node1->nid;
$edit['alias'] = $this->randomName(8);
$this->drupalPost('admin/config/search/path/add', $edit, t('Save'));
// Visit the system path for the node and confirm a cache entry is
// created.
cache_clear_all('*', 'cache_path', TRUE);
$this->drupalGet($edit['source']);
$this->assertTrue(cache_get($edit['source'], 'cache_path'), 'Cache entry was created.');
// Visit the alias for the node and confirm a cache entry is created.
cache_clear_all('*', 'cache_path', TRUE);
$this->drupalGet($edit['alias']);
$this->assertTrue(cache_get($edit['source'], 'cache_path'), 'Cache entry was created.');
}
/**
* Tests alias functionality through the admin interfaces.
*/
function testAdminAlias() {
// Create test node.
$node1 = $this->drupalCreateNode();
// Create alias.
$edit = array();
$edit['source'] = 'node/' . $node1->nid;
$edit['alias'] = $this->randomName(8);
$this->drupalPost('admin/config/search/path/add', $edit, t('Save'));
// Confirm that the alias works.
$this->drupalGet($edit['alias']);
$this->assertText($node1->title, 'Alias works.');
$this->assertResponse(200);
// Change alias to one containing "exotic" characters.
$pid = $this->getPID($edit['alias']);
$previous = $edit['alias'];
$edit['alias'] = "- ._~!$'\"()*@[]?&+%#,;=:" . // "Special" ASCII characters.
"%23%25%26%2B%2F%3F" . // Characters that look like a percent-escaped string.
"éøïвβ中國書۞"; // Characters from various non-ASCII alphabets.
$this->drupalPost('admin/config/search/path/edit/' . $pid, $edit, t('Save'));
// Confirm that the alias works.
$this->drupalGet($edit['alias']);
$this->assertText($node1->title, 'Changed alias works.');
$this->assertResponse(200);
drupal_static_reset('drupal_lookup_path');
// Confirm that previous alias no longer works.
$this->drupalGet($previous);
$this->assertNoText($node1->title, 'Previous alias no longer works.');
$this->assertResponse(404);
// Create second test node.
$node2 = $this->drupalCreateNode();
// Set alias to second test node.
$edit['source'] = 'node/' . $node2->nid;
// leave $edit['alias'] the same
$this->drupalPost('admin/config/search/path/add', $edit, t('Save'));
// Confirm no duplicate was created.
$this->assertRaw(t('The alias %alias is already in use in this language.', array('%alias' => $edit['alias'])), 'Attempt to move alias was rejected.');
// Delete alias.
$this->drupalPost('admin/config/search/path/edit/' . $pid, array(), t('Delete'));
$this->drupalPost(NULL, array(), t('Confirm'));
// Confirm that the alias no longer works.
$this->drupalGet($edit['alias']);
$this->assertNoText($node1->title, 'Alias was successfully deleted.');
$this->assertResponse(404);
// Create third and fourth test node.
$node3 = $this->drupalCreateNode();
$node4 = $this->drupalCreateNode();
// Give the node aliases a common first part.
$name = $this->randomName(4);
// Create aliases containing a slash.
$edit = array();
$edit['source'] = 'node/' . $node3->nid;
$alias3 = $name . '/' . $this->randomName(5);
$edit['alias'] = $alias3;
$this->drupalPost('admin/config/search/path/add', $edit, t('Save'));
$edit['source'] = 'node/' . $node4->nid;
$alias4 = $name . '/' . $this->randomName(4);
$edit['alias'] = $alias4;
$this->drupalPost('admin/config/search/path/add', $edit, t('Save'));
// Confirm that the aliases work.
$this->drupalGet($alias3);
$this->assertText($node3->title, 'Alias works.');
$this->assertResponse(200);
$this->drupalGet($alias4);
$this->assertText($node4->title, 'Alias works.');
$this->assertResponse(200);
// Confirm that filters containing slashes work.
$this->drupalGet('admin/config/search/path/list/' . $alias3);
$this->assertFieldByName('filter', $alias3);
$this->assertText($alias3, 'Searched-for alias with slash found.');
$this->assertNoText($alias4, 'Different alias with slash not found.');
$this->assertResponse(200);
// Delete aliases.
$pid = $this->getPID($alias3);
$this->drupalPost('admin/config/search/path/edit/' . $pid, array(), t('Delete'));
$this->drupalPost(NULL, array(), t('Confirm'));
$pid = $this->getPID($alias4);
$this->drupalPost('admin/config/search/path/edit/' . $pid, array(), t('Delete'));
$this->drupalPost(NULL, array(), t('Confirm'));
// Confirm that the aliases no longer work.
$this->drupalGet($alias3);
$this->assertNoText($node3->title, 'Alias was successfully deleted.');
$this->assertResponse(404);
$this->drupalGet($alias4);
$this->assertNoText($node4->title, 'Alias was successfully deleted.');
$this->assertResponse(404);
}
/**
* Tests alias functionality through the node interfaces.
*/
function testNodeAlias() {
// Create test node.
$node1 = $this->drupalCreateNode();
// Create alias.
$edit = array();
$edit['path[alias]'] = $this->randomName(8);
$this->drupalPost('node/' . $node1->nid . '/edit', $edit, t('Save'));
// Confirm that the alias works.
$this->drupalGet($edit['path[alias]']);
$this->assertText($node1->title, 'Alias works.');
$this->assertResponse(200);
// Change alias to one containing "exotic" characters.
$previous = $edit['path[alias]'];
$edit['path[alias]'] = "- ._~!$'\"()*@[]?&+%#,;=:" . // "Special" ASCII characters.
"%23%25%26%2B%2F%3F" . // Characters that look like a percent-escaped string.
"éøïвβ中國書۞"; // Characters from various non-ASCII alphabets.
$this->drupalPost('node/' . $node1->nid . '/edit', $edit, t('Save'));
// Confirm that the alias works.
$this->drupalGet($edit['path[alias]']);
$this->assertText($node1->title, 'Changed alias works.');
$this->assertResponse(200);
// Make sure that previous alias no longer works.
$this->drupalGet($previous);
$this->assertNoText($node1->title, 'Previous alias no longer works.');
$this->assertResponse(404);
// Create second test node.
$node2 = $this->drupalCreateNode();
// Set alias to second test node.
// Leave $edit['path[alias]'] the same.
$this->drupalPost('node/' . $node2->nid . '/edit', $edit, t('Save'));
// Confirm that the alias didn't make a duplicate.
$this->assertText(t('The alias is already in use.'), 'Attempt to moved alias was rejected.');
// Delete alias.
$this->drupalPost('node/' . $node1->nid . '/edit', array('path[alias]' => ''), t('Save'));
// Confirm that the alias no longer works.
$this->drupalGet($edit['path[alias]']);
$this->assertNoText($node1->title, 'Alias was successfully deleted.');
$this->assertResponse(404);
// Create third test node.
$node3 = $this->drupalCreateNode();
// Create an invalid alias with a leading slash and verify that the slash
// is removed when the link is generated. This ensures that URL aliases
// cannot be used to inject external URLs.
// @todo The user interface should either display an error message or
// automatically trim these invalid aliases, rather than allowing them to
// be silently created, at which point the functional aspects of this
// test will need to be moved elsewhere and switch to using a
// programmatically-created alias instead.
$alias = $this->randomName(8);
$edit = array('path[alias]' => '/' . $alias);
$this->drupalPost('node/' . $node3->nid . '/edit', $edit, t('Save'));
$this->drupalGet('admin/content');
// This checks the link href before clicking it, rather than using
// DrupalWebTestCase::assertUrl() after clicking it, because the test
// browser does not always preserve the correct number of slashes in the
// URL when it visits internal links; using DrupalWebTestCase::assertUrl()
// would actually make the test pass unconditionally on the testbot (or
// anywhere else where Drupal is installed in a subdirectory).
$link_xpath = $this->xpath('//a[normalize-space(text())=:label]', array(':label' => $node3->title));
$link_href = (string) $link_xpath[0]['href'];
$link_prefix = base_path() . (variable_get('clean_url', 0) ? '' : '?q=');
$this->assertEqual($link_href, $link_prefix . $alias);
$this->clickLink($node3->title);
$this->assertResponse(404);
}
/**
* Returns the path ID.
*
* @param $alias
* A string containing an aliased path.
*
* @return int
* Integer representing the path ID.
*/
function getPID($alias) {
return db_query("SELECT pid FROM {url_alias} WHERE alias = :alias", array(':alias' => $alias))->fetchField();
}
/**
* Tests that duplicate aliases fail validation.
*/
function testDuplicateNodeAlias() {
// Create one node with a random alias.
$node_one = $this->drupalCreateNode();
$edit = array();
$edit['path[alias]'] = $this->randomName();
$this->drupalPost('node/' . $node_one->nid . '/edit', $edit, t('Save'));
// Now create another node and try to set the same alias.
$node_two = $this->drupalCreateNode();
$this->drupalPost('node/' . $node_two->nid . '/edit', $edit, t('Save'));
$this->assertText(t('The alias is already in use.'));
$this->assertFieldByXPath("//input[@name='path[alias]' and contains(@class, 'error')]", $edit['path[alias]'], 'Textfield exists and has the error class.');
}
}
/**
* Tests URL aliases for taxonomy terms.
*/
class PathTaxonomyTermTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Taxonomy term URL aliases',
'description' => 'Tests URL aliases for taxonomy terms.',
'group' => 'Path',
);
}
function setUp() {
parent::setUp('path', 'taxonomy');
// Create and login user.
$web_user = $this->drupalCreateUser(array('administer url aliases', 'administer taxonomy', 'access administration pages'));
$this->drupalLogin($web_user);
}
/**
* Tests alias functionality through the admin interfaces.
*/
function testTermAlias() {
// Create a term in the default 'Tags' vocabulary with URL alias.
$vocabulary = taxonomy_vocabulary_load(1);
$description = $this->randomName();;
$edit = array();
$edit['name'] = $this->randomName();
$edit['description[value]'] = $description;
$edit['path[alias]'] = $this->randomName();
$this->drupalPost('admin/structure/taxonomy/' . $vocabulary->machine_name . '/add', $edit, t('Save'));
// Confirm that the alias works.
$this->drupalGet($edit['path[alias]']);
$this->assertText($description, 'Term can be accessed on URL alias.');
// Change the term's URL alias.
$tid = db_query("SELECT tid FROM {taxonomy_term_data} WHERE name = :name", array(':name' => $edit['name']))->fetchField();
$edit2 = array();
$edit2['path[alias]'] = $this->randomName();
$this->drupalPost('taxonomy/term/' . $tid . '/edit', $edit2, t('Save'));
// Confirm that the changed alias works.
$this->drupalGet($edit2['path[alias]']);
$this->assertText($description, 'Term can be accessed on changed URL alias.');
// Confirm that the old alias no longer works.
$this->drupalGet($edit['path[alias]']);
$this->assertNoText($description, 'Old URL alias has been removed after altering.');
$this->assertResponse(404, 'Old URL alias returns 404.');
// Remove the term's URL alias.
$edit3 = array();
$edit3['path[alias]'] = '';
$this->drupalPost('taxonomy/term/' . $tid . '/edit', $edit3, t('Save'));
// Confirm that the alias no longer works.
$this->drupalGet($edit2['path[alias]']);
$this->assertNoText($description, 'Old URL alias has been removed after altering.');
$this->assertResponse(404, 'Old URL alias returns 404.');
}
}
/**
* Tests URL aliases for translated nodes.
*/
class PathLanguageTestCase extends DrupalWebTestCase {
protected $web_user;
public static function getInfo() {
return array(
'name' => 'Path aliases with translated nodes',
'description' => 'Confirm that paths work with translated nodes',
'group' => 'Path',
);
}
function setUp() {
parent::setUp('path', 'locale', 'translation');
// Create and login user.
$this->web_user = $this->drupalCreateUser(array('edit any page content', 'create page content', 'administer url aliases', 'create url aliases', 'administer languages', 'translate content', 'access administration pages'));
$this->drupalLogin($this->web_user);
// Enable French language.
$edit = array();
$edit['langcode'] = 'fr';
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add language'));
// Enable URL language detection and selection.
$edit = array('language[enabled][locale-url]' => 1);
$this->drupalPost('admin/config/regional/language/configure', $edit, t('Save settings'));
}
/**
* Test alias functionality through the admin interfaces.
*/
function testAliasTranslation() {
// Set 'page' content type to enable translation.
variable_set('language_content_type_page', 2);
$english_node = $this->drupalCreateNode(array('type' => 'page'));
$english_alias = $this->randomName();
// Edit the node to set language and path.
$edit = array();
$edit['language'] = 'en';
$edit['path[alias]'] = $english_alias;
$this->drupalPost('node/' . $english_node->nid . '/edit', $edit, t('Save'));
// Confirm that the alias works.
$this->drupalGet($english_alias);
$this->assertText($english_node->title, 'Alias works.');
// Translate the node into French.
$this->drupalGet('node/' . $english_node->nid . '/translate');
$this->clickLink(t('add translation'));
$edit = array();
$langcode = LANGUAGE_NONE;
$edit["title"] = $this->randomName();
$edit["body[$langcode][0][value]"] = $this->randomName();
$french_alias = $this->randomName();
$edit['path[alias]'] = $french_alias;
$this->drupalPost(NULL, $edit, t('Save'));
// Clear the path lookup cache.
drupal_lookup_path('wipe');
// Ensure the node was created.
$french_node = $this->drupalGetNodeByTitle($edit["title"]);
$this->assertTrue(($french_node), 'Node found in database.');
// Confirm that the alias works.
$this->drupalGet('fr/' . $edit['path[alias]']);
$this->assertText($french_node->title, 'Alias for French translation works.');
// Confirm that the alias is returned by url().
drupal_static_reset('language_list');
drupal_static_reset('locale_url_outbound_alter');
$languages = language_list();
$url = url('node/' . $french_node->nid, array('language' => $languages[$french_node->language]));
$this->assertTrue(strpos($url, $edit['path[alias]']), 'URL contains the path alias.');
// Confirm that the alias works even when changing language negotiation
// options. Enable User language detection and selection over URL one.
$edit = array(
'language[enabled][locale-user]' => 1,
'language[weight][locale-user]' => -9,
'language[enabled][locale-url]' => 1,
'language[weight][locale-url]' => -8,
);
$this->drupalPost('admin/config/regional/language/configure', $edit, t('Save settings'));
// Change user language preference.
$edit = array('language' => 'fr');
$this->drupalPost("user/{$this->web_user->uid}/edit", $edit, t('Save'));
// Check that the English alias works. In this situation French is the
// current UI and content language, while URL language is English (since we
// do not have a path prefix we fall back to the site's default language).
// We need to ensure that the user language preference is not taken into
// account while determining the path alias language, because if this
// happens we have no way to check that the path alias is valid: there is no
// path alias for French matching the english alias. So drupal_lookup_path()
// needs to use the URL language to check whether the alias is valid.
$this->drupalGet($english_alias);
$this->assertText($english_node->title, 'Alias for English translation works.');
// Check that the French alias works.
$this->drupalGet("fr/$french_alias");
$this->assertText($french_node->title, 'Alias for French translation works.');
// Disable URL language negotiation.
$edit = array('language[enabled][locale-url]' => FALSE);
$this->drupalPost('admin/config/regional/language/configure', $edit, t('Save settings'));
// Check that the English alias still works.
$this->drupalGet($english_alias);
$this->assertText($english_node->title, 'Alias for English translation works.');
// Check that the French alias is not available. We check the unprefixed
// alias because we disabled URL language negotiation above. In this
// situation only aliases in the default language and language neutral ones
// should keep working.
$this->drupalGet($french_alias);
$this->assertResponse(404, 'Alias for French translation is unavailable when URL language negotiation is disabled.');
// drupal_lookup_path() has an internal static cache. Check to see that
// it has the appropriate contents at this point.
drupal_lookup_path('wipe');
$french_node_path = drupal_lookup_path('source', $french_alias, $french_node->language);
$this->assertEqual($french_node_path, 'node/' . $french_node->nid, 'Normal path works.');
// Second call should return the same path.
$french_node_path = drupal_lookup_path('source', $french_alias, $french_node->language);
$this->assertEqual($french_node_path, 'node/' . $french_node->nid, 'Normal path is the same.');
// Confirm that the alias works.
$french_node_alias = drupal_lookup_path('alias', 'node/' . $french_node->nid, $french_node->language);
$this->assertEqual($french_node_alias, $french_alias, 'Alias works.');
// Second call should return the same alias.
$french_node_alias = drupal_lookup_path('alias', 'node/' . $french_node->nid, $french_node->language);
$this->assertEqual($french_node_alias, $french_alias, 'Alias is the same.');
}
}
/**
* Tests the user interface for creating path aliases, with languages.
*/
class PathLanguageUITestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Path aliases with languages',
'description' => 'Confirm that the Path module user interface works with languages.',
'group' => 'Path',
);
}
function setUp() {
parent::setUp('path', 'locale');
// Create and login user.
$web_user = $this->drupalCreateUser(array('edit any page content', 'create page content', 'administer url aliases', 'create url aliases', 'administer languages', 'access administration pages'));
$this->drupalLogin($web_user);
// Enable French language.
$edit = array();
$edit['langcode'] = 'fr';
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add language'));
// Enable URL language detection and selection.
$edit = array('language[enabled][locale-url]' => 1);
$this->drupalPost('admin/config/regional/language/configure', $edit, t('Save settings'));
}
/**
* Tests that a language-neutral URL alias works.
*/
function testLanguageNeutralURLs() {
$name = $this->randomName(8);
$edit = array();
$edit['source'] = 'admin/config/search/path';
$edit['alias'] = $name;
$this->drupalPost('admin/config/search/path/add', $edit, t('Save'));
$this->drupalGet($name);
$this->assertText(t('Filter aliases'), 'Language-neutral URL alias works');
}
/**
* Tests that a default language URL alias works.
*/
function testDefaultLanguageURLs() {
$name = $this->randomName(8);
$edit = array();
$edit['source'] = 'admin/config/search/path';
$edit['alias'] = $name;
$edit['language'] = 'en';
$this->drupalPost('admin/config/search/path/add', $edit, t('Save'));
$this->drupalGet($name);
$this->assertText(t('Filter aliases'), 'English URL alias works');
}
/**
* Tests that a non-default language URL alias works.
*/
function testNonDefaultURLs() {
$name = $this->randomName(8);
$edit = array();
$edit['source'] = 'admin/config/search/path';
$edit['alias'] = $name;
$edit['language'] = 'fr';
$this->drupalPost('admin/config/search/path/add', $edit, t('Save'));
$this->drupalGet('fr/' . $name);
$this->assertText(t('Filter aliases'), 'Foreign URL alias works');
}
}
/**
* Tests that paths are not prefixed on a monolingual site.
*/
class PathMonolingualTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Paths on non-English monolingual sites',
'description' => 'Confirm that paths are not changed on monolingual non-English sites',
'group' => 'Path',
);
}
function setUp() {
global $language;
parent::setUp('path', 'locale', 'translation');
// Create and login user.
$web_user = $this->drupalCreateUser(array('administer languages', 'access administration pages'));
$this->drupalLogin($web_user);
// Enable French language.
$edit = array();
$edit['langcode'] = 'fr';
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add language'));
// Make French the default language.
$edit = array('site_default' => 'fr');
$this->drupalPost('admin/config/regional/language', $edit, t('Save configuration'));
// Disable English.
$edit = array('enabled[en]' => FALSE);
$this->drupalPost('admin/config/regional/language', $edit, t('Save configuration'));
// Verify that French is the only language.
$this->assertFalse(drupal_multilingual(), 'Site is mono-lingual');
$this->assertEqual(language_default('language'), 'fr', 'French is the default language');
// Set language detection to URL.
$edit = array('language[enabled][locale-url]' => TRUE);
$this->drupalPost('admin/config/regional/language/configure', $edit, t('Save settings'));
// Force languages to be initialized.
drupal_language_initialize();
}
/**
* Verifies that links do not have language prefixes in them.
*/
function testPageLinks() {
// Navigate to 'admin/config' path.
$this->drupalGet('admin/config');
// Verify that links in this page do not have a 'fr/' prefix.
$this->assertNoLinkByHref('/fr/', 'Links do not contain language prefix');
// Verify that links in this page can be followed and work.
$this->clickLink(t('Languages'));
$this->assertResponse(200, 'Clicked link results in a valid page');
$this->assertText(t('Add language'), 'Page contains the add language text');
}
}
name = PHP filter
description = Allows embedded PHP code/snippets to be evaluated.
package = Core
version = VERSION
core = 7.x
files[] = php.test
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
'PHP code'))->fetchField();
// Add a PHP code text format, if it does not exist. Do this only for the
// first install (or if the format has been manually deleted) as there is no
// reliable method to identify the format in an uninstall hook or in
// subsequent clean installs.
if (!$format_exists) {
$php_format = array(
'format' => 'php_code',
'name' => 'PHP code',
// 'Plain text' format is installed with a weight of 10 by default. Use a
// higher weight here to ensure that this format will not be the default
// format for anyone.
'weight' => 11,
'filters' => array(
// Enable the PHP evaluator filter.
'php_code' => array(
'weight' => 0,
'status' => 1,
),
),
);
$php_format = (object) $php_format;
filter_format_save($php_format);
drupal_set_message(t('A PHP code text format has been created.', array('@php-code' => url('admin/config/content/formats/' . $php_format->format))));
}
}
/**
* Implements hook_disable().
*/
function php_disable() {
drupal_set_message(t('The PHP module has been disabled. Any existing content that was using the PHP filter will now be visible in plain text. This might pose a security risk by exposing sensitive information, if any, used in the PHP code.'));
}
' . t('About') . '';
$output .= '' . t('The PHP filter module adds a PHP filter to your site, for use with text formats . This filter adds the ability to execute PHP code in any text field that uses a text format (such as the body of a content item or the text of a comment). PHP is a general-purpose scripting language widely-used for web development, and is the language with which Drupal has been developed. For more information, see the online handbook entry for the PHP filter module .', array('@filter' => url('admin/help/filter'), '@php-net' => 'http://www.php.net', '@php' => 'http://drupal.org/documentation/modules/php/')) . '
';
$output .= '' . t('Uses') . ' ';
$output .= '';
$output .= '' . t('Enabling execution of PHP in text fields') . ' ';
$output .= '' . t('The PHP filter module allows users with the proper permissions to include custom PHP code that will get executed when pages of your site are processed. While this is a powerful and flexible feature if used by a trusted user with PHP experience, it is a significant and dangerous security risk in the hands of a malicious or inexperienced user. Even a trusted user may accidentally compromise the site by entering malformed or incorrect PHP code. Only the most trusted users should be granted permission to use the PHP filter, and all PHP code added through the PHP filter should be carefully examined before use. Example PHP snippets can be found on Drupal.org.', array('@php-snippets' => url('http://drupal.org/documentation/customization/php-snippets'))) . ' ';
$output .= ' ';
return $output;
}
}
/**
* Implements hook_permission().
*/
function php_permission() {
return array(
'use PHP for settings' => array(
'title' => t('Use PHP for settings'),
'restrict access' => TRUE,
),
);
}
/**
* Evaluates a string of PHP code.
*
* This is a wrapper around PHP's eval(). It uses output buffering to capture
* both returned and printed text. Unlike eval(), we require code to be
* surrounded by tags; in other words, we evaluate the code as if it
* were a stand-alone PHP file.
*
* Using this wrapper also ensures that the PHP code which is evaluated can not
* overwrite any variables in the calling code, unlike a regular eval() call.
*
* This function is also used as an implementation of
* callback_filter_process().
*
* @param $code
* The code to evaluate.
*
* @return
* A string containing the printed output of the code, followed by the
* returned output of the code.
*
* @ingroup php_wrappers
*
* @see php_filter_info()
*/
function php_eval($code) {
global $theme_path, $theme_info, $conf;
// Store current theme path.
$old_theme_path = $theme_path;
// Restore theme_path to the theme, as long as php_eval() executes,
// so code evaluated will not see the caller module as the current theme.
// If theme info is not initialized get the path from theme_default.
if (!isset($theme_info)) {
$theme_path = drupal_get_path('theme', $conf['theme_default']);
}
else {
$theme_path = dirname($theme_info->filename);
}
ob_start();
print eval('?>' . $code);
$output = ob_get_contents();
ob_end_clean();
// Recover original theme path.
$theme_path = $old_theme_path;
return $output;
}
/**
* Implements callback_filter_tips().
*
* @see php_filter_info()
*/
function _php_filter_tips($filter, $format, $long = FALSE) {
global $base_url;
if ($long) {
$output = '' . t('Using custom PHP code') . ' ';
$output .= '' . t('Custom PHP code may be embedded in some types of site content, including posts and blocks. While embedding PHP code inside a post or block is a powerful and flexible feature when used by a trusted user with PHP experience, it is a significant and dangerous security risk when used improperly. Even a small mistake when posting PHP code may accidentally compromise your site.') . '
';
$output .= '' . t('If you are unfamiliar with PHP, SQL, or Drupal, avoid using custom PHP code within posts. Experimenting with PHP may corrupt your database, render your site inoperable, or significantly compromise security.') . '
';
$output .= '' . t('Notes:') . '
';
$output .= '' . t('Remember to double-check each line for syntax and logic errors before saving.') . ' ';
$output .= '' . t('Statements must be correctly terminated with semicolons.') . ' ';
$output .= '' . t('Global variables used within your PHP code retain their values after your script executes.') . ' ';
$output .= '' . t('register_globals is turned off . If you need to use forms, understand and use the functions in the Drupal Form API .', array('@formapi' => url('http://api.drupal.org/api/group/form_api/7'))) . ' ';
$output .= '' . t('Use a print or return statement in your code to output content.') . ' ';
$output .= '' . t('Develop and test your PHP code using a separate test script and sample database before deploying on a production site.') . ' ';
$output .= '' . t('Consider including your custom PHP code within a site-specific module or template.php file rather than embedding it directly into a post or block.') . ' ';
$output .= '' . t('Be aware that the ability to embed PHP code within content is provided by the PHP Filter module. If this module is disabled or deleted, then blocks and posts with embedded PHP may display, rather than execute, the PHP code.') . ' ' . t('A basic example: Creating a "Welcome" block that greets visitors with a simple message. ') . '
';
$output .= '' . t('Add a custom block to your site, named "Welcome" . With its text format set to "PHP code" (or another format supporting PHP input), add the following in the Block body:
print t(\'Welcome visitor! Thank you for visiting.\');
') . ' ';
$output .= '' . t('To display the name of a registered user, use this instead:
global $user;
if ($user->uid) {
print t(\'Welcome @name! Thank you for visiting.\', array(\'@name\' => format_username($user)));
}
else {
print t(\'Welcome visitor! Thank you for visiting.\');
}
') . ' ' . t('Drupal.org offers some example PHP snippets , or you can create your own with some PHP experience and knowledge of the Drupal system.', array('@drupal' => url('http://drupal.org'), '@php-snippets' => url('http://drupal.org/documentation/customization/php-snippets'))) . '
';
return $output;
}
else {
return t('You may post PHP code. You should include <?php ?> tags.');
}
}
/**
* Implements hook_filter_info().
*
* Provide PHP code filter. Use with care.
*/
function php_filter_info() {
$filters['php_code'] = array(
'title' => t('PHP evaluator'),
'description' => t('Executes a piece of PHP code. The usage of this filter should be restricted to administrators only!'),
'process callback' => 'php_eval',
'tips callback' => '_php_filter_tips',
'cache' => FALSE,
);
return $filters;
}
drupalCreateUser(array('administer filters'));
$this->drupalLogin($admin_user);
// Verify that the PHP code text format was inserted.
$php_format_id = 'php_code';
$this->php_code_format = filter_format_load($php_format_id);
$this->assertEqual($this->php_code_format->name, 'PHP code', 'PHP code text format was created.');
// Verify that the format has the PHP code filter enabled.
$filters = filter_list_format($php_format_id);
$this->assertTrue($filters['php_code']->status, 'PHP code filter is enabled.');
// Verify that the format exists on the administration page.
$this->drupalGet('admin/config/content/formats');
$this->assertText('PHP code', 'PHP code text format was created.');
// Verify that anonymous and authenticated user roles do not have access.
$this->drupalGet('admin/config/content/formats/' . $php_format_id);
$this->assertFieldByName('roles[' . DRUPAL_ANONYMOUS_RID . ']', FALSE, 'Anonymous users do not have access to PHP code format.');
$this->assertFieldByName('roles[' . DRUPAL_AUTHENTICATED_RID . ']', FALSE, 'Authenticated users do not have access to PHP code format.');
}
/**
* Creates a test node with PHP code in the body.
*
* @return stdObject Node object.
*/
function createNodeWithCode() {
return $this->drupalCreateNode(array('body' => array(LANGUAGE_NONE => array(array('value' => '')))));
}
}
/**
* Tests to make sure the PHP filter actually evaluates PHP code when used.
*/
class PHPFilterTestCase extends PHPTestCase {
public static function getInfo() {
return array(
'name' => 'PHP filter functionality',
'description' => 'Make sure that PHP filter properly evaluates PHP code when enabled.',
'group' => 'PHP',
);
}
/**
* Makes sure that the PHP filter evaluates PHP code when used.
*/
function testPHPFilter() {
// Log in as a user with permission to use the PHP code text format.
$php_code_permission = filter_permission_name(filter_format_load('php_code'));
$web_user = $this->drupalCreateUser(array('access content', 'create page content', 'edit own page content', $php_code_permission));
$this->drupalLogin($web_user);
// Create a node with PHP code in it.
$node = $this->createNodeWithCode();
// Make sure that the PHP code shows up as text.
$this->drupalGet('node/' . $node->nid);
$this->assertText('print "SimpleTest PHP was executed!"', 'PHP code is displayed.');
// Change filter to PHP filter and see that PHP code is evaluated.
$edit = array();
$langcode = LANGUAGE_NONE;
$edit["body[$langcode][0][format]"] = $this->php_code_format->format;
$this->drupalPost('node/' . $node->nid . '/edit', $edit, t('Save'));
$this->assertRaw(t('Basic page %title has been updated.', array('%title' => $node->title)), 'PHP code filter turned on.');
// Make sure that the PHP code shows up as text.
$this->assertNoText('print "SimpleTest PHP was executed!"', "PHP code isn't displayed.");
$this->assertText('SimpleTest PHP was executed!', 'PHP code has been evaluated.');
}
}
/**
* Tests to make sure access to the PHP filter is properly restricted.
*/
class PHPAccessTestCase extends PHPTestCase {
public static function getInfo() {
return array(
'name' => 'PHP filter access check',
'description' => 'Make sure that users who don\'t have access to the PHP filter can\'t see it.',
'group' => 'PHP',
);
}
/**
* Makes sure that the user can't use the PHP filter when not given access.
*/
function testNoPrivileges() {
// Create node with PHP filter enabled.
$web_user = $this->drupalCreateUser(array('access content', 'create page content', 'edit own page content'));
$this->drupalLogin($web_user);
$node = $this->createNodeWithCode();
// Make sure that the PHP code shows up as text.
$this->drupalGet('node/' . $node->nid);
$this->assertText('print', 'PHP code was not evaluated.');
// Make sure that user doesn't have access to filter.
$this->drupalGet('node/' . $node->nid . '/edit');
$this->assertNoRaw('', 'PHP code format not available.');
}
}
%
% ()
.poll .bar .foreground {
float: right;
}
.poll .percent {
text-align: left;
}
.poll .vote-form .choices {
text-align: right;
}
.poll {
overflow: hidden;
}
.poll .bar {
height: 1em;
margin: 1px 0;
background-color: #ddd;
}
.poll .bar .foreground {
background-color: #000;
height: 1em;
float: left; /* LTR */
}
.poll .links {
text-align: center;
}
.poll .percent {
text-align: right; /* LTR */
}
.poll .total {
text-align: center;
}
.poll .vote-form {
text-align: center;
}
.poll .vote-form .choices {
text-align: left; /* LTR */
margin: 0 auto;
display: table;
}
.poll .vote-form .choices .title {
font-weight: bold;
}
.node-form #edit-poll-more {
margin: 0;
}
.node-form #poll-choice-table .form-text {
display: inline;
width: auto;
}
.node-form #poll-choice-table td.choice-flag {
white-space: nowrap;
width: 4em;
}
td.poll-chtext {
width: 80%;
}
td.poll-chvotes .form-text {
width: 85%;
}
name = Poll
description = Allows your site to capture votes on different topics in the form of multiple choice questions.
package = Core
version = VERSION
core = 7.x
files[] = poll.test
stylesheets[all][] = poll.css
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
'Stores poll-specific information for poll nodes.',
'fields' => array(
'nid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => "The poll's {node}.nid.",
),
'runtime' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'The number of seconds past {node}.created during which the poll is open.',
),
'active' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => 'Boolean indicating whether or not the poll is open.',
),
),
'primary key' => array('nid'),
'foreign keys' => array(
'poll_node' => array(
'table' => 'node',
'columns' => array('nid' => 'nid'),
),
),
);
$schema['poll_choice'] = array(
'description' => 'Stores information about all choices for all {poll}s.',
'fields' => array(
'chid' => array(
'type' => 'serial',
'unsigned' => TRUE,
'not null' => TRUE,
'description' => 'Unique identifier for a poll choice.',
),
'nid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => 'The {node}.nid this choice belongs to.',
),
'chtext' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
'description' => 'The text for this choice.',
'translatable' => TRUE,
),
'chvotes' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'The total number of votes this choice has received by all users.',
),
'weight' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'The sort order of this choice among all choices for the same node.',
),
),
'indexes' => array(
'nid' => array('nid'),
),
'primary key' => array('chid'),
'foreign keys' => array(
'choice_node' => array(
'table' => 'node',
'columns' => array('nid' => 'nid'),
),
),
);
$schema['poll_vote'] = array(
'description' => 'Stores per-{users} votes for each {poll}.',
'fields' => array(
'chid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'description' => "The {users}'s vote for this poll.",
),
'nid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'description' => 'The {poll} node this vote is for.',
),
'uid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => 'The {users}.uid this vote is from unless the voter was anonymous.',
),
'hostname' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
'description' => 'The IP address this vote is from unless the voter was logged in.',
),
'timestamp' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'The timestamp of the vote creation.',
),
),
'primary key' => array('nid', 'uid', 'hostname'),
'foreign keys' => array(
'poll_node' => array(
'table' => 'node',
'columns' => array('nid' => 'nid'),
),
'voter' => array(
'table' => 'users',
'columns' => array('uid' => 'uid'),
),
),
'indexes' => array(
'chid' => array('chid'),
'hostname' => array('hostname'),
'uid' => array('uid'),
),
);
return $schema;
}
/**
* Use the poll_choice primary key to record votes in poll_votes rather than
* the choice order. Rename chorder to weight.
*
* Rename {poll_choices} table to {poll_choice} and {poll_votes} to {poll_vote}.
*/
function poll_update_7001() {
// Add chid column and convert existing votes.
db_add_field('poll_votes', 'chid', array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0));
db_add_index('poll_votes', 'chid', array('chid'));
db_update('poll_votes')
->expression('chid', Database::getConnection()->prefixTables('COALESCE((SELECT chid FROM {poll_choices} c WHERE {poll_votes}.chorder = c.chorder AND {poll_votes}.nid = c.nid), 0)'))
->execute();
// Delete invalid votes.
db_delete('poll_votes')->condition('chid', 0)->execute();
// Remove old chorder column.
db_drop_field('poll_votes', 'chorder');
// Change the chorder column to weight in poll_choices.
db_change_field('poll_choices', 'chorder', 'weight', array('type' => 'int', 'not null' => TRUE, 'default' => 0, 'size' => 'tiny'));
db_rename_table('poll_votes', 'poll_vote');
db_rename_table('poll_choices', 'poll_choice');
}
/**
* Add timestamp field to {poll_vote}.
*/
function poll_update_7002() {
$field = array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
);
db_add_field('poll_vote', 'timestamp', $field);
}
/**
* Change the weight column to normal int.
*/
function poll_update_7003() {
db_change_field('poll_choice', 'weight', 'weight', array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'The sort order of this choice among all choices for the same node.',
));
}
/**
* @addtogroup updates-7.x-extra
* @{
*/
/**
* Update the database to match the schema.
*/
function poll_update_7004() {
// Remove field default.
db_change_field('poll_vote', 'chid', 'chid', array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE));
}
/**
* @} End of "addtogroup updates-7.x-extra".
*/
' . t('About') . '';
$output .= '' . t('The Poll module can be used to create simple surveys or questionnaires that display cumulative results. A poll is a good way to receive feedback from site users and community members. For more information, see the online handbook entry for the Poll module .', array('@poll' => 'http://drupal.org/documentation/modules/poll/')) . '
';
$output .= '' . t('Uses') . ' ';
$output .= '';
$output .= '' . t('Creating a poll') . ' ';
$output .= '' . t('Users can create a poll by clicking on Poll on the Add new content page, and entering the question being posed, the answer choices, and beginning vote counts for each choice. The status (closed or active) and duration (length of time the poll remains active for new votes) can also be specified.', array('@add-content' => url('node/add'))) . ' ';
$output .= '' . t('Viewing polls') . ' ';
$output .= '' . t('You can visit the Polls page to view all current polls, or alternately enable the Most recent poll block on the Blocks administration page . To vote in or view the results of a specific poll, you can click on the poll itself.', array('@poll' => url('poll'), '@blocks' => url('admin/structure/block'))) . ' ';
$output .= ' ';
return $output;
}
}
/**
* Implements hook_theme().
*/
function poll_theme() {
$theme_hooks = array(
'poll_vote' => array(
'template' => 'poll-vote',
'render element' => 'form',
),
'poll_choices' => array(
'render element' => 'form',
),
'poll_results' => array(
'template' => 'poll-results',
'variables' => array('raw_title' => NULL, 'results' => NULL, 'votes' => NULL, 'raw_links' => NULL, 'block' => NULL, 'nid' => NULL, 'vote' => NULL),
),
'poll_bar' => array(
'template' => 'poll-bar',
'variables' => array('title' => NULL, 'votes' => NULL, 'total_votes' => NULL, 'vote' => NULL, 'block' => NULL),
),
);
// The theme system automatically discovers the theme's functions and
// templates that implement more targeted "suggestions" of generic theme
// hooks. But suggestions implemented by a module must be explicitly
// registered.
$theme_hooks += array(
'poll_results__block' => array(
'template' => 'poll-results--block',
'variables' => $theme_hooks['poll_results']['variables'],
),
'poll_bar__block' => array(
'template' => 'poll-bar--block',
'variables' => $theme_hooks['poll_bar']['variables'],
),
);
return $theme_hooks;
}
/**
* Implements hook_permission().
*/
function poll_permission() {
$perms = array(
'vote on polls' => array(
'title' => t('Vote on polls'),
),
'cancel own vote' => array(
'title' => t('Cancel and change own votes'),
),
'inspect all votes' => array(
'title' => t('View details for all votes'),
),
);
return $perms;
}
/**
* Implements hook_menu().
*/
function poll_menu() {
$items['poll'] = array(
'title' => 'Polls',
'page callback' => 'poll_page',
'access arguments' => array('access content'),
'type' => MENU_SUGGESTED_ITEM,
'file' => 'poll.pages.inc',
);
$items['node/%node/votes'] = array(
'title' => 'Votes',
'page callback' => 'poll_votes',
'page arguments' => array(1),
'access callback' => '_poll_menu_access',
'access arguments' => array(1, 'inspect all votes', FALSE),
'weight' => 3,
'type' => MENU_LOCAL_TASK,
'file' => 'poll.pages.inc',
);
$items['node/%node/results'] = array(
'title' => 'Results',
'page callback' => 'poll_results',
'page arguments' => array(1),
'access callback' => '_poll_menu_access',
'access arguments' => array(1, 'access content', TRUE),
'weight' => 3,
'type' => MENU_LOCAL_TASK,
'file' => 'poll.pages.inc',
);
return $items;
}
/**
* Callback function to see if a node is acceptable for poll menu items.
*/
function _poll_menu_access($node, $perm, $inspect_allowvotes) {
return user_access($perm) && ($node->type == 'poll') && ($node->allowvotes || !$inspect_allowvotes);
}
/**
* Implements hook_block_info().
*/
function poll_block_info() {
$blocks['recent']['info'] = t('Most recent poll');
$blocks['recent']['properties']['administrative'] = TRUE;
return $blocks;
}
/**
* Implements hook_block_view().
*
* Generates a block containing the latest poll.
*/
function poll_block_view($delta = '') {
if (user_access('access content')) {
// Retrieve the latest poll.
$select = db_select('node', 'n');
$select->join('poll', 'p', 'p.nid = n.nid');
$select->fields('n', array('nid'))
->condition('n.status', 1)
->condition('p.active', 1)
->orderBy('n.created', 'DESC')
->range(0, 1)
->addTag('node_access');
$record = $select->execute()->fetchObject();
if ($record) {
$poll = node_load($record->nid);
if ($poll->nid) {
$poll = poll_block_latest_poll_view($poll);
$block['subject'] = t('Poll');
$block['content'] = $poll->content;
return $block;
}
}
}
}
/**
* Implements hook_cron().
*
* Closes polls that have exceeded their allowed runtime.
*/
function poll_cron() {
$nids = db_query('SELECT p.nid FROM {poll} p INNER JOIN {node} n ON p.nid = n.nid WHERE (n.created + p.runtime) < :request_time AND p.active = :active AND p.runtime <> :runtime', array(':request_time' => REQUEST_TIME, ':active' => 1, ':runtime' => 0))->fetchCol();
if (!empty($nids)) {
db_update('poll')
->fields(array('active' => 0))
->condition('nid', $nids, 'IN')
->execute();
}
}
/**
* Implements hook_node_info().
*/
function poll_node_info() {
return array(
'poll' => array(
'name' => t('Poll'),
'base' => 'poll',
'description' => t('A poll is a question with a set of possible responses. A poll , once created, automatically provides a simple running count of the number of votes received for each response.'),
'title_label' => t('Question'),
)
);
}
/**
* Implements hook_field_extra_fields().
*/
function poll_field_extra_fields() {
$extra['node']['poll'] = array(
'form' => array(
'choice_wrapper' => array(
'label' => t('Poll choices'),
'description' => t('Poll choices'),
'weight' => -4,
),
'settings' => array(
'label' => t('Poll settings'),
'description' => t('Poll module settings'),
'weight' => -3,
),
),
'display' => array(
'poll_view_voting' => array(
'label' => t('Poll vote'),
'description' => t('Poll vote'),
'weight' => 0,
),
'poll_view_results' => array(
'label' => t('Poll results'),
'description' => t('Poll results'),
'weight' => 0,
),
)
);
return $extra;
}
/**
* Implements hook_form().
*/
function poll_form($node, &$form_state) {
global $user;
$admin = user_access('bypass node access') || user_access('edit any poll content') || (user_access('edit own poll content') && $user->uid == $node->uid);
$type = node_type_get_type($node);
// The submit handlers to add more poll choices require that this form is
// cached, regardless of whether Ajax is used.
$form_state['cache'] = TRUE;
$form['title'] = array(
'#type' => 'textfield',
'#title' => check_plain($type->title_label),
'#required' => TRUE,
'#default_value' => $node->title,
'#maxlength' => 255,
'#weight' => -5,
);
if (isset($form_state['choice_count'])) {
$choice_count = $form_state['choice_count'];
}
else {
$choice_count = max(2, empty($node->choice) ? 2 : count($node->choice));
}
// Add a wrapper for the choices and more button.
$form['choice_wrapper'] = array(
'#tree' => FALSE,
'#weight' => -4,
'#prefix' => '',
'#suffix' => '
',
);
// Container for just the poll choices.
$form['choice_wrapper']['choice'] = array(
'#prefix' => '',
'#suffix' => '
',
'#theme' => 'poll_choices',
);
// Add the current choices to the form.
$delta = 0;
$weight = 0;
if (isset($node->choice)) {
$delta = count($node->choice);
foreach ($node->choice as $chid => $choice) {
$key = 'chid:' . $chid;
$form['choice_wrapper']['choice'][$key] = _poll_choice_form($key, $choice['chid'], $choice['chtext'], $choice['chvotes'], $choice['weight'], $choice_count);
$weight = max($choice['weight'], $weight);
}
}
// Add initial or additional choices.
$existing_delta = $delta;
for ($delta; $delta < $choice_count; $delta++) {
$key = 'new:' . ($delta - $existing_delta);
// Increase the weight of each new choice.
$weight++;
$form['choice_wrapper']['choice'][$key] = _poll_choice_form($key, NULL, '', 0, $weight, $choice_count);
}
// We name our button 'poll_more' to avoid conflicts with other modules using
// Ajax-enabled buttons with the id 'more'.
$form['choice_wrapper']['poll_more'] = array(
'#type' => 'submit',
'#value' => t('More choices'),
'#attributes' => array(
'title' => t("If the amount of boxes above isn't enough, click here to add more choices."),
),
'#weight' => 1,
'#limit_validation_errors' => array(array('choice')),
'#submit' => array('poll_more_choices_submit'),
'#ajax' => array(
'callback' => 'poll_choice_js',
'wrapper' => 'poll-choices',
'effect' => 'fade',
),
);
// Poll attributes
$duration = array(
// 1-6 days.
86400, 2 * 86400, 3 * 86400, 4 * 86400, 5 * 86400, 6 * 86400,
// 1-3 weeks (7 days).
604800, 2 * 604800, 3 * 604800,
// 1-3,6,9 months (30 days).
2592000, 2 * 2592000, 3 * 2592000, 6 * 2592000, 9 * 2592000,
// 1 year (365 days).
31536000,
);
$duration = array(0 => t('Unlimited')) + drupal_map_assoc($duration, 'format_interval');
$active = array(0 => t('Closed'), 1 => t('Active'));
$form['settings'] = array(
'#type' => 'fieldset',
'#collapsible' => TRUE,
'#title' => t('Poll settings'),
'#weight' => -3,
'#access' => $admin,
);
$form['settings']['active'] = array(
'#type' => 'radios',
'#title' => t('Poll status'),
'#default_value' => isset($node->active) ? $node->active : 1,
'#options' => $active,
'#description' => t('When a poll is closed, visitors can no longer vote for it.'),
'#access' => $admin,
);
$form['settings']['runtime'] = array(
'#type' => 'select',
'#title' => t('Poll duration'),
'#default_value' => isset($node->runtime) ? $node->runtime : 0,
'#options' => $duration,
'#description' => t('After this period, the poll will be closed automatically.'),
);
return $form;
}
/**
* Submit handler to add more choices to a poll form.
*
* This handler is run regardless of whether JS is enabled or not. It makes
* changes to the form state. If the button was clicked with JS disabled, then
* the page is reloaded with the complete rebuilt form. If the button was
* clicked with JS enabled, then ajax_form_callback() calls poll_choice_js() to
* return just the changed part of the form.
*/
function poll_more_choices_submit($form, &$form_state) {
// If this is a Ajax POST, add 1, otherwise add 5 more choices to the form.
if ($form_state['values']['poll_more']) {
$n = $_GET['q'] == 'system/ajax' ? 1 : 5;
$form_state['choice_count'] = count($form_state['values']['choice']) + $n;
}
// Renumber the choices. This invalidates the corresponding key/value
// associations in $form_state['input'], so clear that out. This requires
// poll_form() to rebuild the choices with the values in
// $form_state['node']->choice, which it does.
$form_state['node']->choice = array_values($form_state['values']['choice']);
unset($form_state['input']['choice']);
$form_state['rebuild'] = TRUE;
}
function _poll_choice_form($key, $chid = NULL, $value = '', $votes = 0, $weight = 0, $size = 10) {
$form = array(
'#tree' => TRUE,
'#weight' => $weight,
);
// We'll manually set the #parents property of these fields so that
// their values appear in the $form_state['values']['choice'] array.
$form['chid'] = array(
'#type' => 'value',
'#value' => $chid,
'#parents' => array('choice', $key, 'chid'),
);
$form['chtext'] = array(
'#type' => 'textfield',
'#title' => $value !== '' ? t('Choice label') : t('New choice label'),
'#title_display' => 'invisible',
'#default_value' => $value,
'#parents' => array('choice', $key, 'chtext'),
);
$form['chvotes'] = array(
'#type' => 'textfield',
'#title' => $value !== '' ? t('Vote count for choice @label', array('@label' => $value)) : t('Vote count for new choice'),
'#title_display' => 'invisible',
'#default_value' => $votes,
'#size' => 5,
'#maxlength' => 7,
'#parents' => array('choice', $key, 'chvotes'),
'#access' => user_access('administer nodes'),
'#element_validate' => array('element_validate_integer'),
);
$form['weight'] = array(
'#type' => 'weight',
'#title' => $value !== '' ? t('Weight for choice @label', array('@label' => $value)) : t('Weight for new choice'),
'#title_display' => 'invisible',
'#default_value' => $weight,
'#delta' => $size,
'#parents' => array('choice', $key, 'weight'),
);
return $form;
}
/**
* Ajax callback in response to new choices being added to the form.
*
* This returns the new page content to replace the page content made obsolete
* by the form submission.
*
* @see poll_more_choices_submit()
*/
function poll_choice_js($form, $form_state) {
return $form['choice_wrapper']['choice'];
}
/**
* Form submit handler for node_form().
*
* Upon preview and final submission, we need to renumber poll choices and
* create a teaser output.
*/
function poll_node_form_submit(&$form, &$form_state) {
// Renumber choices.
$form_state['values']['choice'] = array_values($form_state['values']['choice']);
$form_state['values']['teaser'] = poll_teaser((object) $form_state['values']);
}
/**
* Implements hook_validate().
*/
function poll_validate($node, $form) {
if (isset($node->title)) {
// Check for at least two options and validate amount of votes.
$realchoices = 0;
foreach ($node->choice as $i => $choice) {
if ($choice['chtext'] != '') {
$realchoices++;
}
if (isset($choice['chvotes']) && $choice['chvotes'] < 0) {
form_set_error("choice][$i][chvotes", t('Negative values are not allowed.'));
}
}
if ($realchoices < 2) {
form_set_error("choice][$realchoices][chtext", t('You must fill in at least two choices.'));
}
}
}
/**
* Implements hook_field_attach_prepare_translation_alter().
*/
function poll_field_attach_prepare_translation_alter(&$entity, $context) {
if ($context['entity_type'] == 'node' && $entity->type == 'poll') {
$entity->choice = $context['source_entity']->choice;
foreach ($entity->choice as $i => $options) {
$entity->choice[$i]['chvotes'] = 0;
}
}
}
/**
* Implements hook_load().
*/
function poll_load($nodes) {
global $user;
foreach ($nodes as $node) {
$poll = db_query("SELECT runtime, active FROM {poll} WHERE nid = :nid", array(':nid' => $node->nid))->fetchObject();
if (empty($poll)) {
$poll = new stdClass();
}
// Load the appropriate choices into the $poll object.
$poll->choice = db_select('poll_choice', 'c')
->addTag('translatable')
->fields('c', array('chid', 'chtext', 'chvotes', 'weight'))
->condition('c.nid', $node->nid)
->orderBy('weight')
->execute()->fetchAllAssoc('chid', PDO::FETCH_ASSOC);
// Determine whether or not this user is allowed to vote.
$poll->allowvotes = FALSE;
if (user_access('vote on polls') && $poll->active) {
if ($user->uid) {
// If authenticated, find existing vote based on uid.
$poll->vote = db_query('SELECT chid FROM {poll_vote} WHERE nid = :nid AND uid = :uid', array(':nid' => $node->nid, ':uid' => $user->uid))->fetchField();
if (empty($poll->vote)) {
$poll->vote = -1;
$poll->allowvotes = TRUE;
}
}
elseif (!empty($_SESSION['poll_vote'][$node->nid])) {
// Otherwise the user is anonymous. Look for an existing vote in the
// user's session.
$poll->vote = $_SESSION['poll_vote'][$node->nid];
}
else {
// Finally, query the database for an existing vote based on anonymous
// user's hostname.
$poll->allowvotes = !db_query("SELECT 1 FROM {poll_vote} WHERE nid = :nid AND hostname = :hostname AND uid = 0", array(':nid' => $node->nid, ':hostname' => ip_address()))->fetchField();
}
}
foreach ($poll as $key => $value) {
$nodes[$node->nid]->$key = $value;
}
}
}
/**
* Implements hook_insert().
*/
function poll_insert($node) {
if (!user_access('administer nodes')) {
// Make sure all votes are 0 initially
foreach ($node->choice as $i => $choice) {
$node->choice[$i]['chvotes'] = 0;
}
$node->active = 1;
}
db_insert('poll')
->fields(array(
'nid' => $node->nid,
'runtime' => $node->runtime,
'active' => $node->active,
))
->execute();
foreach ($node->choice as $choice) {
if ($choice['chtext'] != '') {
db_insert('poll_choice')
->fields(array(
'nid' => $node->nid,
'chtext' => $choice['chtext'],
'chvotes' => $choice['chvotes'],
'weight' => $choice['weight'],
))
->execute();
}
}
}
/**
* Implements hook_update().
*/
function poll_update($node) {
// Update poll settings.
db_update('poll')
->fields(array(
'runtime' => $node->runtime,
'active' => $node->active,
))
->condition('nid', $node->nid)
->execute();
// Poll choices with empty titles signifies removal. We remove all votes to
// the removed options, so people who voted on them can vote again.
foreach ($node->choice as $key => $choice) {
if (!empty($choice['chtext'])) {
db_merge('poll_choice')
->key(array('chid' => $choice['chid']))
->fields(array(
'chtext' => $choice['chtext'],
'chvotes' => (int) $choice['chvotes'],
'weight' => $choice['weight'],
))
->insertFields(array(
'nid' => $node->nid,
'chtext' => $choice['chtext'],
'chvotes' => (int) $choice['chvotes'],
'weight' => $choice['weight'],
))
->execute();
}
else {
db_delete('poll_vote')
->condition('nid', $node->nid)
->condition('chid', $key)
->execute();
db_delete('poll_choice')
->condition('nid', $node->nid)
->condition('chid', $choice['chid'])
->execute();
}
}
}
/**
* Implements hook_delete().
*/
function poll_delete($node) {
db_delete('poll')
->condition('nid', $node->nid)
->execute();
db_delete('poll_choice')
->condition('nid', $node->nid)
->execute();
db_delete('poll_vote')
->condition('nid', $node->nid)
->execute();
}
/**
* Return content for 'latest poll' block.
*
* @param $node
* The node object to load.
*/
function poll_block_latest_poll_view($node) {
// This is necessary for shared objects because PHP doesn't copy objects, but
// passes them by reference. So when the objects are cached it can result in
// the wrong output being displayed on subsequent calls. The cloning and
// unsetting of $node->content prevents the block output from being the same
// as the node output.
$node = clone $node;
unset($node->content);
// No 'read more' link.
$node->readmore = FALSE;
$node->teaser = '';
$links = array();
$links[] = array('title' => t('Older polls'), 'href' => 'poll', 'attributes' => array('title' => t('View the list of polls on this site.')));
if ($node->allowvotes) {
$links[] = array('title' => t('Results'), 'href' => 'node/' . $node->nid . '/results', 'attributes' => array('title' => t('View the current poll results.')));
}
$node->links = $links;
if (!empty($node->allowvotes)) {
$node->content['poll_view_voting'] = drupal_get_form('poll_view_voting', $node, TRUE);
$node->content['links'] = array(
'#theme' => 'links',
'#links' => $node->links,
'#weight' => 5,
);
}
else {
$node->content['poll_view_results'] = array('#markup' => poll_view_results($node, TRUE, TRUE));
}
return $node;
}
/**
* Implements hook_view().
*/
function poll_view($node, $view_mode) {
if (!empty($node->allowvotes) && empty($node->show_results)) {
$node->content['poll_view_voting'] = drupal_get_form('poll_view_voting', $node);
}
else {
$node->content['poll_view_results'] = array('#markup' => poll_view_results($node, $view_mode));
}
return $node;
}
/**
* Creates a simple teaser that lists all the choices.
*
* This is primarily used for RSS.
*/
function poll_teaser($node) {
$teaser = NULL;
if (is_array($node->choice)) {
foreach ($node->choice as $choice) {
if ($choice['chtext'] != '') {
$teaser .= '* ' . check_plain($choice['chtext']) . "\n";
}
}
}
return $teaser;
}
/**
* Generates the voting form for a poll.
*
* @ingroup forms
* @see poll_vote()
* @see phptemplate_preprocess_poll_vote()
*/
function poll_view_voting($form, &$form_state, $node, $block = FALSE) {
if ($node->choice) {
$list = array();
foreach ($node->choice as $i => $choice) {
$list[$i] = check_plain($choice['chtext']);
}
$form['choice'] = array(
'#type' => 'radios',
'#title' => t('Choices'),
'#title_display' => 'invisible',
'#options' => $list,
);
}
$form['vote'] = array(
'#type' => 'submit',
'#value' => t('Vote'),
'#submit' => array('poll_vote'),
);
// Store the node so we can get to it in submit functions.
$form['#node'] = $node;
$form['#block'] = $block;
// Set form caching because we could have multiple of these forms on
// the same page, and we want to ensure the right one gets picked.
$form_state['cache'] = TRUE;
// Provide a more cleanly named voting form theme.
$form['#theme'] = 'poll_vote';
return $form;
}
/**
* Validation function for processing votes
*/
function poll_view_voting_validate($form, &$form_state) {
if (empty($form_state['values']['choice'])) {
form_set_error( 'choice', t('Your vote could not be recorded because you did not select any of the choices.'));
}
}
/**
* Submit handler for processing a vote.
*/
function poll_vote($form, &$form_state) {
$node = $form['#node'];
$choice = $form_state['values']['choice'];
global $user;
db_insert('poll_vote')
->fields(array(
'nid' => $node->nid,
'chid' => $choice,
'uid' => $user->uid,
'hostname' => ip_address(),
'timestamp' => REQUEST_TIME,
))
->execute();
// Add one to the votes.
db_update('poll_choice')
->expression('chvotes', 'chvotes + 1')
->condition('chid', $choice)
->execute();
cache_clear_all();
if (!$user->uid) {
// The vote is recorded so the user gets the result view instead of the
// voting form when viewing the poll. Saving a value in $_SESSION has the
// convenient side effect of preventing the user from hitting the page
// cache. When anonymous voting is allowed, the page cache should only
// contain the voting form, not the results.
$_SESSION['poll_vote'][$node->nid] = $choice;
}
drupal_set_message(t('Your vote was recorded.'));
// Return the user to whatever page they voted from.
}
/**
* Themes the voting form for a poll.
*
* Inputs: $form
*/
function template_preprocess_poll_vote(&$variables) {
$form = $variables['form'];
$variables['choice'] = drupal_render($form['choice']);
$variables['title'] = check_plain($form['#node']->title);
$variables['vote'] = drupal_render($form['vote']);
$variables['rest'] = drupal_render_children($form);
$variables['block'] = $form['#block'];
if ($variables['block']) {
$variables['theme_hook_suggestions'][] = 'poll_vote__block';
}
}
/**
* Generates a graphical representation of the results of a poll.
*/
function poll_view_results($node, $view_mode, $block = FALSE) {
// Make sure that choices are ordered by their weight.
uasort($node->choice, 'drupal_sort_weight');
// Count the votes and find the maximum.
$total_votes = 0;
$max_votes = 0;
foreach ($node->choice as $choice) {
if (isset($choice['chvotes'])) {
$total_votes += $choice['chvotes'];
$max_votes = max($max_votes, $choice['chvotes']);
}
}
$poll_results = '';
foreach ($node->choice as $i => $choice) {
if (!empty($choice['chtext'])) {
$chvotes = isset($choice['chvotes']) ? $choice['chvotes'] : NULL;
$poll_results .= theme('poll_bar', array('title' => $choice['chtext'], 'votes' => $chvotes, 'total_votes' => $total_votes, 'vote' => isset($node->vote) && $node->vote == $i, 'block' => $block));
}
}
return theme('poll_results', array('raw_title' => $node->title, 'results' => $poll_results, 'votes' => $total_votes, 'raw_links' => isset($node->links) ? $node->links : array(), 'block' => $block, 'nid' => $node->nid, 'vote' => isset($node->vote) ? $node->vote : NULL));
}
/**
* Returns HTML for an admin poll form for choices.
*
* @param $variables
* An associative array containing:
* - form: A render element representing the form.
*
* @ingroup themeable
*/
function theme_poll_choices($variables) {
$form = $variables['form'];
drupal_add_tabledrag('poll-choice-table', 'order', 'sibling', 'poll-weight');
$is_admin= user_access('administer nodes');
$delta = 0;
$rows = array();
$headers = array('', t('Choice'));
if ($is_admin) {
$headers[] = t('Vote count');
}
$headers[] = t('Weight');
foreach (element_children($form) as $key) {
$delta++;
// Set special classes for drag and drop updating.
$form[$key]['weight']['#attributes']['class'] = array('poll-weight');
// Build the table row.
$row = array(
'data' => array(
array('class' => array('choice-flag')),
drupal_render($form[$key]['chtext']),
),
'class' => array('draggable'),
);
if ($is_admin) {
$row['data'][] = drupal_render($form[$key]['chvotes']);
}
$row['data'][] = drupal_render($form[$key]['weight']);
// Add any additional classes set on the row.
if (!empty($form[$key]['#attributes']['class'])) {
$row['class'] = array_merge($row['class'], $form[$key]['#attributes']['class']);
}
$rows[] = $row;
}
$output = theme('table', array('header' => $headers, 'rows' => $rows, 'attributes' => array('id' => 'poll-choice-table')));
$output .= drupal_render_children($form);
return $output;
}
/**
* Preprocess the poll_results theme hook.
*
* Inputs: $raw_title, $results, $votes, $raw_links, $block, $nid, $vote. The
* $raw_* inputs to this are naturally unsafe; often safe versions are
* made to simply overwrite the raw version, but in this case it seems likely
* that the title and the links may be overridden by the theme layer, so they
* are left in with a different name for that purpose.
*
* @see poll-results.tpl.php
* @see poll-results--block.tpl.php
*/
function template_preprocess_poll_results(&$variables) {
$variables['links'] = theme('links__poll_results', array('links' => $variables['raw_links']));
if (isset($variables['vote']) && $variables['vote'] > -1 && user_access('cancel own vote')) {
$elements = drupal_get_form('poll_cancel_form', $variables['nid']);
$variables['cancel_form'] = drupal_render($elements);
}
$variables['title'] = check_plain($variables['raw_title']);
if ($variables['block']) {
$variables['theme_hook_suggestions'][] = 'poll_results__block';
}
}
/**
* Preprocess the poll_bar theme hook.
*
* Inputs: $title, $votes, $total_votes, $voted, $block
*
* @see poll-bar.tpl.php
* @see poll-bar--block.tpl.php
*/
function template_preprocess_poll_bar(&$variables) {
if ($variables['block']) {
$variables['theme_hook_suggestions'][] = 'poll_bar__block';
}
$variables['title'] = check_plain($variables['title']);
$variables['percentage'] = round($variables['votes'] * 100 / max($variables['total_votes'], 1));
}
/**
* Builds the cancel form for a poll.
*
* @ingroup forms
* @see poll_cancel()
*/
function poll_cancel_form($form, &$form_state, $nid) {
$form_state['cache'] = TRUE;
// Store the nid so we can get to it in submit functions.
$form['#nid'] = $nid;
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Cancel your vote'),
'#submit' => array('poll_cancel')
);
return $form;
}
/**
* Submit callback for poll_cancel_form().
*/
function poll_cancel($form, &$form_state) {
global $user;
$node = node_load($form['#nid']);
db_delete('poll_vote')
->condition('nid', $node->nid)
->condition($user->uid ? 'uid' : 'hostname', $user->uid ? $user->uid : ip_address())
->execute();
// Subtract from the votes.
db_update('poll_choice')
->expression('chvotes', 'chvotes - 1')
->condition('chid', $node->vote)
->execute();
unset($_SESSION['poll_vote'][$node->nid]);
drupal_set_message(t('Your vote was cancelled.'));
}
/**
* Implements hook_user_cancel().
*/
function poll_user_cancel($edit, $account, $method) {
switch ($method) {
case 'user_cancel_reassign':
db_update('poll_vote')
->fields(array('uid' => 0))
->condition('uid', $account->uid)
->execute();
break;
}
}
/**
* Implements hook_user_delete().
*/
function poll_user_delete($account) {
db_delete('poll_vote')
->condition('uid', $account->uid)
->execute();
}
/**
* Implements hook_rdf_mapping().
*/
function poll_rdf_mapping() {
return array(
array(
'type' => 'node',
'bundle' => 'poll',
'mapping' => array(
'rdftype' => array('sioc:Post', 'sioct:Poll'),
),
),
);
}
addExpression('COUNT(*)', 'expression');
$count_select->join('poll', 'p', 'p.nid = n.nid');
$count_select->condition('n.status', 1);
// List all polls.
$select = db_select('node', 'n');
$select->join('poll', 'p', 'p.nid = n.nid');
$select->join('poll_choice', 'c', 'c.nid = n.nid');
$select->addExpression('SUM(c.chvotes)', 'votes');
$select = $select->fields('n', array('nid', 'title', 'created'))
->fields('p', array('active'))
->condition('n.status', 1)
->orderBy('n.created', 'DESC')
->groupBy('n.nid')
->groupBy('n.title')
->groupBy('p.active')
->groupBy('n.created')
->extend('PagerDefault')
->limit($polls_per_page)
->addTag('node_access');
$select->setCountQuery($count_select);
$queried_nodes = $select->execute()
->fetchAllAssoc('nid');
$output = '';
foreach ($queried_nodes as $node) {
$output .= '' . l($node->title, "node/$node->nid") . ' - ' . format_plural($node->votes, '1 vote', '@count votes') . ' - ' . ($node->active ? t('open') : t('closed')) . ' ';
}
$output .= ' ';
$output .= theme('pager');
return $output;
}
/**
* Callback for the 'votes' tab for polls you can see other votes on
*/
function poll_votes($node) {
$votes_per_page = 20;
drupal_set_title($node->title);
$header[] = array('data' => t('Visitor'), 'field' => 'u.name');
$header[] = array('data' => t('Vote'), 'field' => 'pc.chtext');
$header[] = array('data' => t('Timestamp'), 'field' => 'pv.timestamp', 'sort' => 'desc');
$select = db_select('poll_vote', 'pv')->extend('PagerDefault')->extend('TableSort');
$select->join('poll_choice', 'pc', 'pv.chid = pc.chid');
$select->join('users', 'u', 'pv.uid = u.uid');
$queried_votes = $select
->addTag('translatable')
->fields('pv', array('chid', 'uid', 'hostname', 'timestamp', 'nid'))
->fields('pc', array('chtext'))
->fields('u', array('name'))
->condition('pv.nid', $node->nid)
->limit($votes_per_page)
->orderByHeader($header)
->execute();
$rows = array();
foreach ($queried_votes as $vote) {
$rows[] = array(
$vote->name ? theme('username', array('account' => $vote)) : check_plain($vote->hostname),
check_plain($vote->chtext),
format_date($vote->timestamp),
);
}
$build['poll_votes_table'] = array(
'#theme' => 'table',
'#header' => $header,
'#rows' => $rows,
'#prefix' => t('This table lists all the recorded votes for this poll. If anonymous users are allowed to vote, they will be identified by the IP address of the computer they used when they voted.'),
);
$build['poll_votes_pager'] = array('#theme' => 'pager');
return $build;
}
/**
* Callback for the 'results' tab for polls you can vote on
*/
function poll_results($node) {
drupal_set_title($node->title);
$node->show_results = TRUE;
return node_show($node);
}
assertTrue(TRUE, 'Create a poll');
$admin_user = $this->drupalCreateUser(array('create poll content', 'administer nodes'));
$web_user = $this->drupalCreateUser(array('create poll content', 'access content', 'edit own poll content'));
$this->drupalLogin($admin_user);
// Get the form first to initialize the state of the internal browser.
$this->drupalGet('node/add/poll');
// Prepare a form with two choices.
list($edit, $index) = $this->_pollGenerateEdit($title, $choices);
// Verify that the vote count element only allows non-negative integers.
$edit['choice[new:1][chvotes]'] = -1;
$edit['choice[new:0][chvotes]'] = $this->randomString(7);
$this->drupalPost(NULL, $edit, t('Save'));
$this->assertText(t('Negative values are not allowed.'));
$this->assertText(t('Vote count for new choice must be an integer.'));
// Repeat steps for initializing the state of the internal browser.
$this->drupalLogin($web_user);
$this->drupalGet('node/add/poll');
list($edit, $index) = $this->_pollGenerateEdit($title, $choices);
// Re-submit the form until all choices are filled in.
if (count($choices) > 2) {
while ($index < count($choices)) {
$this->drupalPost(NULL, $edit, t('More choices'));
$this->assertPollChoiceOrder($choices, $index);
list($edit, $index) = $this->_pollGenerateEdit($title, $choices, $index);
}
}
if ($preview) {
$this->drupalPost(NULL, $edit, t('Preview'));
$this->assertPollChoiceOrder($choices, $index, TRUE);
list($edit, $index) = $this->_pollGenerateEdit($title, $choices, $index);
}
$this->drupalPost(NULL, $edit, t('Save'));
$node = $this->drupalGetNodeByTitle($title);
$this->assertText(t('@type @title has been created.', array('@type' => node_type_get_name('poll'), '@title' => $title)), 'Poll has been created.');
$this->assertTrue($node->nid, 'Poll has been found in the database.');
return isset($node->nid) ? $node->nid : FALSE;
}
/**
* Generates POST values for the poll node form, specifically poll choices.
*
* @param $title
* The title for the poll node.
* @param $choices
* An array containing poll choices, as generated by
* PollTestCase::_generateChoices().
* @param $index
* (optional) The amount/number of already submitted poll choices. Defaults
* to 0.
*
* @return
* An indexed array containing:
* - The generated POST values, suitable for
* DrupalWebTestCase::drupalPost().
* - The number of poll choices contained in 'edit', for potential re-usage
* in subsequent invocations of this function.
*/
function _pollGenerateEdit($title, array $choices, $index = 0) {
$max_new_choices = ($index == 0 ? 2 : 5);
$already_submitted_choices = array_slice($choices, 0, $index);
$new_choices = array_values(array_slice($choices, $index, $max_new_choices));
$edit = array(
'title' => $title,
);
foreach ($already_submitted_choices as $k => $text) {
$edit['choice[chid:' . $k . '][chtext]'] = $text;
}
foreach ($new_choices as $k => $text) {
$edit['choice[new:' . $k . '][chtext]'] = $text;
}
return array($edit, count($already_submitted_choices) + count($new_choices));
}
function _generateChoices($count = 7) {
$choices = array();
for ($i = 1; $i <= $count; $i++) {
$choices[] = $this->randomName();
}
return $choices;
}
/**
* Assert correct poll choice order in the node form after submission.
*
* Verifies both the order in the DOM and in the 'weight' form elements.
*
* @param $choices
* An array containing poll choices, as generated by
* PollTestCase::_generateChoices().
* @param $index
* (optional) The amount/number of already submitted poll choices. Defaults
* to 0.
* @param $preview
* (optional) Whether to also check the poll preview.
*
* @see PollTestCase::_pollGenerateEdit()
*/
function assertPollChoiceOrder(array $choices, $index = 0, $preview = FALSE) {
$expected = array();
$weight = 0;
foreach ($choices as $id => $label) {
if ($id < $index) {
// The expected weight of each choice is higher than the previous one.
$weight++;
// Directly assert the weight form element value for this choice.
$this->assertFieldByName('choice[chid:' . $id . '][weight]', $weight, format_string('Found choice @id with weight @weight.', array(
'@id' => $id,
'@weight' => $weight,
)));
// Append to our (to be reversed) stack of labels.
$expected[$weight] = $label;
}
}
ksort($expected);
// Verify DOM order of poll choices (i.e., #weight of form elements).
$elements = $this->xpath('//input[starts-with(@name, :prefix) and contains(@name, :suffix)]', array(
':prefix' => 'choice[chid:',
':suffix' => '][chtext]',
));
$expected_order = $expected;
foreach ($elements as $element) {
$next_label = array_shift($expected_order);
$this->assertEqual((string) $element['value'], $next_label);
}
// If requested, also verify DOM order in preview.
if ($preview) {
$elements = $this->xpath('//div[contains(@class, :teaser)]/descendant::div[@class=:text]', array(
':teaser' => 'node-teaser',
':text' => 'text',
));
$expected_order = $expected;
foreach ($elements as $element) {
$next_label = array_shift($expected_order);
$this->assertEqual((string) $element, $next_label, format_string('Found choice @label in preview.', array(
'@label' => $next_label,
)));
}
}
}
function pollUpdate($nid, $title, $edit) {
// Edit the poll node.
$this->drupalPost('node/' . $nid . '/edit', $edit, t('Save'));
$this->assertText(t('@type @title has been updated.', array('@type' => node_type_get_name('poll'), '@title' => $title)), 'Poll has been updated.');
}
}
class PollCreateTestCase extends PollTestCase {
public static function getInfo() {
return array(
'name' => 'Poll create',
'description' => 'Adds "more choices", previews and creates a poll.',
'group' => 'Poll'
);
}
function setUp() {
parent::setUp('poll');
}
function testPollCreate() {
$title = $this->randomName();
$choices = $this->_generateChoices(7);
$poll_nid = $this->pollCreate($title, $choices, TRUE);
// Verify poll appears on 'poll' page.
$this->drupalGet('poll');
$this->assertText($title, 'Poll appears in poll list.');
$this->assertText('open', 'Poll is active.');
// Click on the poll title to go to node page.
$this->clickLink($title);
$this->assertText('Total votes: 0', 'Link to poll correct.');
// Now add a new option to make sure that when we update the node the
// option is displayed.
$node = node_load($poll_nid);
$new_option = $this->randomName();
$vote_count = '2000';
$node->choice[] = array(
'chid' => NULL,
'chtext' => $new_option,
'chvotes' => (int) $vote_count,
'weight' => 1000,
);
node_save($node);
$this->drupalGet('poll');
$this->clickLink($title);
$this->assertText($new_option, 'New option found.');
$option = $this->xpath('//div[@id="node-1"]//div[@class="poll"]//div[@class="text"]');
$this->assertEqual(end($option), $new_option, 'Last item is equal to new option.');
$votes = $this->xpath('//div[@id="node-1"]//div[@class="poll"]//div[@class="percent"]');
$this->assertTrue(strpos(end($votes), $vote_count) > 0, "Votes saved.");
}
function testPollClose() {
$content_user = $this->drupalCreateUser(array('create poll content', 'edit any poll content', 'access content'));
$vote_user = $this->drupalCreateUser(array('cancel own vote', 'inspect all votes', 'vote on polls', 'access content'));
// Create poll.
$title = $this->randomName();
$choices = $this->_generateChoices(7);
$poll_nid = $this->pollCreate($title, $choices, FALSE);
$this->drupalLogout();
$this->drupalLogin($content_user);
// Edit the poll node and close the poll.
$close_edit = array('active' => 0);
$this->pollUpdate($poll_nid, $title, $close_edit);
// Verify 'Vote' button no longer appears.
$this->drupalGet('node/' . $poll_nid);
$elements = $this->xpath('//input[@id="edit-vote"]');
$this->assertTrue(empty($elements), "Vote button doesn't appear.");
// Verify status on 'poll' page is 'closed'.
$this->drupalGet('poll');
$this->assertText($title, 'Poll appears in poll list.');
$this->assertText('closed', 'Poll is closed.');
// Edit the poll node and re-activate.
$open_edit = array('active' => 1);
$this->pollUpdate($poll_nid, $title, $open_edit);
// Vote on the poll.
$this->drupalLogout();
$this->drupalLogin($vote_user);
$vote_edit = array('choice' => '1');
$this->drupalPost('node/' . $poll_nid, $vote_edit, t('Vote'));
$this->assertText('Your vote was recorded.', 'Your vote was recorded.');
$elements = $this->xpath('//input[@value="Cancel your vote"]');
$this->assertTrue(isset($elements[0]), "'Cancel your vote' button appears.");
// Edit the poll node and close the poll.
$this->drupalLogout();
$this->drupalLogin($content_user);
$close_edit = array('active' => 0);
$this->pollUpdate($poll_nid, $title, $close_edit);
// Verify 'Cancel your vote' button no longer appears.
$this->drupalGet('node/' . $poll_nid);
$elements = $this->xpath('//input[@value="Cancel your vote"]');
$this->assertTrue(empty($elements), "'Cancel your vote' button no longer appears.");
}
}
class PollVoteTestCase extends PollTestCase {
public static function getInfo() {
return array(
'name' => 'Poll vote',
'description' => 'Vote on a poll',
'group' => 'Poll'
);
}
function setUp() {
parent::setUp('poll');
}
function tearDown() {
parent::tearDown();
}
function testPollVote() {
$title = $this->randomName();
$choices = $this->_generateChoices(7);
$poll_nid = $this->pollCreate($title, $choices, FALSE);
$this->drupalLogout();
$vote_user = $this->drupalCreateUser(array('cancel own vote', 'inspect all votes', 'vote on polls', 'access content'));
$restricted_vote_user = $this->drupalCreateUser(array('vote on polls', 'access content'));
$this->drupalLogin($vote_user);
// Record a vote without selecting any choice.
$edit = array();
$this->drupalPost('node/' . $poll_nid, $edit, t('Vote'));
$this->assertText(t('Your vote could not be recorded because you did not select any of the choices.'), 'Found the empty poll submission error message.');
// Record a vote for the first choice.
$edit = array(
'choice' => '1',
);
$this->drupalPost('node/' . $poll_nid, $edit, t('Vote'));
$this->assertText('Your vote was recorded.', 'Your vote was recorded.');
$this->assertText('Total votes: 1', 'Vote count updated correctly.');
$elements = $this->xpath('//input[@value="Cancel your vote"]');
$this->assertTrue(isset($elements[0]), "'Cancel your vote' button appears.");
$this->drupalGet("node/$poll_nid/votes");
$this->assertText(t('This table lists all the recorded votes for this poll. If anonymous users are allowed to vote, they will be identified by the IP address of the computer they used when they voted.'), 'Vote table text.');
$this->assertText($choices[0], 'Vote recorded');
// Ensure poll listing page has correct number of votes.
$this->drupalGet('poll');
$this->assertText($title, 'Poll appears in poll list.');
$this->assertText('1 vote', 'Poll has 1 vote.');
// Cancel a vote.
$this->drupalPost('node/' . $poll_nid, array(), t('Cancel your vote'));
$this->assertText('Your vote was cancelled.', 'Your vote was cancelled.');
$this->assertNoText('Cancel your vote', "Cancel vote button doesn't appear.");
$this->drupalGet("node/$poll_nid/votes");
$this->assertNoText($choices[0], 'Vote cancelled');
// Ensure poll listing page has correct number of votes.
$this->drupalGet('poll');
$this->assertText($title, 'Poll appears in poll list.');
$this->assertText('0 votes', 'Poll has 0 votes.');
// Log in as a user who can only vote on polls.
$this->drupalLogout();
$this->drupalLogin($restricted_vote_user);
// Vote on a poll.
$edit = array(
'choice' => '1',
);
$this->drupalPost('node/' . $poll_nid, $edit, t('Vote'));
$this->assertText('Your vote was recorded.', 'Your vote was recorded.');
$this->assertText('Total votes: 1', 'Vote count updated correctly.');
$elements = $this->xpath('//input[@value="Cancel your vote"]');
$this->assertTrue(empty($elements), "'Cancel your vote' button does not appear.");
}
}
class PollBlockTestCase extends PollTestCase {
public static function getInfo() {
return array(
'name' => 'Block availability',
'description' => 'Check if the most recent poll block is available.',
'group' => 'Poll',
);
}
function setUp() {
parent::setUp('poll');
// Create and login user
$admin_user = $this->drupalCreateUser(array('administer blocks'));
$this->drupalLogin($admin_user);
}
function testRecentBlock() {
// Set block title to confirm that the interface is available.
$this->drupalPost('admin/structure/block/manage/poll/recent/configure', array('title' => $this->randomName(8)), t('Save block'));
$this->assertText(t('The block configuration has been saved.'), 'Block configuration set.');
// Set the block to a region to confirm block is available.
$edit = array();
$edit['blocks[poll_recent][region]'] = 'footer';
$this->drupalPost('admin/structure/block', $edit, t('Save blocks'));
$this->assertText(t('The block settings have been updated.'), 'Block successfully move to footer region.');
// Create a poll which should appear in recent polls block.
$title = $this->randomName();
$choices = $this->_generateChoices(7);
$poll_nid = $this->pollCreate($title, $choices, TRUE);
// Verify poll appears in a block.
// View user page so we're not matching the poll node on front page.
$this->drupalGet('user');
// If a 'block' view not generated, this title would not appear even though
// the choices might.
$this->assertText($title, 'Poll appears in block.');
// Logout and login back in as a user who can vote.
$this->drupalLogout();
$vote_user = $this->drupalCreateUser(array('cancel own vote', 'inspect all votes', 'vote on polls', 'access content'));
$this->drupalLogin($vote_user);
// Verify we can vote via the block.
$edit = array(
'choice' => '1',
);
$this->drupalPost('user/' . $vote_user->uid, $edit, t('Vote'));
$this->assertText('Your vote was recorded.', 'Your vote was recorded.');
$this->assertText('Total votes: 1', 'Vote count updated correctly.');
$this->assertText('Older polls', 'Link to older polls appears.');
$this->clickLink('Older polls');
$this->assertText('1 vote - open', 'Link to poll listing correct.');
// Close the poll and verify block doesn't appear.
$content_user = $this->drupalCreateUser(array('create poll content', 'edit any poll content', 'access content'));
$this->drupalLogout();
$this->drupalLogin($content_user);
$close_edit = array('active' => 0);
$this->pollUpdate($poll_nid, $title, $close_edit);
$this->drupalGet('user/' . $content_user->uid);
$this->assertNoText($title, 'Poll no longer appears in block.');
}
}
/**
* Test adding new choices.
*/
class PollJSAddChoice extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Poll add choice',
'description' => 'Submits a POST request for an additional poll choice.',
'group' => 'Poll'
);
}
function setUp() {
parent::setUp('poll');
}
/**
* Test adding a new choice.
*/
function testAddChoice() {
$web_user = $this->drupalCreateUser(array('create poll content', 'access content'));
$this->drupalLogin($web_user);
$this->drupalGet('node/add/poll');
$edit = array(
"title" => $this->randomName(),
'choice[new:0][chtext]' => $this->randomName(),
'choice[new:1][chtext]' => $this->randomName(),
);
// Press 'add choice' button through Ajax, and place the expected HTML result
// as the tested content.
$commands = $this->drupalPostAJAX(NULL, $edit, array('op' => t('More choices')));
$this->content = $commands[1]['data'];
$this->assertFieldByName('choice[chid:0][chtext]', $edit['choice[new:0][chtext]'], format_string('Field !i found', array('!i' => 0)));
$this->assertFieldByName('choice[chid:1][chtext]', $edit['choice[new:1][chtext]'], format_string('Field !i found', array('!i' => 1)));
$this->assertFieldByName('choice[new:0][chtext]', '', format_string('Field !i found', array('!i' => 2)));
}
}
class PollVoteCheckHostname extends PollTestCase {
protected $admin_user;
protected $poll_nid;
protected $web_user1;
protected $web_user2;
public static function getInfo() {
return array(
'name' => 'User poll vote capability.',
'description' => 'Check that users and anonymous users from specified ip-address can only vote once.',
'group' => 'Poll'
);
}
function setUp() {
parent::setUp('poll');
// Create and login user.
$this->admin_user = $this->drupalCreateUser(array('administer permissions', 'create poll content'));
$this->drupalLogin($this->admin_user);
// Allow anonymous users to vote on polls.
user_role_change_permissions(DRUPAL_ANONYMOUS_RID, array(
'access content' => TRUE,
'vote on polls' => TRUE,
'cancel own vote' => TRUE,
));
// Enable page cache to verify that the result page is not saved in the
// cache when anonymous voting is allowed.
variable_set('cache', 1);
// Create poll.
$title = $this->randomName();
$choices = $this->_generateChoices(3);
$this->poll_nid = $this->pollCreate($title, $choices, FALSE);
$this->drupalLogout();
// Create web users.
$this->web_user1 = $this->drupalCreateUser(array('access content', 'vote on polls', 'cancel own vote'));
$this->web_user2 = $this->drupalCreateUser(array('access content', 'vote on polls'));
}
/**
* Check that anonymous users with same ip cannot vote on poll more than once
* unless user is logged in.
*/
function testHostnamePollVote() {
// Login User1.
$this->drupalLogin($this->web_user1);
$edit = array(
'choice' => '1',
);
// User1 vote on Poll.
$this->drupalPost('node/' . $this->poll_nid, $edit, t('Vote'));
$this->assertText(t('Your vote was recorded.'), format_string('%user vote was recorded.', array('%user' => $this->web_user1->name)));
$this->assertText(t('Total votes: @votes', array('@votes' => 1)), 'Vote count updated correctly.');
// Check to make sure User1 cannot vote again.
$this->drupalGet('node/' . $this->poll_nid);
$elements = $this->xpath('//input[@value="Vote"]');
$this->assertTrue(empty($elements), format_string("%user is not able to vote again.", array('%user' => $this->web_user1->name)));
$elements = $this->xpath('//input[@value="Cancel your vote"]');
$this->assertTrue(!empty($elements), "'Cancel your vote' button appears.");
// Logout User1.
$this->drupalLogout();
// Fill the page cache by requesting the poll.
$this->drupalGet('node/' . $this->poll_nid);
$this->assertEqual($this->drupalGetHeader('x-drupal-cache'), 'MISS', 'Page was cacheable but was not in the cache.');
$this->drupalGet('node/' . $this->poll_nid);
$this->assertEqual($this->drupalGetHeader('x-drupal-cache'), 'HIT', 'Page was cached.');
// Anonymous user vote on Poll.
$this->drupalPost(NULL, $edit, t('Vote'));
$this->assertText(t('Your vote was recorded.'), 'Anonymous vote was recorded.');
$this->assertText(t('Total votes: @votes', array('@votes' => 2)), 'Vote count updated correctly.');
$elements = $this->xpath('//input[@value="Cancel your vote"]');
$this->assertTrue(!empty($elements), "'Cancel your vote' button appears.");
// Check to make sure Anonymous user cannot vote again.
$this->drupalGet('node/' . $this->poll_nid);
$this->assertFalse($this->drupalGetHeader('x-drupal-cache'), 'Page was not cacheable.');
$elements = $this->xpath('//input[@value="Vote"]');
$this->assertTrue(empty($elements), "Anonymous is not able to vote again.");
$elements = $this->xpath('//input[@value="Cancel your vote"]');
$this->assertTrue(!empty($elements), "'Cancel your vote' button appears.");
// Login User2.
$this->drupalLogin($this->web_user2);
// User2 vote on poll.
$this->drupalPost('node/' . $this->poll_nid, $edit, t('Vote'));
$this->assertText(t('Your vote was recorded.'), format_string('%user vote was recorded.', array('%user' => $this->web_user2->name)));
$this->assertText(t('Total votes: @votes', array('@votes' => 3)), 'Vote count updated correctly.');
$elements = $this->xpath('//input[@value="Cancel your vote"]');
$this->assertTrue(empty($elements), "'Cancel your vote' button does not appear.");
// Logout User2.
$this->drupalLogout();
// Change host name for anonymous users.
db_update('poll_vote')
->fields(array(
'hostname' => '123.456.789.1',
))
->condition('hostname', '', '<>')
->execute();
// Check to make sure Anonymous user can vote again with a new session after
// a hostname change.
$this->drupalGet('node/' . $this->poll_nid);
$this->assertEqual($this->drupalGetHeader('x-drupal-cache'), 'MISS', 'Page was cacheable but was not in the cache.');
$this->drupalPost(NULL, $edit, t('Vote'));
$this->assertText(t('Your vote was recorded.'), format_string('%user vote was recorded.', array('%user' => $this->web_user2->name)));
$this->assertText(t('Total votes: @votes', array('@votes' => 4)), 'Vote count updated correctly.');
$elements = $this->xpath('//input[@value="Cancel your vote"]');
$this->assertTrue(!empty($elements), "'Cancel your vote' button appears.");
// Check to make sure Anonymous user cannot vote again with a new session,
// and that the vote from the previous session cannot be cancelledd.
$this->curlClose();
$this->drupalGet('node/' . $this->poll_nid);
$this->assertEqual($this->drupalGetHeader('x-drupal-cache'), 'MISS', 'Page was cacheable but was not in the cache.');
$elements = $this->xpath('//input[@value="Vote"]');
$this->assertTrue(empty($elements), 'Anonymous is not able to vote again.');
$elements = $this->xpath('//input[@value="Cancel your vote"]');
$this->assertTrue(empty($elements), "'Cancel your vote' button does not appear.");
// Login User1.
$this->drupalLogin($this->web_user1);
// Check to make sure User1 still cannot vote even after hostname changed.
$this->drupalGet('node/' . $this->poll_nid);
$elements = $this->xpath('//input[@value="Vote"]');
$this->assertTrue(empty($elements), format_string("%user is not able to vote again.", array('%user' => $this->web_user1->name)));
$elements = $this->xpath('//input[@value="Cancel your vote"]');
$this->assertTrue(!empty($elements), "'Cancel your vote' button appears.");
}
}
/**
* Test poll token replacement in strings.
*/
class PollTokenReplaceTestCase extends PollTestCase {
public static function getInfo() {
return array(
'name' => 'Poll token replacement',
'description' => 'Generates text using placeholders for dummy content to check poll token replacement.',
'group' => 'Poll',
);
}
function setUp() {
parent::setUp('poll');
}
/**
* Creates a poll, then tests the tokens generated from it.
*/
function testPollTokenReplacement() {
global $language;
// Craete a poll with three choices.
$title = $this->randomName();
$choices = $this->_generateChoices(3);
$poll_nid = $this->pollCreate($title, $choices, FALSE);
$this->drupalLogout();
// Create four users and have each of them vote.
$vote_user1 = $this->drupalCreateUser(array('vote on polls', 'access content'));
$this->drupalLogin($vote_user1);
$edit = array(
'choice' => '1',
);
$this->drupalPost('node/' . $poll_nid, $edit, t('Vote'));
$this->drupalLogout();
$vote_user2 = $this->drupalCreateUser(array('vote on polls', 'access content'));
$this->drupalLogin($vote_user2);
$edit = array(
'choice' => '1',
);
$this->drupalPost('node/' . $poll_nid, $edit, t('Vote'));
$this->drupalLogout();
$vote_user3 = $this->drupalCreateUser(array('vote on polls', 'access content'));
$this->drupalLogin($vote_user3);
$edit = array(
'choice' => '2',
);
$this->drupalPost('node/' . $poll_nid, $edit, t('Vote'));
$this->drupalLogout();
$vote_user4 = $this->drupalCreateUser(array('vote on polls', 'access content'));
$this->drupalLogin($vote_user4);
$edit = array(
'choice' => '3',
);
$this->drupalPost('node/' . $poll_nid, $edit, t('Vote'));
$this->drupalLogout();
$poll = node_load($poll_nid, NULL, TRUE);
// Generate and test sanitized tokens.
$tests = array();
$tests['[node:poll-votes]'] = 4;
$tests['[node:poll-winner]'] = filter_xss($poll->choice[1]['chtext']);
$tests['[node:poll-winner-votes]'] = 2;
$tests['[node:poll-winner-percent]'] = 50;
$tests['[node:poll-duration]'] = format_interval($poll->runtime, 1, $language->language);
// Test to make sure that we generated something for each token.
$this->assertFalse(in_array(0, array_map('strlen', $tests)), 'No empty tokens generated.');
foreach ($tests as $input => $expected) {
$output = token_replace($input, array('node' => $poll), array('language' => $language));
$this->assertEqual($output, $expected, format_string('Sanitized poll token %token replaced.', array('%token' => $input)));
}
// Generate and test unsanitized tokens.
$tests['[node:poll-winner]'] = $poll->choice[1]['chtext'];
foreach ($tests as $input => $expected) {
$output = token_replace($input, array('node' => $poll), array('language' => $language, 'sanitize' => FALSE));
$this->assertEqual($output, $expected, format_string('Unsanitized poll token %token replaced.', array('%token' => $input)));
}
}
}
class PollExpirationTestCase extends PollTestCase {
public static function getInfo() {
return array(
'name' => 'Poll expiration',
'description' => 'Test the poll auto-expiration logic.',
'group' => 'Poll',
);
}
function setUp() {
parent::setUp('poll');
}
function testAutoExpire() {
// Set up a poll.
$title = $this->randomName();
$choices = $this->_generateChoices(2);
$poll_nid = $this->pollCreate($title, $choices, FALSE);
$this->assertTrue($poll_nid, 'Poll for auto-expire test created.');
// Visit the poll edit page and verify that by default, expiration
// is set to unlimited.
$this->drupalGet("node/$poll_nid/edit");
$this->assertField('runtime', 'Poll expiration setting found.');
$elements = $this->xpath('//select[@id="edit-runtime"]/option[@selected="selected"]');
$this->assertTrue(isset($elements[0]['value']) && $elements[0]['value'] == 0, 'Poll expiration set to unlimited.');
// Set the expiration to one week.
$edit = array();
$poll_expiration = 604800; // One week.
$edit['runtime'] = $poll_expiration;
$this->drupalPost(NULL, $edit, t('Save'));
$this->assertRaw(t('Poll %title has been updated.', array('%title' => $title)), 'Poll expiration settings saved.');
// Make sure that the changed expiration settings is kept.
$this->drupalGet("node/$poll_nid/edit");
$elements = $this->xpath('//select[@id="edit-runtime"]/option[@selected="selected"]');
$this->assertTrue(isset($elements[0]['value']) && $elements[0]['value'] == $poll_expiration, 'Poll expiration set to unlimited.');
// Force a cron run. Since the expiration date has not yet been reached,
// the poll should remain active.
drupal_cron_run();
$this->drupalGet("node/$poll_nid/edit");
$elements = $this->xpath('//input[@id="edit-active-1"]');
$this->assertTrue(isset($elements[0]) && !empty($elements[0]['checked']), 'Poll is still active.');
// Test expiration. Since REQUEST_TIME is a constant and we don't
// want to keep SimpleTest waiting until the moment of expiration arrives,
// we forcibly change the expiration date in the database.
$created = db_query('SELECT created FROM {node} WHERE nid = :nid', array(':nid' => $poll_nid))->fetchField();
db_update('node')
->fields(array('created' => $created - ($poll_expiration * 1.01)))
->condition('nid', $poll_nid)
->execute();
// Run cron and verify that the poll is now marked as "closed".
drupal_cron_run();
$this->drupalGet("node/$poll_nid/edit");
$elements = $this->xpath('//input[@id="edit-active-0"]');
$this->assertTrue(isset($elements[0]) && !empty($elements[0]['checked']), 'Poll has expired.');
}
}
class PollDeleteChoiceTestCase extends PollTestCase {
public static function getInfo() {
return array(
'name' => 'Poll choice deletion',
'description' => 'Test the poll choice deletion logic.',
'group' => 'Poll',
);
}
function setUp() {
parent::setUp('poll');
}
function testChoiceRemoval() {
// Set up a poll with three choices.
$title = $this->randomName();
$choices = array('First choice', 'Second choice', 'Third choice');
$poll_nid = $this->pollCreate($title, $choices, FALSE);
$this->assertTrue($poll_nid, 'Poll for choice deletion logic test created.');
// Edit the poll, and try to delete first poll choice.
$this->drupalGet("node/$poll_nid/edit");
$edit['choice[chid:1][chtext]'] = '';
$this->drupalPost(NULL, $edit, t('Save'));
// Click on the poll title to go to node page.
$this->drupalGet('poll');
$this->clickLink($title);
// Check the first poll choice is deleted, while the others remain.
$this->assertNoText('First choice', 'First choice removed.');
$this->assertText('Second choice', 'Second choice remains.');
$this->assertText('Third choice', 'Third choice remains.');
}
}
/**
* Tests poll translation logic.
*/
class PollTranslateTestCase extends PollTestCase {
public static function getInfo() {
return array(
'name' => 'Poll translation',
'description' => 'Test the poll translation logic.',
'group' => 'Poll',
);
}
function setUp() {
parent::setUp('poll', 'translation');
}
/**
* Tests poll creation and translation.
*
* Checks that the choice names get copied from the original poll and that
* the vote count values are set to 0.
*/
function testPollTranslate() {
$admin_user = $this->drupalCreateUser(array('administer content types', 'administer languages', 'edit any poll content', 'create poll content', 'administer nodes', 'translate content'));
// Set up a poll with two choices.
$title = $this->randomName();
$choices = array($this->randomName(), $this->randomName());
$poll_nid = $this->pollCreate($title, $choices, FALSE);
$this->assertTrue($poll_nid, 'Poll for translation logic test created.');
$this->drupalLogout();
$this->drupalLogin($admin_user);
// Enable a second language.
$this->drupalGet('admin/config/regional/language');
$edit = array();
$edit['langcode'] = 'nl';
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add language'));
$this->assertRaw(t('The language %language has been created and can now be used.', array('%language' => 'Dutch')), 'Language Dutch has been created.');
// Set "Poll" content type to use multilingual support with translation.
$this->drupalGet('admin/structure/types/manage/poll');
$edit = array();
$edit['language_content_type'] = 2;
$this->drupalPost('admin/structure/types/manage/poll', $edit, t('Save content type'));
$this->assertRaw(t('The content type %type has been updated.', array('%type' => 'Poll')), 'Poll content type has been updated.');
// Edit poll.
$this->drupalGet("node/$poll_nid/edit");
$edit = array();
// Set the poll's first choice count to 200.
$edit['choice[chid:1][chvotes]'] = 200;
// Set the language to Dutch.
$edit['language'] = 'nl';
$this->drupalPost(NULL, $edit, t('Save'));
// Translate the Dutch poll.
$this->drupalGet('node/add/poll', array('query' => array('translation' => $poll_nid, 'target' => 'en')));
$dutch_poll = node_load($poll_nid);
// Check that the vote count values didn't get copied from the Dutch poll
// and are set to 0.
$this->assertFieldByName('choice[chid:1][chvotes]', '0', ('Found choice with vote count 0'));
$this->assertFieldByName('choice[chid:2][chvotes]', '0', ('Found choice with vote count 0'));
// Check that the choice names got copied from the Dutch poll.
$this->assertFieldByName('choice[chid:1][chtext]', $dutch_poll->choice[1]['chtext'], format_string('Found choice with text @text', array('@text' => $dutch_poll->choice[1]['chtext'])));
$this->assertFieldByName('choice[chid:2][chtext]', $dutch_poll->choice[2]['chtext'], format_string('Found choice with text @text', array('@text' => $dutch_poll->choice[2]['chtext'])));
}
}
t("Poll votes"),
'description' => t("The number of votes that have been cast on a poll."),
);
$node['poll-winner'] = array(
'name' => t("Poll winner"),
'description' => t("The winning poll answer."),
);
$node['poll-winner-votes'] = array(
'name' => t("Poll winner votes"),
'description' => t("The number of votes received by the winning poll answer."),
);
$node['poll-winner-percent'] = array(
'name' => t("Poll winner percent"),
'description' => t("The percentage of votes received by the winning poll answer."),
);
$node['poll-duration'] = array(
'name' => t("Poll duration"),
'description' => t("The length of time the poll is set to run."),
);
return array(
'tokens' => array('node' => $node),
);
}
/**
* Implements hook_tokens().
*/
function poll_tokens($type, $tokens, array $data = array(), array $options = array()) {
$sanitize = !empty($options['sanitize']);
if (isset($options['language'])) {
$url_options['language'] = $options['language'];
$language_code = $options['language']->language;
}
else {
$language_code = NULL;
}
$replacements = array();
if ($type == 'node' && !empty($data['node']) && $data['node']->type == 'poll') {
$node = $data['node'];
$total_votes = 0;
$highest_votes = 0;
foreach ($node->choice as $choice) {
if ($choice['chvotes'] > $highest_votes) {
$winner = $choice;
$highest_votes = $choice['chvotes'];
}
$total_votes = $total_votes + $choice['chvotes'];
}
foreach ($tokens as $name => $original) {
switch ($name) {
case 'poll-votes':
$replacements[$original] = $total_votes;
break;
case 'poll-winner':
if (isset($winner)) {
$replacements[$original] = $sanitize ? filter_xss($winner['chtext']) : $winner['chtext'];
}
else {
$replacements[$original] = '';
}
break;
case 'poll-winner-votes':
if (isset($winner)) {
$replacements[$original] = $winner['chvotes'];
}
else {
$replacements[$original] = '';
}
break;
case 'poll-winner-percent':
if (isset($winner)) {
$percent = ($winner['chvotes'] / $total_votes) * 100;
$replacements[$original] = number_format($percent, 0);
}
else {
$replacements[$original] = '';
}
break;
case 'poll-duration':
$replacements[$original] = format_interval($node->runtime, 1, $language_code);
break;
}
}
}
return $replacements;
}
title: Title of the profile field.
* - $field->value: Value of the profile field.
* - $field->type: Type of the profile field, i.e., checkbox, textfield,
* textarea, selection, list, url or date.
*
* Since $profile is keyed, a direct print of the field is possible. Not
* all accounts may have a value for a profile so do a check first. If a field
* of "last_name" was set for the site, the following can be used.
*
*
*
* title; ?>:
*
*
* @see template_preprocess_profile_block()
*/
?>
type != 'checkbox'): ?>
title; ?>
title: Title of the profile field.
* - $field->value: Value of the profile field.
* - $field->type: Type of the profile field, i.e., checkbox, textfield,
* textarea, selection, list, url or date.
*
* Since $profile is keyed, a direct print of the field is possible. Not
* all accounts may have a value for a profile so do a check first. If a field
* of "last_name" was set for the site, the following can be used.
*
*
*
* title; ?>:
*
*
* @see template_preprocess_profile_listing()
*/
?>
category;
// Save all field information
$form[$field->fid]['name'] = array('#markup' => check_plain($field->name));
$form[$field->fid]['title'] = array('#markup' => check_plain($field->title));
$form[$field->fid]['type'] = array('#markup' => $field->type);
$form[$field->fid]['category'] = array(
'#type' => 'select',
'#title' => t('Category for @title', array('@title' => $field->title)),
'#title_display' => 'invisible',
'#default_value' => $field->category,
'#options' => array(),
);
$form[$field->fid]['weight'] = array(
'#type' => 'weight',
'#title' => t('Weight for @title', array('@title' => $field->title)),
'#title_display' => 'invisible',
'#default_value' => $field->weight,
);
$form[$field->fid]['edit'] = array('#type' => 'link', '#title' => t('edit'), '#href' => "admin/config/people/profile/edit/$field->fid");
$form[$field->fid]['delete'] = array('#type' => 'link', '#title' => t('delete'), '#href' => "admin/config/people/profile/delete/$field->fid");
}
// Add the category combo boxes
$categories = array_unique($categories);
foreach ($form as $fid => $field) {
foreach ($categories as $cat => $category) {
$form[$fid]['category']['#options'][$category] = $category;
}
}
// Display the submit button only when there's more than one field
if (count($form) > 1) {
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array('#type' => 'submit', '#value' => t('Save configuration'));
}
else {
// Disable combo boxes when there isn't a submit button
foreach ($form as $fid => $field) {
unset($form[$fid]['weight']);
$form[$fid]['category']['#type'] = 'value';
}
}
$form['#tree'] = TRUE;
// @todo: Any reason this isn't done using an element with #theme = 'links'?
$addnewfields = '' . t('Add new field') . ' ';
$addnewfields .= '';
foreach (_profile_field_types() as $key => $value) {
$addnewfields .= '' . l($value, "admin/config/people/profile/add/$key") . ' ';
}
$addnewfields .= ' ';
$form['addnewfields'] = array('#markup' => $addnewfields);
return $form;
}
/**
* Submit handler to update changed profile field weights and categories.
*
* @see profile_admin_overview()
*/
function profile_admin_overview_submit($form, &$form_state) {
foreach (element_children($form_state['values']) as $fid) {
if (is_numeric($fid)) {
$weight = $form_state['values'][$fid]['weight'];
$category = $form_state['values'][$fid]['category'];
if ($weight != $form[$fid]['weight']['#default_value'] || $category != $form[$fid]['category']['#default_value']) {
db_update('profile_field')
->fields(array(
'weight' => $weight,
'category' => $category,
))
->condition('fid', $fid)
->execute();
}
}
}
drupal_set_message(t('Profile fields have been updated.'));
cache_clear_all();
menu_rebuild();
}
/**
* Returns HTML for the profile field overview form into a drag and drop enabled table.
*
* @param $variables
* An associative array containing:
* - form: A render element representing the form.
*
* @see profile_admin_overview()
* @ingroup themeable
*/
function theme_profile_admin_overview($variables) {
$form = $variables['form'];
drupal_add_css(drupal_get_path('module', 'profile') . '/profile.css');
// Add javascript if there's more than one field.
if (isset($form['actions'])) {
drupal_add_js(drupal_get_path('module', 'profile') . '/profile.js');
}
$rows = array();
$categories = array();
$category_number = 0;
foreach (element_children($form) as $key) {
// Don't take form control structures.
if (isset($form[$key]['category'])) {
$field = &$form[$key];
$category = $field['category']['#default_value'];
if (!isset($categories[$category])) {
// Category classes are given numeric IDs because there's no guarantee
// class names won't contain invalid characters.
$categories[$category] = $category_number;
$category_field['#attributes']['class'] = array('profile-category', 'profile-category-' . $category_number);
$rows[] = array(array('data' => check_plain($category), 'colspan' => 7, 'class' => array('category')));
$rows[] = array('data' => array(array('data' => '' . t('No fields in this category. If this category remains empty when saved, it will be removed.') . ' ', 'colspan' => 7)), 'class' => array('category-' . $category_number . '-message', 'category-message', 'category-populated'));
// Make it draggable only if there is more than one field
if (isset($form['actions'])) {
drupal_add_tabledrag('profile-fields', 'order', 'sibling', 'profile-weight', 'profile-weight-' . $category_number);
drupal_add_tabledrag('profile-fields', 'match', 'sibling', 'profile-category', 'profile-category-' . $category_number);
}
$category_number++;
}
// Add special drag and drop classes that group fields together.
$field['weight']['#attributes']['class'] = array('profile-weight', 'profile-weight-' . $categories[$category]);
$field['category']['#attributes']['class'] = array('profile-category', 'profile-category-' . $categories[$category]);
// Add the row
$row = array();
$row[] = drupal_render($field['title']);
$row[] = drupal_render($field['name']);
$row[] = drupal_render($field['type']);
if (isset($form['actions'])) {
$row[] = drupal_render($field['category']);
$row[] = drupal_render($field['weight']);
}
$row[] = drupal_render($field['edit']);
$row[] = drupal_render($field['delete']);
$rows[] = array('data' => $row, 'class' => array('draggable'));
}
}
$header = array(t('Title'), t('Name'), t('Type'));
if (isset($form['actions'])) {
$header[] = t('Category');
$header[] = t('Weight');
}
$header[] = array('data' => t('Operations'), 'colspan' => 2);
$output = theme('table', array('header' => $header, 'rows' => $rows, 'empty' => t('No fields available.'), 'attributes' => array('id' => 'profile-fields')));
$output .= drupal_render_children($form);
return $output;
}
/**
* Menu callback: Generate a form to add/edit a user profile field.
*
* @ingroup forms
* @see profile_field_form_validate()
* @see profile_field_form_submit()
*/
function profile_field_form($form, &$form_state, $arg = NULL) {
if (arg(4) == 'edit') {
if (is_numeric($arg)) {
$fid = $arg;
$edit = db_query('SELECT * FROM {profile_field} WHERE fid = :fid', array('fid' => $fid))->fetchAssoc();
if (!$edit) {
drupal_not_found();
return;
}
drupal_set_title(t('Edit %title', array('%title' => $edit['title'])), PASS_THROUGH);
$form['fid'] = array('#type' => 'value',
'#value' => $fid,
);
$type = $edit['type'];
}
else {
drupal_not_found();
return;
}
}
else {
$types = _profile_field_types();
if (!isset($types[$arg])) {
drupal_not_found();
return;
}
$type = $arg;
drupal_set_title(t('Add new %type', array('%type' => $types[$type])), PASS_THROUGH);
$edit = array('name' => 'profile_');
$form['type'] = array('#type' => 'value', '#value' => $type);
}
$edit += array(
'category' => '',
'title' => '',
'explanation' => '',
'weight' => 0,
'page' => '',
'autocomplete' => '',
'required' => '',
'register' => '',
);
$form['category'] = array('#type' => 'textfield',
'#title' => t('Category'),
'#default_value' => $edit['category'],
'#autocomplete_path' => 'admin/config/people/profile/autocomplete',
'#description' => t('The category the new field should be part of. Categories are used to group fields logically. An example category is "Personal information".'),
'#required' => TRUE,
);
$form['title'] = array('#type' => 'textfield',
'#title' => t('Title'),
'#default_value' => $edit['title'],
'#description' => t('The title of the new field. The title will be shown to the user. An example title is "Favorite color".'),
'#required' => TRUE,
);
$form['name'] = array('#type' => 'textfield',
'#title' => t('Form name'),
'#default_value' => $edit['name'],
'#description' => t('The name of the field. The form name is not shown to the user but used internally in the HTML code and URLs.
Unless you know what you are doing, it is highly recommended that you prefix the form name with profile_ to avoid name clashes with other fields. Spaces or any other special characters except dash (-) and underscore (_) are not allowed. An example name is "profile_favorite_color" or perhaps just "profile_color".'),
'#required' => TRUE,
);
$form['explanation'] = array('#type' => 'textarea',
'#title' => t('Explanation'),
'#default_value' => $edit['explanation'],
'#description' => t('An optional explanation to go with the new field. The explanation will be shown to the user.'),
);
if ($type == 'selection') {
$form['fields']['options'] = array('#type' => 'textarea',
'#title' => t('Selection options'),
'#default_value' => isset($edit['options']) ? $edit['options'] : '',
'#description' => t('A list of all options. Put each option on a separate line. Example options are "red", "blue", "green", etc.'),
);
}
$form['visibility'] = array('#type' => 'radios',
'#title' => t('Visibility'),
'#default_value' => isset($edit['visibility']) ? $edit['visibility'] : PROFILE_PUBLIC,
'#options' => array(PROFILE_HIDDEN => t('Hidden profile field, only accessible by administrators, modules and themes.'), PROFILE_PRIVATE => t('Private field, content only available to privileged users.'), PROFILE_PUBLIC => t('Public field, content shown on profile page but not used on member list pages.'), PROFILE_PUBLIC_LISTINGS => t('Public field, content shown on profile page and on member list pages.')),
);
if ($type == 'selection' || $type == 'list' || $type == 'textfield') {
$form['fields']['page'] = array('#type' => 'textfield',
'#title' => t('Page title'),
'#default_value' => $edit['page'],
'#description' => t('To enable browsing this field by value, enter a title for the resulting page. The word %value will be substituted with the corresponding value. An example page title is "People whose favorite color is %value" . This is only applicable for a public field.'),
);
}
elseif ($type == 'checkbox') {
$form['fields']['page'] = array('#type' => 'textfield',
'#title' => t('Page title'),
'#default_value' => $edit['page'],
'#description' => t('To enable browsing this field by value, enter a title for the resulting page. An example page title is "People who are employed" . This is only applicable for a public field.'),
);
}
$form['weight'] = array('#type' => 'weight',
'#title' => t('Weight'),
'#default_value' => $edit['weight'],
'#description' => t('The weights define the order in which the form fields are shown. Lighter fields "float up" towards the top of the category.'),
);
$form['autocomplete'] = array('#type' => 'checkbox',
'#title' => t('Form will auto-complete while user is typing.'),
'#default_value' => $edit['autocomplete'],
'#description' => t('For security, auto-complete will be disabled if the user does not have access to user profiles.'),
);
$form['required'] = array('#type' => 'checkbox',
'#title' => t('The user must enter a value.'),
'#default_value' => $edit['required'],
);
$form['register'] = array('#type' => 'checkbox',
'#title' => t('Visible in user registration form.'),
'#default_value' => $edit['register'],
);
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array('#type' => 'submit',
'#value' => t('Save field'),
);
return $form;
}
/**
* Validate profile_field_form submissions.
*/
function profile_field_form_validate($form, &$form_state) {
// Validate the 'field name':
if (preg_match('/[^a-zA-Z0-9_-]/', $form_state['values']['name'])) {
form_set_error('name', t('The specified form name contains one or more illegal characters. Spaces or any other special characters except dash (-) and underscore (_) are not allowed.'));
}
$users_table = drupal_get_schema('users');
if (!empty($users_table['fields'][$form_state['values']['name']])) {
form_set_error('name', t('The specified form name is reserved for use by Drupal.'));
}
// Validate the category:
if (!$form_state['values']['category']) {
form_set_error('category', t('You must enter a category.'));
}
if (strtolower($form_state['values']['category']) == 'account') {
form_set_error('category', t('The specified category name is reserved for use by Drupal.'));
}
$query = db_select('profile_field');
$query->fields('profile_field', array('fid'));
if (isset($form_state['values']['fid'])) {
$query->condition('fid', $form_state['values']['fid'], '<>');
}
$query_name = clone $query;
$title = $query
->condition('title', $form_state['values']['title'])
->condition('category', $form_state['values']['category'])
->execute()
->fetchField();
if ($title) {
form_set_error('title', t('The specified title is already in use.'));
}
$name = $query_name
->condition('name', $form_state['values']['name'])
->execute()
->fetchField();
if ($name) {
form_set_error('name', t('The specified name is already in use.'));
}
if ($form_state['values']['visibility'] == PROFILE_HIDDEN) {
if ($form_state['values']['required']) {
form_set_error('required', t('A hidden field cannot be required.'));
}
if ($form_state['values']['register']) {
form_set_error('register', t('A hidden field cannot be set to visible on the user registration form.'));
}
}
}
/**
* Process profile_field_form submissions.
*/
function profile_field_form_submit($form, &$form_state) {
if (!isset($form_state['values']['options'])) {
$form_state['values']['options'] = '';
}
if (!isset($form_state['values']['page'])) {
$form_state['values']['page'] = '';
}
// Remove all elements that are not profile_field columns.
$values = array_intersect_key($form_state['values'], array_flip(array('type', 'category', 'title', 'name', 'explanation', 'visibility', 'page', 'weight', 'autocomplete', 'required', 'register', 'options')));
if (!isset($form_state['values']['fid'])) {
db_insert('profile_field')
->fields($values)
->execute();
drupal_set_message(t('The field has been created.'));
watchdog('profile', 'Profile field %field added under category %category.', array('%field' => $form_state['values']['title'], '%category' => $form_state['values']['category']), WATCHDOG_NOTICE, l(t('view'), 'admin/config/people/profile'));
}
else {
db_update('profile_field')
->fields($values)
->condition('fid', $form_state['values']['fid'])
->execute();
drupal_set_message(t('The field has been updated.'));
}
cache_clear_all();
menu_rebuild();
$form_state['redirect'] = 'admin/config/people/profile';
return;
}
/**
* Menu callback; deletes a field from all user profiles.
*/
function profile_field_delete($form, &$form_state, $fid) {
$field = db_query("SELECT title FROM {profile_field} WHERE fid = :fid", array(':fid' => $fid))->fetchObject();
if (!$field) {
drupal_not_found();
return;
}
$form['fid'] = array('#type' => 'value', '#value' => $fid);
$form['title'] = array('#type' => 'value', '#value' => $field->title);
return confirm_form($form,
t('Are you sure you want to delete the field %field?', array('%field' => $field->title)), 'admin/config/people/profile',
t('This action cannot be undone. If users have entered values into this field in their profile, these entries will also be deleted. If you want to keep the user-entered data, instead of deleting the field you may wish to edit this field and change it to a hidden profile field so that it may only be accessed by administrators.', array('@edit-field' => url('admin/config/people/profile/edit/' . $fid))),
t('Delete'), t('Cancel'));
}
/**
* Process a field delete form submission.
*/
function profile_field_delete_submit($form, &$form_state) {
db_delete('profile_field')
->condition('fid', $form_state['values']['fid'])
->execute();
db_delete('profile_value')
->condition('fid', $form_state['values']['fid'])
->execute();
cache_clear_all();
drupal_set_message(t('The field %field has been deleted.', array('%field' => $form_state['values']['title'])));
watchdog('profile', 'Profile field %field deleted.', array('%field' => $form_state['values']['title']), WATCHDOG_NOTICE, l(t('view'), 'admin/config/people/profile'));
$form_state['redirect'] = 'admin/config/people/profile';
return;
}
/**
* Retrieve a pipe delimited string of autocomplete suggestions for profile categories
*/
function profile_admin_settings_autocomplete($string) {
$matches = array();
$result = db_select('profile_field')
->fields('profile_field', array('category'))
->condition('category', db_like($string) . '%', 'LIKE')
->range(0, 10)
->execute();
foreach ($result as $data) {
$matches[$data->category] = check_plain($data->category);
}
drupal_json_output($matches);
}
#profile-fields td.category {
font-weight: bold;
}
#profile-fields tr.category-message {
color: #999;
}
#profile-fields tr.category-populated {
display: none;
}
name = Profile
description = Supports configurable user profiles.
package = Core
version = VERSION
core = 7.x
files[] = profile.test
configure = admin/config/people/profile
; The Profile module is deprecated, and included in Drupal 7 for legacy
; purposes only. By default, the module will be hidden from the UI unless you
; are upgrading a site that uses the Profile module to extend user profiles.
; See user_system_info_alter().
hidden = TRUE
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
'Stores profile field information.',
'fields' => array(
'fid' => array(
'type' => 'serial',
'not null' => TRUE,
'description' => 'Primary Key: Unique profile field ID.',
),
'title' => array(
'type' => 'varchar',
'length' => 255,
'not null' => FALSE,
'description' => 'Title of the field shown to the end user.',
),
'name' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
'description' => 'Internal name of the field used in the form HTML and URLs.',
),
'explanation' => array(
'type' => 'text',
'not null' => FALSE,
'description' => 'Explanation of the field to end users.',
),
'category' => array(
'type' => 'varchar',
'length' => 255,
'not null' => FALSE,
'description' => 'Profile category that the field will be grouped under.',
),
'page' => array(
'type' => 'varchar',
'length' => 255,
'not null' => FALSE,
'description' => "Title of page used for browsing by the field's value",
),
'type' => array(
'type' => 'varchar',
'length' => 128,
'not null' => FALSE,
'description' => 'Type of form field.',
),
'weight' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'Weight of field in relation to other profile fields.',
),
'required' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'size' => 'tiny',
'description' => 'Whether the user is required to enter a value. (0 = no, 1 = yes)',
),
'register' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'size' => 'tiny',
'description' => 'Whether the field is visible in the user registration form. (1 = yes, 0 = no)',
),
'visibility' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'size' => 'tiny',
'description' => 'The level of visibility for the field. (0 = hidden, 1 = private, 2 = public on profile but not member list pages, 3 = public on profile and list pages)',
),
'autocomplete' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'size' => 'tiny',
'description' => 'Whether form auto-completion is enabled. (0 = disabled, 1 = enabled)',
),
'options' => array(
'type' => 'text',
'not null' => FALSE,
'description' => 'List of options to be used in a list selection field.',
),
),
'indexes' => array(
'category' => array('category'),
),
'unique keys' => array(
'name' => array('name'),
),
'primary key' => array('fid'),
);
$schema['profile_value'] = array(
'description' => 'Stores values for profile fields.',
'fields' => array(
'fid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => 'The {profile_field}.fid of the field.',
),
'uid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => 'The {users}.uid of the profile user.',
),
'value' => array(
'type' => 'text',
'not null' => FALSE,
'description' => 'The value for the field.',
),
),
'primary key' => array('uid', 'fid'),
'indexes' => array(
'fid' => array('fid'),
),
'foreign keys' => array(
'profile_field' => array(
'table' => 'profile_field',
'columns' => array('fid' => 'fid'),
),
'profile_user' => array(
'table' => 'users',
'columns' => array('uid' => 'uid'),
),
),
);
return $schema;
}
/**
* Rename {profile_fields} table to {profile_field} and {profile_values} to {profile_value}.
*/
function profile_update_7001() {
db_rename_table('profile_fields', 'profile_field');
db_rename_table('profile_values', 'profile_value');
}
/**
* Change the weight column to normal int.
*/
function profile_update_7002() {
db_change_field('profile_field', 'weight', 'weight', array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => 'Weight of field in relation to other profile fields.',
));
}
(function ($) {
/**
* Add functionality to the profile drag and drop table.
*
* This behavior is dependent on the tableDrag behavior, since it uses the
* objects initialized in that behavior to update the row. It shows and hides
* a warning message when removing the last field from a profile category.
*/
Drupal.behaviors.profileDrag = {
attach: function (context, settings) {
var table = $('#profile-fields');
var tableDrag = Drupal.tableDrag['profile-fields']; // Get the profile tableDrag object.
// Add a handler for when a row is swapped, update empty categories.
tableDrag.row.prototype.onSwap = function (swappedRow) {
var rowObject = this;
$('tr.category-message', table).each(function () {
// If the dragged row is in this category, but above the message row, swap it down one space.
if ($(this).prev('tr').get(0) == rowObject.element) {
// Prevent a recursion problem when using the keyboard to move rows up.
if ((rowObject.method != 'keyboard' || rowObject.direction == 'down')) {
rowObject.swap('after', this);
}
}
// This category has become empty
if ($(this).next('tr').is(':not(.draggable)') || $(this).next('tr').length == 0) {
$(this).removeClass('category-populated').addClass('category-empty');
}
// This category has become populated.
else if ($(this).is('.category-empty')) {
$(this).removeClass('category-empty').addClass('category-populated');
}
});
};
// Add a handler so when a row is dropped, update fields dropped into new categories.
tableDrag.onDrop = function () {
dragObject = this;
if ($(dragObject.rowObject.element).prev('tr').is('.category-message')) {
var categoryRow = $(dragObject.rowObject.element).prev('tr').get(0);
var categoryNum = categoryRow.className.replace(/([^ ]+[ ]+)*category-([^ ]+)-message([ ]+[^ ]+)*/, '$2');
var categoryField = $('select.profile-category', dragObject.rowObject.element);
var weightField = $('select.profile-weight', dragObject.rowObject.element);
var oldcategoryNum = weightField[0].className.replace(/([^ ]+[ ]+)*profile-weight-([^ ]+)([ ]+[^ ]+)*/, '$2');
if (!categoryField.is('.profile-category-' + categoryNum)) {
categoryField.removeClass('profile-category-' + oldcategoryNum).addClass('profile-category-' + categoryNum);
weightField.removeClass('profile-weight-' + oldcategoryNum).addClass('profile-weight-' + categoryNum);
categoryField.val(categoryField[0].options[categoryNum].value);
}
}
};
}
};
})(jQuery);
' . t('About') . '';
$output .= '' . t('The Profile module allows site administrators to define custom fields (such as country, full name, or age) for user profiles, which are then displayed in the My Account section. This permits users of a site to share more information about themselves, and can help community-based sites organize users around specific information. For more information, see the online handbook entry for Profile module .', array('@user' => url('user'), '@profile' => 'http://drupal.org/documentation/modules/profile/')) . '
';
$output .= '' . t('Uses') . ' ';
$output .= '';
$output .= '' . t('Adding fields to the default profile') . ' ';
$output .= '' . t('To provide the ability for users to enter more information about themselves, the Profile module allows additional fields to be added to the default user profile. Examples of common additions would be Location , Company , Age , or About me .') . ' ';
$output .= '' . t('User information pages') . ' ';
$output .= '' . t('The Profile module enables links to see further information about site users. You can view both a main User list page , and more specified pages by clicking on linked fields in any profile. For example, the People who live in Canada listing on Drupal.org displays all users who have entered Canada in the Country field on their user profile.', array('@profile' => url('profile'), '@profile-country' => 'http://drupal.org/profile/country/Canada')) . ' ';
$output .= '' . t('Author information block') . ' ';
$output .= '' . t('The Author information block is a default block created by the Profile module that can be enabled on the Blocks administration page . It shows visitors of your website information about the author of the page they are reading.', array('@blocks' => url('admin/structure/block'))) . ' ';
$output .= ' ';
return $output;
case 'admin/config/people/profile':
return '' . t("This page displays a list of the existing custom profile fields to be displayed on a user's My account page. To provide structure, similar or related fields may be placed inside a category. To add a new category (or edit an existing one), edit a profile field and provide a new category name.") . '
';
}
}
/**
* Implements hook_theme().
*/
function profile_theme() {
return array(
'profile_block' => array(
'variables' => array('account' => NULL, 'fields' => array()),
'template' => 'profile-block',
),
'profile_listing' => array(
'variables' => array('account' => NULL, 'fields' => array()),
'template' => 'profile-listing',
),
'profile_wrapper' => array(
'variables' => array('content' => NULL),
'template' => 'profile-wrapper',
),
'profile_admin_overview' => array(
'render element' => 'form',
'file' => 'profile.admin.inc',
)
);
}
/**
* Implements hook_menu().
*/
function profile_menu() {
$items['profile'] = array(
'title' => 'User list',
'page callback' => 'profile_browse',
'access arguments' => array('access user profiles'),
'file' => 'profile.pages.inc',
'type' => MENU_SUGGESTED_ITEM,
);
$items['admin/config/people/profile'] = array(
'title' => 'Profiles',
'description' => 'Create customizable fields for your users.',
'page callback' => 'drupal_get_form',
'page arguments' => array('profile_admin_overview'),
'access arguments' => array('administer users'),
'file' => 'profile.admin.inc',
);
$items['admin/config/people/profile/add'] = array(
'title' => 'Add field',
'page callback' => 'drupal_get_form',
'page arguments' => array('profile_field_form'),
'access arguments' => array('administer users'),
'type' => MENU_VISIBLE_IN_BREADCRUMB,
'file' => 'profile.admin.inc',
);
$items['admin/config/people/profile/autocomplete'] = array(
'title' => 'Profile category autocomplete',
'page callback' => 'profile_admin_settings_autocomplete',
'access arguments' => array('administer users'),
'file' => 'profile.admin.inc',
'type' => MENU_CALLBACK,
);
$items['admin/config/people/profile/edit'] = array(
'title' => 'Edit field',
'page callback' => 'drupal_get_form',
'page arguments' => array('profile_field_form'),
'access arguments' => array('administer users'),
'type' => MENU_VISIBLE_IN_BREADCRUMB,
'file' => 'profile.admin.inc',
);
$items['admin/config/people/profile/delete'] = array(
'title' => 'Delete field',
'page callback' => 'drupal_get_form',
'page arguments' => array('profile_field_delete'),
'access arguments' => array('administer users'),
'type' => MENU_VISIBLE_IN_BREADCRUMB,
'file' => 'profile.admin.inc',
);
$items['profile/autocomplete'] = array(
'title' => 'Profile autocomplete',
'page callback' => 'profile_autocomplete',
'access arguments' => array('access user profiles'),
'file' => 'profile.pages.inc',
'type' => MENU_CALLBACK,
);
return $items;
}
/**
* Implements hook_block_info().
*/
function profile_block_info() {
$blocks['author-information']['info'] = t('Author information');
$blocks['author-information']['cache'] = DRUPAL_CACHE_PER_PAGE | DRUPAL_CACHE_PER_ROLE;
return $blocks;
}
/**
* Implements hook_block_configure().
*/
function profile_block_configure($delta = '') {
// Compile a list of fields to show
$fields = array();
$result = db_query('SELECT name, title, weight, visibility FROM {profile_field} WHERE visibility IN (:visibility) ORDER BY weight', array(':visibility' => array(PROFILE_PUBLIC, PROFILE_PUBLIC_LISTINGS)));
foreach ($result as $record) {
$fields[$record->name] = check_plain($record->title);
}
$fields['user_profile'] = t('Link to full user profile');
$form['profile_block_author_fields'] = array(
'#type' => 'checkboxes',
'#title' => t('Profile fields to display'),
'#default_value' => variable_get('profile_block_author_fields', array()),
'#options' => $fields,
'#description' => t('Select which profile fields you wish to display in the block. Only fields designated as public in the profile field configuration are available.', array('@profile-admin' => url('admin/config/people/profile'))),
);
return $form;
}
/**
* Implements hook_block_save().
*/
function profile_block_save($delta = '', $edit = array()) {
variable_set('profile_block_author_fields', $edit['profile_block_author_fields']);
}
/**
* Implements hook_block_view().
*/
function profile_block_view($delta = '') {
if (user_access('access user profiles')) {
$output = '';
if (arg(0) == 'node' && is_numeric(arg(1)) && arg(2) == NULL) {
$node = node_load(arg(1));
$account = user_load($node->uid);
if ($use_fields = variable_get('profile_block_author_fields', array())) {
// Compile a list of fields to show.
$fields = array();
$result = db_query('SELECT * FROM {profile_field} WHERE visibility IN (:visibility) ORDER BY weight', array(':visibility' => array(PROFILE_PUBLIC, PROFILE_PUBLIC_LISTINGS)));
foreach ($result as $record) {
// Ensure that field is displayed only if it is among the defined block fields and, if it is private, the user has appropriate permissions.
if (isset($use_fields[$record->name]) && $use_fields[$record->name]) {
$fields[] = $record;
}
}
}
if (!empty($fields)) {
$profile = _profile_update_user_fields($fields, $account);
$output .= theme('profile_block', array('account' => $account, 'fields' => $profile));
}
if (isset($use_fields['user_profile']) && $use_fields['user_profile']) {
$output .= '' . l(t('View full user profile'), 'user/' . $account->uid) . '
';
}
}
if ($output) {
$block['subject'] = t('About %name', array('%name' => format_username($account)));
$block['content'] = $output;
return $block;
}
}
}
/**
* Implements hook_user_presave().
*/
function profile_user_presave(&$edit, $account, $category) {
if (!empty($account->uid)) {
profile_save_profile($edit, $account, $category);
}
}
/**
* Implements hook_user_insert().
*/
function profile_user_insert(&$edit, $account, $category) {
profile_save_profile($edit, $account, $category, TRUE);
}
/**
* Implements hook_user_cancel().
*/
function profile_user_cancel($edit, $account, $method) {
switch ($method) {
case 'user_cancel_reassign':
db_delete('profile_value')
->condition('uid', $account->uid)
->execute();
}
}
/**
* Implements hook_user_delete().
*/
function profile_user_delete($account) {
db_delete('profile_value')
->condition('uid', $account->uid)
->execute();
}
/**
* Implements hook_user_load().
*/
function profile_user_load($users) {
$result = db_query('SELECT f.name, f.type, v.uid, v.value FROM {profile_field} f INNER JOIN {profile_value} v ON f.fid = v.fid WHERE uid IN (:uids)', array(':uids' => array_keys($users)));
foreach ($result as $record) {
if (empty($users[$record->uid]->{$record->name})) {
$users[$record->uid]->{$record->name} = _profile_field_serialize($record->type) ? unserialize($record->value) : $record->value;
}
}
}
function profile_save_profile(&$edit, $account, $category, $register = FALSE) {
$result = _profile_get_fields($category, $register);
foreach ($result as $field) {
if (_profile_field_serialize($field->type)) {
$edit[$field->name] = serialize($edit[$field->name]);
}
db_merge('profile_value')
->key(array(
'fid' => $field->fid,
'uid' => $account->uid,
))
->fields(array('value' => $edit[$field->name]))
->execute();
}
}
function profile_view_field($account, $field) {
// Only allow browsing of private fields for admins, if browsing is enabled,
// and if a user has permission to view profiles. Note that this check is
// necessary because a user may always see their own profile.
$browse = user_access('access user profiles')
&& (user_access('administer users') || $field->visibility != PROFILE_PRIVATE)
&& !empty($field->page);
if (isset($account->{$field->name}) && $value = $account->{$field->name}) {
switch ($field->type) {
case 'textarea':
return check_markup($value, filter_default_format($account), '', TRUE);
case 'textfield':
case 'selection':
return $browse ? l($value, 'profile/' . $field->name . '/' . $value) : check_plain($value);
case 'checkbox':
return $browse ? l($field->title, 'profile/' . $field->name) : check_plain($field->title);
case 'url':
return '' . check_plain($value) . ' ';
case 'date':
$format = substr(variable_get('date_format_short', 'm/d/Y - H:i'), 0, 5);
// Note: Avoid PHP's date() because it does not handle dates before
// 1970 on Windows. This would make the date field useless for e.g.
// birthdays.
$replace = array(
'd' => sprintf('%02d', $value['day']),
'j' => $value['day'],
'm' => sprintf('%02d', $value['month']),
'M' => map_month($value['month']),
'Y' => $value['year'],
'H:i' => NULL,
'g:ia' => NULL,
);
return strtr($format, $replace);
case 'list':
$values = preg_split("/[,\n\r]/", $value);
$fields = array();
foreach ($values as $value) {
if ($value = trim($value)) {
$fields[] = $browse ? l($value, 'profile/' . $field->name . '/' . $value) : check_plain($value);
}
}
return implode(', ', $fields);
}
}
}
/**
* Implements hook_user_view().
*/
function profile_user_view($account) {
// Show private fields to administrators and people viewing their own account.
if (user_access('administer users') || $GLOBALS['user']->uid == $account->uid) {
$result = db_query('SELECT * FROM {profile_field} WHERE visibility <> :hidden ORDER BY category, weight', array(':hidden' => PROFILE_HIDDEN));
}
else {
$result = db_query('SELECT * FROM {profile_field} WHERE visibility <> :private AND visibility <> :hidden ORDER BY category, weight', array(':private' => PROFILE_PRIVATE, ':hidden' => PROFILE_HIDDEN));
}
$fields = array();
foreach ($result as $field) {
if ($value = profile_view_field($account, $field)) {
$title = ($field->type != 'checkbox') ? check_plain($field->title) : NULL;
// Create a single fieldset for each category.
if (!isset($account->content[$field->category])) {
$account->content[$field->category] = array(
'#type' => 'user_profile_category',
'#title' => $field->category,
);
}
$account->content[$field->category][$field->name] = array(
'#type' => 'user_profile_item',
'#title' => $title,
'#markup' => $value,
'#weight' => $field->weight,
'#attributes' => array('class' => array('profile-' . $field->name)),
);
}
}
}
function _profile_form_explanation($field) {
$output = filter_xss_admin($field->explanation);
if ($field->type == 'list') {
$output .= ' ' . t('Put each item on a separate line or separate them by commas. No HTML allowed.');
}
if ($field->visibility == PROFILE_PRIVATE) {
$output .= ' ' . t('The content of this field is kept private and will not be shown publicly.');
}
return $output;
}
/**
* Implements hook_form_alter().
*/
function profile_form_alter(&$form, &$form_state, $form_id) {
if (!($form_id == 'user_register_form' || $form_id == 'user_profile_form')) {
return;
}
$form['#validate'][] = 'profile_user_form_validate';
$account = $form['#user'];
$result = _profile_get_fields($form['#user_category'], $form['#user_category'] == 'register');
$weight = 1;
foreach ($result as $field) {
$category = $field->category;
if (!isset($form[$category])) {
$form[$category] = array('#type' => 'fieldset', '#title' => check_plain($category), '#weight' => $weight++);
}
switch ($field->type) {
case 'textfield':
case 'url':
$form[$category][$field->name] = array(
'#type' => 'textfield',
'#title' => check_plain($field->title),
'#default_value' => isset($account->{$field->name}) ? $account->{$field->name} : '',
'#maxlength' => 255,
'#description' => _profile_form_explanation($field),
'#required' => $field->required,
);
if ($field->autocomplete) {
$form[$category][$field->name]['#autocomplete_path'] = "profile/autocomplete/" . $field->fid;
}
break;
case 'textarea':
$form[$category][$field->name] = array(
'#type' => 'textarea',
'#title' => check_plain($field->title),
'#default_value' => isset($account->{$field->name}) ? $account->{$field->name} : '',
'#description' => _profile_form_explanation($field),
'#required' => $field->required,
);
break;
case 'list':
$form[$category][$field->name] = array(
'#type' => 'textarea',
'#title' => check_plain($field->title),
'#default_value' => isset($account->{$field->name}) ? $account->{$field->name} : '',
'#description' => _profile_form_explanation($field),
'#required' => $field->required,
);
break;
case 'checkbox':
$form[$category][$field->name] = array(
'#type' => 'checkbox',
'#title' => check_plain($field->title),
'#default_value' => isset($account->{$field->name}) ? $account->{$field->name} : '',
'#description' => _profile_form_explanation($field),
'#required' => $field->required,
);
break;
case 'selection':
$options = array();
$lines = preg_split("/[\n\r]/", $field->options);
foreach ($lines as $line) {
if ($line = trim($line)) {
$options[$line] = $line;
}
}
$form[$category][$field->name] = array(
'#type' => 'select',
'#title' => check_plain($field->title),
'#default_value' => isset($account->{$field->name}) ? $account->{$field->name} : '',
'#options' => $options,
'#description' => _profile_form_explanation($field),
'#required' => $field->required,
'#empty_value' => 0,
);
break;
case 'date':
$form[$category][$field->name] = array(
'#type' => 'date',
'#title' => check_plain($field->title),
'#default_value' => isset($account->{$field->name}) ? $account->{$field->name} : '',
'#description' => _profile_form_explanation($field),
'#required' => $field->required,
);
break;
}
}
}
/**
* Helper function: update an array of user fields by calling profile_view_field
*/
function _profile_update_user_fields($fields, $account) {
foreach ($fields as $key => $field) {
$fields[$key]->value = profile_view_field($account, $field);
}
return $fields;
}
/**
* Form validation handler for the user register/profile form.
*
* @see profile_form_alter()
*/
function profile_user_form_validate($form, &$form_state) {
$result = _profile_get_fields($form['#user_category'], $form['#user_category'] == 'register');
foreach ($result as $field) {
if (!empty($form_state['values'][$field->name])) {
if ($field->type == 'url' && !valid_url($form_state['values'][$field->name], TRUE)) {
form_set_error($field->name, t('The value provided for %field is not a valid URL.', array('%field' => $field->title)));
}
}
elseif ($field->required && !user_access('administer users')) {
form_set_error($field->name, t('The field %field is required.', array('%field' => $field->title)));
}
}
}
/**
* Implements hook_user_categories().
*/
function profile_user_categories() {
$result = db_query("SELECT DISTINCT(category) FROM {profile_field}");
$data = array();
foreach ($result as $category) {
$data[] = array(
'name' => $category->category,
'title' => $category->category,
'weight' => 3,
'access callback' => 'profile_category_access',
'access arguments' => array(1, $category->category)
);
}
return $data;
}
/**
* Menu item access callback - check if a user has access to a profile category.
*/
function profile_category_access($account, $category) {
if (user_access('administer users') && $account->uid > 0) {
return TRUE;
}
else {
$category_visible = (bool) db_query_range('SELECT 1 FROM {profile_field} WHERE category = :category AND visibility <> :visibility', 0, 1, array(
':category' => $category,
':visibility' => PROFILE_HIDDEN
))->fetchField();
return user_edit_access($account) && $category_visible;
}
}
/**
* Process variables for profile-block.tpl.php.
*
* The $variables array contains the following arguments:
* - $account
* - $fields
*
* @see profile-block.tpl.php
*/
function template_preprocess_profile_block(&$variables) {
$variables['user_picture'] = theme('user_picture', array('account' => $variables['account']));
$variables['profile'] = array();
// Supply filtered version of $fields that have values.
foreach ($variables['fields'] as $field) {
if ($field->value) {
$variables['profile'][$field->name] = new stdClass();
$variables['profile'][$field->name]->title = check_plain($field->title);
$variables['profile'][$field->name]->value = $field->value;
$variables['profile'][$field->name]->type = $field->type;
}
}
}
/**
* Process variables for profile-listing.tpl.php.
*
* The $variables array contains the following arguments:
* - $account
* - $fields
*
* @see profile-listing.tpl.php
*/
function template_preprocess_profile_listing(&$variables) {
$variables['user_picture'] = theme('user_picture', array('account' => $variables['account']));
$variables['name'] = theme('username', array('account' => $variables['account']));
$variables['profile'] = array();
// Supply filtered version of $fields that have values.
foreach ($variables['fields'] as $field) {
if ($field->value) {
$variables['profile'][$field->name] = new stdClass();
$variables['profile'][$field->name]->title = $field->title;
$variables['profile'][$field->name]->value = $field->value;
$variables['profile'][$field->name]->type = $field->type;
}
}
}
/**
* Process variables for profile-wrapper.tpl.php.
*
* The $variables array contains the following arguments:
* - $content
*
* @see profile-wrapper.tpl.php
*/
function template_preprocess_profile_wrapper(&$variables) {
$variables['current_field'] = '';
if ($field = arg(1)) {
$variables['current_field'] = $field;
$variables['theme_hook_suggestions'][] = 'profile_wrapper__' . $field;
}
}
function _profile_field_types($type = NULL) {
$types = array('textfield' => t('single-line textfield'),
'textarea' => t('multi-line textfield'),
'checkbox' => t('checkbox'),
'selection' => t('list selection'),
'list' => t('freeform list'),
'url' => t('URL'),
'date' => t('date'));
return isset($type) ? $types[$type] : $types;
}
function _profile_field_serialize($type = NULL) {
return $type == 'date';
}
function _profile_get_fields($category, $register = FALSE) {
$query = db_select('profile_field');
if ($register) {
$query->condition('register', 1);
}
else {
$query->condition('category', db_like($category), 'LIKE');
}
if (!user_access('administer users')) {
$query->condition('visibility', PROFILE_HIDDEN, '<>');
}
return $query
->fields('profile_field')
->orderBy('category', 'ASC')
->orderBy('weight', 'ASC')
->execute();
}
$name))->fetchObject();
if ($name && $field->fid) {
// Only allow browsing of fields that have a page title set.
if (empty($field->page)) {
return MENU_NOT_FOUND;
}
// Do not allow browsing of private and hidden fields by non-admins.
if (!user_access('administer users') && ($field->visibility == PROFILE_PRIVATE || $field->visibility == PROFILE_HIDDEN)) {
return MENU_ACCESS_DENIED;
}
// Compile a list of fields to show.
$fields = db_query('SELECT name, title, type, weight, page, visibility FROM {profile_field} WHERE fid <> :fid AND visibility = :visibility ORDER BY weight', array(
':fid' => $field->fid,
':visibility' => PROFILE_PUBLIC_LISTINGS,
))->fetchAll();
$query = db_select('users', 'u')->extend('PagerDefault');
$query->join('profile_value', 'v', 'u.uid = v.uid');
$query
->fields('u', array('uid', 'access'))
->condition('v.fid', $field->fid)
->condition('u.status', 0, '<>')
->orderBy('u.access', 'DESC');
// Determine what query to use:
$arguments = array($field->fid);
switch ($field->type) {
case 'checkbox':
$query->condition('v.value', 1);
break;
case 'textfield':
case 'selection':
$query->condition('v.value', $value);
break;
case 'list':
$query->condition('v.value', '%' . db_like($value) . '%', 'LIKE');
break;
default:
return MENU_NOT_FOUND;
}
$uids = $query
->limit(20)
->execute()
->fetchCol();
// Load the users.
$users = user_load_multiple($uids);
$content = '';
foreach ($users as $account) {
$profile = _profile_update_user_fields($fields, $account);
$content .= theme('profile_listing', array('account' => $account, 'fields' => $profile));
}
$output = theme('profile_wrapper', array('content' => $content));
$output .= theme('pager');
if ($field->type == 'selection' || $field->type == 'list' || $field->type == 'textfield') {
$title = strtr(check_plain($field->page), array('%value' => drupal_placeholder($value)));
}
else {
$title = check_plain($field->page);
}
drupal_set_title($title, PASS_THROUGH);
return $output;
}
elseif ($name && !$field->fid) {
return MENU_NOT_FOUND;
}
else {
// Compile a list of fields to show.
$fields = db_query('SELECT name, title, type, weight, page, visibility FROM {profile_field} WHERE visibility = :visibility ORDER BY category, weight', array(':visibility' => PROFILE_PUBLIC_LISTINGS))->fetchAll();
// Extract the affected users:
$query = db_select('users', 'u')->extend('PagerDefault');
$uids = $query
->fields('u', array('uid', 'access'))
->condition('u.uid', 0, '>')
->condition('u.status', 0, '>')
->orderBy('u.access', 'DESC')
->limit(20)
->execute()
->fetchCol();
$users = user_load_multiple($uids);
$content = '';
foreach ($users as $account) {
$profile = _profile_update_user_fields($fields, $account);
$content .= theme('profile_listing', array('account' => $account, 'fields' => $profile));
}
$output = theme('profile_wrapper', array('content' => $content));
$output .= theme('pager');
drupal_set_title(t('User list'));
return $output;
}
}
/**
* Callback to allow autocomplete of profile text fields.
*/
function profile_autocomplete($field, $string) {
$matches = array();
$autocomplete_field = (bool) db_query_range("SELECT 1 FROM {profile_field} WHERE fid = :fid AND autocomplete = 1", 0, 1, array(':fid' => $field))->fetchField();
if ($autocomplete_field) {
$values = db_select('profile_value')
->fields('profile_value', array('value'))
->condition('fid', $field)
->condition('value', db_like($string) . '%', 'LIKE')
->groupBy('value')
->orderBy('value')
->range(0, 10)
->execute()->fetchCol();
foreach ($values as $value) {
$matches[$value] = check_plain($value);
}
}
drupal_json_output($matches);
}
admin_user = $this->drupalCreateUser(array('administer users', 'access user profiles', 'administer blocks'));
// This is the user whose profile will be edited.
$this->normal_user = $this->drupalCreateUser();
}
/**
* Create a profile field.
*
* @param $type
* The field type to be created.
* @param $category
* The category in which the field should be created.
* @param $edit
* Additional parameters to be submitted.
* @return
* The fid of the field that was just created.
*/
function createProfileField($type = 'textfield', $category = 'simpletest', $edit = array()) {
$edit['title'] = $title = $this->randomName(8);
$edit['name'] = $form_name = 'profile_' . $title;
$edit['category'] = $category;
$edit['explanation'] = $this->randomName(50);
$this->drupalPost('admin/config/people/profile/add/' . $type, $edit, t('Save field'));
$fid = db_query("SELECT fid FROM {profile_field} WHERE title = :title", array(':title' => $title))->fetchField();
$this->assertTrue($fid, 'New Profile field has been entered in the database');
// Check that the new field is appearing on the user edit form.
$this->drupalGet('user/' . $this->admin_user->uid . '/edit/' . $category);
// Checking field.
if ($type == 'date') {
$this->assertField($form_name . '[month]', 'Found month selection field');
$this->assertField($form_name . '[day]', 'Found day selection field');
$this->assertField($form_name . '[year]', 'Found day selection field');
}
else {
$this->assertField($form_name , format_string('Found form named @name', array('@name' => $form_name)));
}
// Checking name.
$this->assertText($title, format_string('Checking title for field %title', array('%title' => $title)));
// Checking explanation.
$this->assertText($edit['explanation'], format_string('Checking explanation for field %title', array('%title' => $title)));
return array(
'fid' => $fid,
'type' => $type,
'form_name' => $form_name,
'title' => $title,
'category' => $category,
);
}
/**
* Update a profile field.
*
* @param $fid
* The fid of the field to be updated.
* @param $type
* The type of field to be updated.
* @param $edit
* Field parameters to be submitted.
* @return
* Array representation of the updated field.
*/
function updateProfileField($fid, $type = 'textfield', $edit = array()) {
$form_name = $edit['name'];
$title = $edit['title'];
$category = $edit['category'];
$this->drupalPost('admin/config/people/profile/edit/' . $fid, $edit, t('Save field'));
// Check that the updated field is appearing on the user edit form.
$this->drupalGet('user/' . $this->admin_user->uid . '/edit/' . $category);
// Checking field.
if ($type == 'date') {
$this->assertField($form_name . '[month]', 'Found month selection field');
$this->assertField($form_name . '[day]', 'Found day selection field');
$this->assertField($form_name . '[year]', 'Found day selection field');
}
else {
$this->assertField($form_name , format_string('Found form named @name', array('@name' => $form_name)));
}
// Checking name.
$this->assertText($title, format_string('Checking title for field %title', array('%title' => $title)));
// Checking explanation.
$this->assertText($edit['explanation'], format_string('Checking explanation for field %title', array('%title' => $title)));
return array(
'fid' => $fid,
'type' => $type,
'form_name' => $form_name,
'title' => $title,
'category' => $category,
);
}
/**
* Set the profile field to a random value
*
* @param $field
* The field that should be set.
* @param $value
* The value for the field, defaults to a random string.
* @return
* The value that has been assigned to
*/
function setProfileField($field, $value = NULL) {
if (!isset($value)) {
$value = $this->randomName();
}
$edit = array(
$field['form_name'] => $value,
);
$this->drupalPost('user/' . $this->normal_user->uid . '/edit/' . $field['category'], $edit, t('Save'));
// Check profile page.
$content = $this->drupalGet('user/' . $this->normal_user->uid);
$this->assertText($field['title'], format_string('Found profile field with title %title', array('%title' => $field['title'])));
if ($field['type'] != 'checkbox') {
// $value must be cast to a string in order to be found by assertText.
$this->assertText("$value", format_string('Found profile field with value %value', array('%value' => $value)));
}
return $value;
}
/**
* Delete a profile field.
*
* @param $field
* The field to be deleted.
*/
function deleteProfileField($field) {
$this->drupalPost('admin/config/people/profile/delete/' . $field['fid'], array(), t('Delete'));
$this->drupalGet('admin/config/people/profile');
$this->assertNoText($field['title'], format_string('Checking deleted field %title', array('%title' => $field['title'])));
}
}
class ProfileTestFields extends ProfileTestCase {
public static function getInfo() {
return array(
'name' => 'Test single fields',
'description' => 'Testing profile module with add/edit/delete textfield, textarea, list, checkbox, and url fields into profile page',
'group' => 'Profile'
);
}
/**
* Test each of the field types. List selection and date fields are tested
* separately because they need some special handling.
*/
function testProfileFields() {
$this->drupalLogin($this->admin_user);
// Set test values for every field type.
$field_types = array(
'textfield' => $this->randomName(),
'textarea' => $this->randomName(),
'list' => $this->randomName(),
'checkbox' => 1,
// An underscore is an invalid character in a domain name. The method randomName can
// return an underscore.
'url' => 'http://www.' . str_replace('_', '', $this->randomName(10)) . '.org',
);
// For each field type, create a field, give it a value, update the field,
// and delete the field.
foreach ($field_types as $type => $value) {
$field = $this->createProfileField($type);
$this->setProfileField($field, $value);
$edit = array(
'name' => $field['form_name'],
'title' => $this->randomName(),
'category' => $field['category'],
'explanation' => $this->randomName(),
);
$field = $this->updateProfileField($field['fid'], $field['type'], $edit);
$this->deleteProfileField($field);
}
}
}
class ProfileTestSelect extends ProfileTestCase {
public static function getInfo() {
return array(
'name' => 'Test select field',
'description' => 'Testing profile module with add/edit/delete a select field',
'group' => 'Profile'
);
}
/**
* Create a list selection field, give it a value, update and delete the field.
*/
function testProfileSelectionField() {
$this->drupalLogin($this->admin_user);
$edit = array(
'options' => implode("\n", range(1, 10)),
);
$field = $this->createProfileField('selection', 'simpletest', $edit);
$this->setProfileField($field, rand(1, 10));
$edit = array(
'name' => $field['form_name'],
'title' => $this->randomName(),
'category' => $field['category'],
'explanation' => $this->randomName(),
);
$field = $this->updateProfileField($field['fid'], $field['type'], $edit);
$this->deleteProfileField($field);
}
}
class ProfileTestDate extends ProfileTestCase {
public static function getInfo() {
return array(
'name' => 'Test date field',
'description' => 'Testing profile module with add/edit/delete a date field',
'group' => 'Profile'
);
}
/**
* Create a date field, give it a value, update and delete the field.
*/
function testProfileDateField() {
$this->drupalLogin($this->admin_user);
variable_set('date_format_short', 'm/d/Y - H:i');
$field = $this->createProfileField('date');
// Set date to January 09, 1983
$edit = array(
$field['form_name'] . '[month]' => 1,
$field['form_name'] . '[day]' => 9,
$field['form_name'] . '[year]' => 1983,
);
$this->drupalPost('user/' . $this->normal_user->uid . '/edit/' . $field['category'], $edit, t('Save'));
// Check profile page.
$this->drupalGet('user/' . $this->normal_user->uid);
$this->assertText($field['title'], format_string('Found profile field with title %title', array('%title' => $field['title'])));
$this->assertText('01/09/1983', 'Found date profile field.');
$edit = array(
'name' => $field['form_name'],
'title' => $this->randomName(),
'category' => $field['category'],
'explanation' => $this->randomName(),
);
$field = $this->updateProfileField($field['fid'], $field['type'], $edit);
$this->deleteProfileField($field);
}
}
class ProfileTestWeights extends ProfileTestCase {
public static function getInfo() {
return array(
'name' => 'Test field weights',
'description' => 'Testing profile modules weigting of fields',
'group' => 'Profile'
);
}
function testProfileFieldWeights() {
$this->drupalLogin($this->admin_user);
$category = $this->randomName();
$field1 = $this->createProfileField('textfield', $category, array('weight' => 1));
$field2 = $this->createProfileField('textfield', $category, array('weight' => -1));
$this->setProfileField($field1, $this->randomName(8));
$this->setProfileField($field2, $this->randomName(8));
$profile_edit = $this->drupalGet('user/' . $this->normal_user->uid . '/edit/' . $category);
$this->assertTrue(strpos($profile_edit, $field1['title']) > strpos($profile_edit, $field2['title']), 'Profile field weights are respected on the user edit form.');
$profile_page = $this->drupalGet('user/' . $this->normal_user->uid);
$this->assertTrue(strpos($profile_page, $field1['title']) > strpos($profile_page, $field2['title']), 'Profile field weights are respected on the user profile page.');
}
}
/**
* Test profile field autocompletion and access.
*/
class ProfileTestAutocomplete extends ProfileTestCase {
public static function getInfo() {
return array(
'name' => 'Autocompletion',
'description' => 'Test profile fields with autocompletion.',
'group' => 'Profile'
);
}
/**
* Tests profile field autocompletion and access.
*/
function testAutocomplete() {
$this->drupalLogin($this->admin_user);
// Create a new profile field with autocompletion enabled.
$category = $this->randomName();
$field = $this->createProfileField('textfield', $category, array('weight' => 1, 'autocomplete' => 1));
// Enter profile field value.
$field['value'] = $this->randomName();
$this->setProfileField($field, $field['value']);
// Set some html for what we want to see in the page output later.
// Autocomplete always uses non-clean URLs.
$current_clean_url = isset($GLOBALS['conf']['clean_url']) ? $GLOBALS['conf']['clean_url'] : NULL;
$GLOBALS['conf']['clean_url'] = 0;
$autocomplete_url = url('profile/autocomplete/' . $field['fid'], array('absolute' => TRUE, 'script' => 'index.php'));
$GLOBALS['conf']['clean_url'] = $current_clean_url;
$autocomplete_id = drupal_html_id('edit-' . $field['form_name'] . '-autocomplete');
$autocomplete_html = '' . t('The RDF module enriches your content with metadata to let other applications (e.g., search engines, aggregators, and so on) better understand its relationships and attributes. This semantically enriched, machine-readable output for Drupal sites uses the RDFa specification which allows RDF data to be embedded in HTML markup. Other modules can define mappings of their data to RDF terms, and the RDF module makes this RDF data available to the theme. The core Drupal modules define RDF mappings for their data model, and the core Drupal themes output this RDF metadata information along with the human-readable visual information. For more information, see the online handbook entry for RDF module .', array('@rdfa' => 'http://www.w3.org/TR/xhtml-rdfa-primer/', '@rdf' => 'http://drupal.org/documentation/modules/rdf')) . '
';
return $output;
}
}
/**
* @defgroup rdf RDF Mapping API
* @{
* Functions to describe entities and bundles in RDF.
*
* The RDF module introduces RDF and RDFa to Drupal. RDF is a W3C standard to
* describe structured data. RDF can be serialized as RDFa in XHTML attributes
* to augment visual data with machine-readable hints.
* @see http://www.w3.org/RDF/
* @see http://www.w3.org/TR/xhtml-rdfa-primer/
*
* Modules can provide mappings of their bundles' data and metadata to RDF
* classes and properties. This module takes care of injecting these mappings
* into variables available to theme functions and templates. All Drupal core
* themes are coded to be RDFa compatible.
*
* Example mapping from node.module:
* @code
* array(
* 'type' => 'node',
* 'bundle' => RDF_DEFAULT_BUNDLE,
* 'mapping' => array(
* 'rdftype' => array('sioc:Item', 'foaf:Document'),
* 'title' => array(
* 'predicates' => array('dc:title'),
* ),
* 'created' => array(
* 'predicates' => array('dc:date', 'dc:created'),
* 'datatype' => 'xsd:dateTime',
* 'callback' => 'date_iso8601',
* ),
* 'body' => array(
* 'predicates' => array('content:encoded'),
* ),
* 'uid' => array(
* 'predicates' => array('sioc:has_creator'),
* ),
* 'name' => array(
* 'predicates' => array('foaf:name'),
* ),
* ),
* );
* @endcode
*/
/**
* RDF bundle flag: Default bundle.
*
* Implementations of hook_rdf_mapping() should use this constant for the
* 'bundle' key when defining a default set of RDF mappings for an entity type.
* Each bundle will inherit the default mappings defined for the entity type
* unless the bundle defines its own specific mappings.
*/
define('RDF_DEFAULT_BUNDLE', '');
/**
* Implements hook_rdf_namespaces().
*/
function rdf_rdf_namespaces() {
return array(
'content' => 'http://purl.org/rss/1.0/modules/content/',
'dc' => 'http://purl.org/dc/terms/',
'foaf' => 'http://xmlns.com/foaf/0.1/',
'og' => 'http://ogp.me/ns#',
'rdfs' => 'http://www.w3.org/2000/01/rdf-schema#',
'sioc' => 'http://rdfs.org/sioc/ns#',
'sioct' => 'http://rdfs.org/sioc/types#',
'skos' => 'http://www.w3.org/2004/02/skos/core#',
'xsd' => 'http://www.w3.org/2001/XMLSchema#',
);
}
/**
* Returns an array of RDF namespaces defined in modules that implement
* hook_rdf_namespaces().
*/
function rdf_get_namespaces() {
$rdf_namespaces = module_invoke_all('rdf_namespaces');
// module_invoke_all() uses array_merge_recursive() which might return nested
// arrays if several modules redefine the same prefix multiple times. We need
// to ensure the array of namespaces is flat and only contains strings as
// URIs.
foreach ($rdf_namespaces as $prefix => $uri) {
if (is_array($uri)) {
if (count(array_unique($uri)) == 1) {
// All namespaces declared for this prefix are the same, merge them all
// into a single namespace.
$rdf_namespaces[$prefix] = $uri[0];
}
else {
// There are conflicting namespaces for this prefix, do not include
// duplicates in order to avoid asserting any inaccurate RDF
// statements.
unset($rdf_namespaces[$prefix]);
}
}
}
return $rdf_namespaces;
}
/**
* Returns the mapping for attributes of a given entity type/bundle pair.
*
* @param $type
* An entity type.
* @param $bundle
* (optional) A bundle name.
*
* @return
* The mapping corresponding to the requested entity type/bundle pair or an
* empty array.
*/
function rdf_mapping_load($type, $bundle = RDF_DEFAULT_BUNDLE) {
// Retrieves the bundle-specific mapping from the entity info.
$entity_info = entity_get_info($type);
if (!empty($entity_info['bundles'][$bundle]['rdf_mapping'])) {
return $entity_info['bundles'][$bundle]['rdf_mapping'];
}
// If there is no mapping defined for this bundle, we return the default
// mapping that is defined for this entity type.
else {
return _rdf_get_default_mapping($type);
}
}
/**
* @} End of "defgroup rdf".
*/
/**
* Helper function to get the default RDF mapping for a given entity type.
*
* @param $type
* An entity type, e.g. 'node' or 'comment'.
*
* @return
* The RDF mapping or an empty array if no mapping is defined for this entity
* type.
*/
function _rdf_get_default_mapping($type) {
$default_mappings = &drupal_static(__FUNCTION__);
if (!isset($default_mappings)) {
// Get all of the modules that implement hook_rdf_mapping().
$modules = module_implements('rdf_mapping');
// Only consider the default entity mapping definitions.
foreach ($modules as $module) {
$mappings = module_invoke($module, 'rdf_mapping');
foreach ($mappings as $mapping) {
if ($mapping['bundle'] === RDF_DEFAULT_BUNDLE) {
$default_mappings[$mapping['type']] = $mapping['mapping'];
}
}
}
}
return isset($default_mappings[$type]) ? $default_mappings[$type] : array();
}
/**
* Helper function to retrieve an RDF mapping from the database.
*
* @param $type
* The entity type the mapping refers to.
* @param $bundle
* The bundle the mapping refers to.
*
* @return
* An RDF mapping structure or an empty array if no record was found.
*/
function _rdf_mapping_load($type, $bundle) {
$mappings = _rdf_mapping_load_multiple($type, array($bundle));
return $mappings ? reset($mappings) : array();
}
/**
* Helper function to retrieve a set of RDF mappings from the database.
*
* @param $type
* The entity type of the mappings.
* @param $bundles
* The bundles the mappings refer to.
*
* @return
* An array of RDF mapping structures, or an empty array.
*/
function _rdf_mapping_load_multiple($type, array $bundles) {
$mappings = db_select('rdf_mapping')
->fields(NULL, array('bundle', 'mapping'))
->condition('type', $type)
->condition('bundle', $bundles)
->execute()
->fetchAllKeyed();
foreach ($mappings as $bundle => $mapping) {
$mappings[$bundle] = unserialize($mapping);
}
return $mappings;
}
/**
* @addtogroup rdf
* @{
*/
/**
* Saves an RDF mapping to the database.
*
* Takes a mapping structure returned by hook_rdf_mapping() implementations
* and creates or updates a record mapping for each encountered entity
* type/bundle pair. If available, adds default values for non-existent mapping
* keys.
*
* @param $mapping
* The RDF mapping to save, as an array.
*
* @return
* Status flag indicating the outcome of the operation.
*/
function rdf_mapping_save($mapping) {
// In the case where a field has a mapping defined in the default entity
// mapping, but a mapping is not specified in the bundle-specific mapping,
// then use the default mapping for that field.
$mapping['mapping'] += _rdf_get_default_mapping($mapping['type']);
$status = db_merge('rdf_mapping')
->key(array(
'type' => $mapping['type'],
'bundle' => $mapping['bundle'],
))
->fields(array(
'mapping' => serialize($mapping['mapping']),
))
->execute();
entity_info_cache_clear();
return $status;
}
/**
* Deletes the mapping for the given bundle from the database.
*
* @param $type
* The entity type the mapping refers to.
* @param $bundle
* The bundle the mapping refers to.
*
* @return
* Return boolean TRUE if mapping deleted, FALSE if not.
*/
function rdf_mapping_delete($type, $bundle) {
$num_rows = db_delete('rdf_mapping')
->condition('type', $type)
->condition('bundle', $bundle)
->execute();
return (bool) ($num_rows > 0);
}
/**
* Builds an array of RDFa attributes for a given mapping. This array will
* typically be passed through drupal_attributes() to create the attributes
* variables that are available to template files. These include $attributes,
* $title_attributes, $content_attributes and the field-specific
* $item_attributes variables. For more information, see
* theme_rdf_template_variable_wrapper().
*
* @param $mapping
* An array containing a mandatory 'predicates' key and optional 'datatype',
* 'callback' and 'type' keys. For example:
* @code
* array(
* 'predicates' => array('dc:created'),
* 'datatype' => 'xsd:dateTime',
* 'callback' => 'date_iso8601',
* ),
* );
* @endcode
* @param $data
* A value that needs to be converted by the provided callback function.
*
* @return
* An array containing RDFa attributes suitable for drupal_attributes().
*/
function rdf_rdfa_attributes($mapping, $data = NULL) {
// The type of mapping defaults to 'property'.
$type = isset($mapping['type']) ? $mapping['type'] : 'property';
switch ($type) {
// The mapping expresses the relationship between two resources.
case 'rel':
case 'rev':
$attributes[$type] = $mapping['predicates'];
break;
// The mapping expresses the relationship between a resource and some
// literal text.
case 'property':
$attributes['property'] = $mapping['predicates'];
// Convert $data to a specific format as per the callback function.
if (isset($data) && isset($mapping['callback']) && function_exists($mapping['callback'])) {
$callback = $mapping['callback'];
$attributes['content'] = $callback($data);
}
if (isset($mapping['datatype'])) {
$attributes['datatype'] = $mapping['datatype'];
}
break;
}
return $attributes;
}
/**
* @} End of "addtogroup rdf".
*/
/**
* Implements hook_modules_installed().
*
* Checks if the installed modules have any RDF mapping definitions to declare
* and stores them in the rdf_mapping table.
*
* While both default entity mappings and specific bundle mappings can be
* defined in hook_rdf_mapping(), default entity mappings are not stored in the
* database. Only overridden mappings are stored in the database. The default
* entity mappings can be overriden by specific bundle mappings which are
* stored in the database and can be altered via the RDF CRUD mapping API.
*/
function rdf_modules_installed($modules) {
foreach ($modules as $module) {
$function = $module . '_rdf_mapping';
if (function_exists($function)) {
foreach ($function() as $mapping) {
// Only the bundle mappings are saved in the database.
if ($mapping['bundle'] !== RDF_DEFAULT_BUNDLE) {
rdf_mapping_save($mapping);
}
}
}
}
}
/**
* Implements hook_modules_uninstalled().
*/
function rdf_modules_uninstalled($modules) {
// @todo Remove RDF mappings of uninstalled modules.
}
/**
* Implements hook_entity_info_alter().
*
* Adds the proper RDF mapping to each entity type/bundle pair.
*
* @todo May need to move the comment below to another place.
* This hook should not be used by modules to alter the bundle mappings.
* The UI should always be authoritative. UI mappings are stored in the
* database and if hook_entity_info_alter was used to override module defined
* mappings, it would override the user defined mapping as well.
*/
function rdf_entity_info_alter(&$entity_info) {
// Loop through each entity type and its bundles.
foreach ($entity_info as $entity_type => $entity_type_info) {
if (!empty($entity_type_info['bundles'])) {
$bundles = array_keys($entity_type_info['bundles']);
$mappings = _rdf_mapping_load_multiple($entity_type, $bundles);
foreach ($bundles as $bundle) {
if (isset($mappings[$bundle])) {
$entity_info[$entity_type]['bundles'][$bundle]['rdf_mapping'] = $mappings[$bundle];
}
else {
// If no mapping was found in the database, assign the default RDF
// mapping for this entity type.
$entity_info[$entity_type]['bundles'][$bundle]['rdf_mapping'] = _rdf_get_default_mapping($entity_type);
}
}
}
}
}
/**
* Implements hook_entity_load().
*/
function rdf_entity_load($entities, $type) {
foreach ($entities as $entity) {
// Extracts the bundle of the entity being loaded.
list($id, $vid, $bundle) = entity_extract_ids($type, $entity);
$entity->rdf_mapping = rdf_mapping_load($type, $bundle);
}
}
/**
* Implements hook_comment_load().
*/
function rdf_comment_load($comments) {
foreach ($comments as $comment) {
// Pages with many comments can show poor performance. This information
// isn't needed until rdf_preprocess_comment() is called, but set it here
// to optimize performance for websites that implement an entity cache.
$comment->rdf_data['date'] = rdf_rdfa_attributes($comment->rdf_mapping['created'], $comment->created);
$comment->rdf_data['nid_uri'] = url('node/' . $comment->nid);
if ($comment->pid) {
$comment->rdf_data['pid_uri'] = url('comment/' . $comment->pid, array('fragment' => 'comment-' . $comment->pid));
}
}
}
/**
* Implements hook_theme().
*/
function rdf_theme() {
return array(
'rdf_template_variable_wrapper' => array(
'variables' => array('content' => NULL, 'attributes' => array(), 'context' => array(), 'inline' => TRUE),
),
'rdf_metadata' => array(
'variables' => array('metadata' => array()),
),
);
}
/**
* Template process function for adding extra tags to hold RDFa attributes.
*
* Since template files already have built-in support for $attributes,
* $title_attributes, and $content_attributes, and field templates have support
* for $item_attributes, we try to leverage those as much as possible. However,
* in some cases additional attributes are needed not covered by these. We deal
* with those here.
*/
function rdf_process(&$variables, $hook) {
// Handles attributes needed for content not covered by title, content,
// and field items. It does this by adjusting the variable sent to the
// template so that the template doesn't have to worry about it. See
// theme_rdf_template_variable_wrapper().
if (!empty($variables['rdf_template_variable_attributes_array'])) {
foreach ($variables['rdf_template_variable_attributes_array'] as $variable_name => $attributes) {
$context = array(
'hook' => $hook,
'variable_name' => $variable_name,
'variables' => $variables,
);
$variables[$variable_name] = theme('rdf_template_variable_wrapper', array('content' => $variables[$variable_name], 'attributes' => $attributes, 'context' => $context));
}
}
// Handles additional attributes about a template entity that for RDF parsing
// reasons, can't be placed into that template's $attributes variable. This
// is "meta" information that is related to particular content, so render it
// close to that content.
if (!empty($variables['rdf_metadata_attributes_array'])) {
if (!isset($variables['content']['#prefix'])) {
$variables['content']['#prefix'] = '';
}
$variables['content']['#prefix'] = theme('rdf_metadata', array('metadata' => $variables['rdf_metadata_attributes_array'])) . $variables['content']['#prefix'];
}
}
/**
* Implements MODULE_preprocess_HOOK().
*/
function rdf_preprocess_node(&$variables) {
// Adds RDFa markup to the node container. The about attribute specifies the
// URI of the resource described within the HTML element, while the @typeof
// attribute indicates its RDF type (e.g., foaf:Document, sioc:Person, and so
// on.)
$variables['attributes_array']['about'] = empty($variables['node_url']) ? NULL: $variables['node_url'];
$variables['attributes_array']['typeof'] = empty($variables['node']->rdf_mapping['rdftype']) ? NULL : $variables['node']->rdf_mapping['rdftype'];
// Adds RDFa markup about the title of the node to the title_suffix.
if (!empty($variables['node']->rdf_mapping['title']['predicates'])) {
$variables['title_suffix']['rdf_meta_title'] = array(
'#theme' => 'rdf_metadata',
'#metadata' => array(
array(
'property' => $variables['node']->rdf_mapping['title']['predicates'],
'content' => $variables['node']->title,
),
),
);
}
// Adds RDFa markup for the date.
if (!empty($variables['rdf_mapping']['created'])) {
$date_attributes_array = rdf_rdfa_attributes($variables['rdf_mapping']['created'], $variables['created']);
$variables['rdf_template_variable_attributes_array']['date'] = $date_attributes_array;
if ($variables['submitted']) {
$variables['rdf_template_variable_attributes_array']['submitted'] = $date_attributes_array;
}
}
// Adds RDFa markup for the relation between the node and its author.
if (!empty($variables['rdf_mapping']['uid'])) {
$variables['rdf_template_variable_attributes_array']['name']['rel'] = $variables['rdf_mapping']['uid']['predicates'];
if ($variables['submitted']) {
$variables['rdf_template_variable_attributes_array']['submitted']['rel'] = $variables['rdf_mapping']['uid']['predicates'];
}
}
// Adds RDFa markup annotating the number of comments a node has.
if (isset($variables['node']->comment_count) &&
!empty($variables['node']->rdf_mapping['comment_count']['predicates']) &&
user_access('access comments')) {
// Adds RDFa markup for the comment count near the node title as metadata.
$variables['title_suffix']['rdf_meta_comment_count'] = array(
'#theme' => 'rdf_metadata',
'#metadata' => array(
array(
'property' => $variables['node']->rdf_mapping['comment_count']['predicates'],
'content' => $variables['node']->comment_count,
'datatype' => $variables['node']->rdf_mapping['comment_count']['datatype'],
),
),
);
}
}
/**
* Implements MODULE_preprocess_HOOK().
*/
function rdf_preprocess_field(&$variables) {
$element = $variables['element'];
$mapping = rdf_mapping_load($element['#entity_type'], $element['#bundle']);
$field_name = $element['#field_name'];
if (!empty($mapping) && !empty($mapping[$field_name])) {
foreach ($element['#items'] as $delta => $item) {
$variables['item_attributes_array'][$delta] = rdf_rdfa_attributes($mapping[$field_name], $item);
// If this field is an image, RDFa will not output correctly when the
// image is in a containing tag. If the field is a file, RDFa will
// not output correctly if the filetype icon comes before the link to the
// file. We correct this by adding a resource attribute to the div if
// this field has a URI.
if (isset($item['uri'])) {
if (!empty($element[$delta]['#image_style'])) {
$variables['item_attributes_array'][$delta]['resource'] = image_style_url($element[$delta]['#image_style'], $item['uri']);
}
else {
$variables['item_attributes_array'][$delta]['resource'] = file_create_url($item['uri']);
}
}
}
}
}
/**
* Implements MODULE_preprocess_HOOK().
*/
function rdf_preprocess_user_profile(&$variables) {
$account = $variables['elements']['#account'];
$uri = entity_uri('user', $account);
// Adds RDFa markup to the user profile page. Fields displayed in this page
// will automatically describe the user.
if (!empty($account->rdf_mapping['rdftype'])) {
$variables['attributes_array']['typeof'] = $account->rdf_mapping['rdftype'];
$variables['attributes_array']['about'] = url($uri['path'], $uri['options']);
}
// Adds the relationship between the sioc:UserAccount and the foaf:Person who
// holds the account.
$account_holder_meta = array(
'#tag' => 'meta',
'#attributes' => array(
'about' => url($uri['path'], array_merge($uri['options'], array('fragment' => 'me'))),
'typeof' => array('foaf:Person'),
'rel' => array('foaf:account'),
'resource' => url($uri['path'], $uri['options']),
),
);
// Adds the markup for username.
$username_meta = array(
'#tag' => 'meta',
'#attributes' => array(
'about' => url($uri['path'], $uri['options']),
'property' => $account->rdf_mapping['name']['predicates'],
'content' => $account->name,
)
);
drupal_add_html_head($account_holder_meta, 'rdf_user_account_holder');
drupal_add_html_head($username_meta, 'rdf_user_username');
}
/**
* Implements MODULE_preprocess_HOOK().
*/
function rdf_preprocess_username(&$variables) {
// Because xml:lang is set on the HTML element that wraps the page, the
// username inherits this language attribute. However, since the username
// might not be transliterated to the same language that the content is in,
// we do not want it to inherit the language attribute, so we set the
// attribute to an empty string.
if (empty($variables['attributes_array']['xml:lang'])) {
$variables['attributes_array']['xml:lang'] = '';
}
// $variables['account'] is a pseudo account object, and as such, does not
// contain the RDF mappings for the user. In the case of nodes and comments,
// it contains the mappings for the node or comment object instead. However,
// while the RDF mappings are available from a full user_load(), this should
// be avoided for performance reasons. Since the type and bundle for users is
// already known, call rdf_mapping_load() directly.
$rdf_mapping = rdf_mapping_load('user', 'user');
// The profile URI is used to identify the user account. The about attribute
// is used to set the URI as the default subject of the predicates embedded
// as RDFa in the child elements. Even if the user profile is not accessible
// to the current user, we use its URI in order to identify the user in RDF.
// We do not use this attribute for the anonymous user because we do not have
// a user profile URI for it (only a homepage which cannot be used as user
// profile in RDF.)
if ($variables['uid'] > 0) {
$variables['attributes_array']['about'] = url('user/' . $variables['uid']);
}
$attributes = array();
// The typeof attribute specifies the RDF type(s) of this resource. They
// are defined in the 'rdftype' property of the user RDF mapping.
if (!empty($rdf_mapping['rdftype'])) {
$attributes['typeof'] = $rdf_mapping['rdftype'];
}
// Annotate the username in RDFa. A property attribute is used with an empty
// datatype attribute to ensure the username is parsed as a plain literal
// in RDFa 1.0 and 1.1.
if (!empty($rdf_mapping['name'])) {
$attributes['property'] = $rdf_mapping['name']['predicates'];
$attributes['datatype'] = '';
}
// Add the homepage RDFa markup if present.
if (!empty($variables['homepage']) && !empty($rdf_mapping['homepage'])) {
$attributes['rel'] = $rdf_mapping['homepage']['predicates'];
}
// The remaining attributes can have multiple values listed, with whitespace
// separating the values in the RDFa attributes
// (see http://www.w3.org/TR/rdfa-syntax/#rdfa-attributes).
// Therefore, merge rather than override so as not to clobber values set by
// earlier preprocess functions.
$variables['attributes_array'] = array_merge_recursive($variables['attributes_array'], $attributes);
}
/**
* Implements MODULE_preprocess_HOOK().
*/
function rdf_preprocess_comment(&$variables) {
$comment = $variables['comment'];
if (!empty($comment->rdf_mapping['rdftype'])) {
// Adds RDFa markup to the comment container. The about attribute specifies
// the URI of the resource described within the HTML element, while the
// typeof attribute indicates its RDF type (e.g., sioc:Post, foaf:Document,
// and so on.)
$uri = entity_uri('comment', $comment);
$variables['attributes_array']['about'] = url($uri['path'], $uri['options']);
$variables['attributes_array']['typeof'] = $comment->rdf_mapping['rdftype'];
}
// Adds RDFa markup for the date of the comment.
if (!empty($comment->rdf_mapping['created'])) {
// The comment date is precomputed as part of the rdf_data so that it can be
// cached as part of the entity.
$date_attributes_array = $comment->rdf_data['date'];
$variables['rdf_template_variable_attributes_array']['created'] = $date_attributes_array;
$variables['rdf_template_variable_attributes_array']['submitted'] = $date_attributes_array;
}
// Adds RDFa markup for the relation between the comment and its author.
if (!empty($comment->rdf_mapping['uid'])) {
$variables['rdf_template_variable_attributes_array']['author']['rel'] = $comment->rdf_mapping['uid']['predicates'];
$variables['rdf_template_variable_attributes_array']['submitted']['rel'] = $comment->rdf_mapping['uid']['predicates'];
}
if (!empty($comment->rdf_mapping['title'])) {
// Adds RDFa markup to the subject of the comment. Because the RDFa markup
// is added to an tag which might contain HTML code, we specify an
// empty datatype to ensure the value of the title read by the RDFa parsers
// is a literal.
$variables['title_attributes_array']['property'] = $comment->rdf_mapping['title']['predicates'];
$variables['title_attributes_array']['datatype'] = '';
}
// Annotates the parent relationship between the current comment and the node
// it belongs to. If available, the parent comment is also annotated.
if (!empty($comment->rdf_mapping['pid'])) {
// Adds the relation to the parent node.
$parent_node_attributes['rel'] = $comment->rdf_mapping['pid']['predicates'];
// The parent node URI is precomputed as part of the rdf_data so that it can
// be cached as part of the entity.
$parent_node_attributes['resource'] = $comment->rdf_data['nid_uri'];
$variables['rdf_metadata_attributes_array'][] = $parent_node_attributes;
// Adds the relation to parent comment, if it exists.
if ($comment->pid != 0) {
$parent_comment_attributes['rel'] = $comment->rdf_mapping['pid']['predicates'];
// The parent comment URI is precomputed as part of the rdf_data so that
// it can be cached as part of the entity.
$parent_comment_attributes['resource'] = $comment->rdf_data['pid_uri'];
$variables['rdf_metadata_attributes_array'][] = $parent_comment_attributes;
}
}
}
/**
* Implements MODULE_preprocess_HOOK().
*/
function rdf_preprocess_taxonomy_term(&$variables) {
// Adds the RDF type of the term and the term name in a tag. FALSE if the content
* might contain block level HTML elements and therefore cannot be validly
* wrapped by a tag. Modules implementing preprocess functions that
* set 'rdf_template_variable_attributes_array' for a particular template
* variable that might contain block level HTML must also implement
* hook_preprocess_rdf_template_variable_wrapper() and set 'inline' to FALSE
* for that context. Themes that render normally inline content with block
* level HTML must similarly implement
* hook_preprocess_rdf_template_variable_wrapper() and set 'inline'
* accordingly.
*
* @see rdf_process()
* @ingroup themeable
* @ingroup rdf
*/
function theme_rdf_template_variable_wrapper($variables) {
$output = $variables['content'];
if (!empty($output) && !empty($variables['attributes'])) {
$attributes = drupal_attributes($variables['attributes']);
$output = $variables['inline'] ? "$output " : "$output tags. These aren't visible and
* give machines extra information about the content and its structure.
*
* @param $variables
* An associative array containing:
* - metadata: An array of attribute arrays. Each item in the array
* corresponds to its own set of attributes, and therefore, needs its own
* element.
*
* @see rdf_process()
* @ingroup themeable
* @ingroup rdf
*/
function theme_rdf_metadata($variables) {
$output = '';
foreach ($variables['metadata'] as $attributes) {
// Add a class so that developers viewing the HTML source can see why there
// are empty tags in the document.
$attributes['class'][] = 'rdf-meta';
$attributes['class'][] = 'element-hidden';
// The XHTML+RDFa doctype allows either ';
}
return $output;
}
'RDF mapping hook',
'description' => 'Test hook_rdf_mapping().',
'group' => 'RDF',
);
}
function setUp() {
parent::setUp('rdf', 'rdf_test', 'field_test');
}
/**
* Test that hook_rdf_mapping() correctly returns and processes mapping.
*/
function testMapping() {
// Test that the mapping is returned correctly by the hook.
$mapping = rdf_mapping_load('test_entity', 'test_bundle');
$this->assertIdentical($mapping['rdftype'], array('sioc:Post'), 'Mapping for rdftype is sioc:Post.');
$this->assertIdentical($mapping['title'], array('predicates' => array('dc:title')), 'Mapping for title is dc:title.');
$this->assertIdentical($mapping['created'], array(
'predicates' => array('dc:created'),
'datatype' => 'xsd:dateTime',
'callback' => 'date_iso8601',
), t('Mapping for created is dc:created with datatype xsd:dateTime and callback date_iso8601.'));
$this->assertIdentical($mapping['uid'], array('predicates' => array('sioc:has_creator', 'dc:creator'), 'type' => 'rel'), 'Mapping for uid is sioc:has_creator and dc:creator, and type is rel.');
$mapping = rdf_mapping_load('test_entity', 'test_bundle_no_mapping');
$this->assertEqual($mapping, array(), 'Empty array returned when an entity type, bundle pair has no mapping.');
}
}
/**
* Test RDFa markup generation.
*/
class RdfRdfaMarkupTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'RDFa markup',
'description' => 'Test RDFa markup generation.',
'group' => 'RDF',
);
}
function setUp() {
parent::setUp('rdf', 'field_test', 'rdf_test');
}
/**
* Test rdf_rdfa_attributes().
*/
function testDrupalRdfaAttributes() {
// Same value as the one in the HTML tag (no callback function).
$expected_attributes = array(
'property' => array('dc:title'),
);
$mapping = rdf_mapping_load('test_entity', 'test_bundle');
$attributes = rdf_rdfa_attributes($mapping['title']);
ksort($expected_attributes);
ksort($attributes);
$this->assertEqual($expected_attributes, $attributes);
// Value different from the one in the HTML tag (callback function).
$date = 1252750327;
$isoDate = date('c', $date);
$expected_attributes = array(
'datatype' => 'xsd:dateTime',
'property' => array('dc:created'),
'content' => $isoDate,
);
$mapping = rdf_mapping_load('test_entity', 'test_bundle');
$attributes = rdf_rdfa_attributes($mapping['created'], $date);
ksort($expected_attributes);
ksort($attributes);
$this->assertEqual($expected_attributes, $attributes);
// Same value as the one in the HTML tag with datatype.
$expected_attributes = array(
'datatype' => 'foo:bar1type',
'property' => array('foo:bar1'),
);
$mapping = rdf_mapping_load('test_entity', 'test_bundle');
$attributes = rdf_rdfa_attributes($mapping['foobar1']);
ksort($expected_attributes);
ksort($attributes);
$this->assertEqual($expected_attributes, $attributes);
// ObjectProperty mapping (rel).
$expected_attributes = array(
'rel' => array('sioc:has_creator', 'dc:creator'),
);
$mapping = rdf_mapping_load('test_entity', 'test_bundle');
$attributes = rdf_rdfa_attributes($mapping['foobar_objproperty1']);
ksort($expected_attributes);
ksort($attributes);
$this->assertEqual($expected_attributes, $attributes);
// Inverse ObjectProperty mapping (rev).
$expected_attributes = array(
'rev' => array('sioc:reply_of'),
);
$mapping = rdf_mapping_load('test_entity', 'test_bundle');
$attributes = rdf_rdfa_attributes($mapping['foobar_objproperty2']);
ksort($expected_attributes);
ksort($attributes);
$this->assertEqual($expected_attributes, $attributes);
}
/**
* Ensure that file fields have the correct resource as the object in RDFa
* when displayed as a teaser.
*/
function testAttributesInMarkupFile() {
// Create a user to post the image.
$admin_user = $this->drupalCreateUser(array('edit own article content', 'revert revisions', 'administer content types'));
$this->drupalLogin($admin_user);
$langcode = LANGUAGE_NONE;
$bundle_name = "article";
$field_name = 'file_test';
$field = array(
'field_name' => $field_name,
'type' => 'file',
);
field_create_field($field);
$instance = array(
'field_name' => $field_name,
'entity_type' => 'node',
'bundle' => $bundle_name,
'display' => array(
'teaser' => array(
'type' => 'file_default',
),
),
);
field_create_instance($instance);
// Set the RDF mapping for the new field.
$rdf_mapping = rdf_mapping_load('node', $bundle_name);
$rdf_mapping += array($field_name => array('predicates' => array('rdfs:seeAlso'), 'type' => 'rel'));
$rdf_mapping_save = array('mapping' => $rdf_mapping, 'type' => 'node', 'bundle' => $bundle_name);
rdf_mapping_save($rdf_mapping_save);
// Get the test file that simpletest provides.
$file = current($this->drupalGetTestFiles('text'));
// Prepare image variables.
$image_field = "field_image";
// Get the test image that simpletest provides.
$image = current($this->drupalGetTestFiles('image'));
// Create an array for drupalPost with the field names as the keys and
// the URIs for the test files as the values.
$edit = array("files[" . $field_name . "_" . $langcode . "_0]" => drupal_realpath($file->uri),
"files[" . $image_field . "_" . $langcode . "_0]" => drupal_realpath($image->uri));
// Create node and save, then edit node to upload files.
$node = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1));
$this->drupalPost('node/' . $node->nid . '/edit', $edit, t('Save'));
// Get filenames and nid for comparison with HTML output.
$file_filename = $file->filename;
$image_filename = $image->filename;
$nid = $node->nid;
// Navigate to front page, where node is displayed in teaser form.
$this->drupalGet('node');
// We only check to make sure that the resource attribute contains '.txt'
// instead of the full file name because the filename is altered on upload.
$file_rel = $this->xpath('//div[contains(@about, :node-uri)]//div[contains(@rel, "rdfs:seeAlso") and contains(@resource, ".txt")]', array(
':node-uri' => 'node/' . $nid,
));
$this->assertTrue(!empty($file_rel), "Attribute 'rel' set on file field. Attribute 'resource' is also set.");
$image_rel = $this->xpath('//div[contains(@about, :node-uri)]//div[contains(@rel, "rdfs:seeAlso") and contains(@resource, :image)]//img[contains(@typeof, "foaf:Image")]', array(
':node-uri' => 'node/' . $nid,
':image' => $image_filename,
));
$this->assertTrue(!empty($image_rel), "Attribute 'rel' set on image field. Attribute 'resource' is also set.");
// Edits the node to add tags.
$tag1 = $this->randomName(8);
$tag2 = $this->randomName(8);
$edit = array();
$edit['field_tags[' . LANGUAGE_NONE . ']'] = "$tag1, $tag2";
$this->drupalPost('node/' . $node->nid . '/edit', $edit, t('Save'));
// Ensures the RDFa markup for the relationship between the node and its
// tags is correct.
$term_rdfa_meta = $this->xpath('//div[@about=:node-url and contains(@typeof, "sioc:Item") and contains(@typeof, "foaf:Document")]//ul[@class="links"]/li[@rel="dc:subject"]/a[@typeof="skos:Concept" and @datatype="" and text()=:term-name]', array(
':node-url' => url('node/' . $node->nid),
':term-name' => $tag1,
));
$this->assertTrue(!empty($term_rdfa_meta), 'Property dc:subject is present for the tag1 field item.');
$term_rdfa_meta = $this->xpath('//div[@about=:node-url and contains(@typeof, "sioc:Item") and contains(@typeof, "foaf:Document")]//ul[@class="links"]/li[@rel="dc:subject"]/a[@typeof="skos:Concept" and @datatype="" and text()=:term-name]', array(
':node-url' => url('node/' . $node->nid),
':term-name' => $tag2,
));
$this->assertTrue(!empty($term_rdfa_meta), 'Property dc:subject is present for the tag2 field item.');
}
}
class RdfCrudTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'RDF mapping CRUD functions',
'description' => 'Test the RDF mapping CRUD functions.',
'group' => 'RDF',
);
}
function setUp() {
parent::setUp('rdf', 'rdf_test');
}
/**
* Test inserting, loading, updating, and deleting RDF mappings.
*/
function testCRUD() {
// Verify loading of a default mapping.
$mapping = _rdf_mapping_load('test_entity', 'test_bundle');
$this->assertTrue(count($mapping), 'Default mapping was found.');
// Verify saving a mapping.
$mapping = array(
'type' => 'crud_test_entity',
'bundle' => 'crud_test_bundle',
'mapping' => array(
'rdftype' => array('sioc:Post'),
'title' => array(
'predicates' => array('dc:title'),
),
'uid' => array(
'predicates' => array('sioc:has_creator', 'dc:creator'),
'type' => 'rel',
),
),
);
$this->assertTrue(rdf_mapping_save($mapping) === SAVED_NEW, 'Mapping was saved.');
// Read the raw record from the {rdf_mapping} table.
$result = db_query('SELECT * FROM {rdf_mapping} WHERE type = :type AND bundle = :bundle', array(':type' => $mapping['type'], ':bundle' => $mapping['bundle']));
$stored_mapping = $result->fetchAssoc();
$stored_mapping['mapping'] = unserialize($stored_mapping['mapping']);
$this->assertEqual($mapping, $stored_mapping, 'Mapping was stored properly in the {rdf_mapping} table.');
// Verify loading of saved mapping.
$this->assertEqual($mapping['mapping'], _rdf_mapping_load($mapping['type'], $mapping['bundle']), 'Saved mapping loaded successfully.');
// Verify updating of mapping.
$mapping['mapping']['title'] = array(
'predicates' => array('dc2:bar2'),
);
$this->assertTrue(rdf_mapping_save($mapping) === SAVED_UPDATED, 'Mapping was updated.');
// Read the raw record from the {rdf_mapping} table.
$result = db_query('SELECT * FROM {rdf_mapping} WHERE type = :type AND bundle = :bundle', array(':type' => $mapping['type'], ':bundle' => $mapping['bundle']));
$stored_mapping = $result->fetchAssoc();
$stored_mapping['mapping'] = unserialize($stored_mapping['mapping']);
$this->assertEqual($mapping, $stored_mapping, 'Updated mapping was stored properly in the {rdf_mapping} table.');
// Verify loading of saved mapping.
$this->assertEqual($mapping['mapping'], _rdf_mapping_load($mapping['type'], $mapping['bundle']), 'Saved mapping loaded successfully.');
// Verify deleting of mapping.
$this->assertTrue(rdf_mapping_delete($mapping['type'], $mapping['bundle']), 'Mapping was deleted.');
$this->assertFalse(_rdf_mapping_load($mapping['type'], $mapping['bundle']), 'Deleted mapping is no longer found in the database.');
}
}
class RdfMappingDefinitionTestCase extends TaxonomyWebTestCase {
public static function getInfo() {
return array(
'name' => 'RDF mapping definition functionality',
'description' => 'Test the different types of RDF mappings and ensure the proper RDFa markup in included in nodes and user profile pages.',
'group' => 'RDF',
);
}
function setUp() {
parent::setUp('rdf', 'rdf_test', 'blog');
}
/**
* Create a node of type blog and test whether the RDF mapping defined for
* this node type in rdf_test.module is used in the node page.
*/
function testAttributesInMarkup1() {
$node = $this->drupalCreateNode(array('type' => 'blog'));
$isoDate = date('c', $node->changed);
$url = url('node/' . $node->nid);
$this->drupalGet('node/' . $node->nid);
// Ensure the default bundle mapping for node is used. These attributes come
// from the node default bundle definition.
$blog_title = $this->xpath("//div[@about='$url']/span[@property='dc:title' and @content='$node->title']");
$blog_meta = $this->xpath("//div[(@about='$url') and (@typeof='sioct:Weblog')]//span[contains(@property, 'dc:date') and contains(@property, 'dc:created') and @datatype='xsd:dateTime' and @content='$isoDate']");
$this->assertTrue(!empty($blog_title), 'Property dc:title is present in meta tag.');
$this->assertTrue(!empty($blog_meta), 'RDF type is present on post. Properties dc:date and dc:created are present on post date.');
}
/**
* Create a content type and a node of type test_bundle_hook_install and test
* whether the RDF mapping defined in rdf_test.install is used.
*/
function testAttributesInMarkup2() {
$type = $this->drupalCreateContentType(array('type' => 'test_bundle_hook_install'));
// Create node with single quotation mark title to ensure it does not get
// escaped more than once.
$node = $this->drupalCreateNode(array(
'type' => 'test_bundle_hook_install',
'title' => $this->randomName(8) . "'",
));
$isoDate = date('c', $node->changed);
$url = url('node/' . $node->nid);
$this->drupalGet('node/' . $node->nid);
// Ensure the mapping defined in rdf_module.test is used.
$test_bundle_title = $this->xpath("//div[@about='$url']/span[@property='dc:title' and @content=\"$node->title\"]");
$test_bundle_meta = $this->xpath("//div[(@about='$url') and contains(@typeof, 'foo:mapping_install1') and contains(@typeof, 'bar:mapping_install2')]//span[contains(@property, 'dc:date') and contains(@property, 'dc:created') and @datatype='xsd:dateTime' and @content='$isoDate']");
$this->assertTrue(!empty($test_bundle_title), 'Property dc:title is present in meta tag.');
$this->assertTrue(!empty($test_bundle_meta), 'RDF type is present on post. Properties dc:date and dc:created are present on post date.');
}
/**
* Create a random content type and node and ensure the default mapping for
* node is used.
*/
function testAttributesInMarkup3() {
$type = $this->drupalCreateContentType();
$node = $this->drupalCreateNode(array('type' => $type->type));
$isoDate = date('c', $node->changed);
$url = url('node/' . $node->nid);
$this->drupalGet('node/' . $node->nid);
// Ensure the default bundle mapping for node is used. These attributes come
// from the node default bundle definition.
$random_bundle_title = $this->xpath("//div[@about='$url']/span[@property='dc:title' and @content='$node->title']");
$random_bundle_meta = $this->xpath("//div[(@about='$url') and contains(@typeof, 'sioc:Item') and contains(@typeof, 'foaf:Document')]//span[contains(@property, 'dc:date') and contains(@property, 'dc:created') and @datatype='xsd:dateTime' and @content='$isoDate']");
$this->assertTrue(!empty($random_bundle_title), 'Property dc:title is present in meta tag.');
$this->assertTrue(!empty($random_bundle_meta), 'RDF type is present on post. Properties dc:date and dc:created are present on post date.');
}
/**
* Create a random user and ensure the default mapping for user is used.
*/
function testUserAttributesInMarkup() {
// Create two users, one with access to user profiles.
$user1 = $this->drupalCreateUser(array('access user profiles'));
$user2 = $this->drupalCreateUser();
$username = $user2->name;
$this->drupalLogin($user1);
// Browse to the user profile page.
$this->drupalGet('user/' . $user2->uid);
// Ensure the default bundle mapping for user is used on the user profile
// page. These attributes come from the user default bundle definition.
$account_uri = url('user/' . $user2->uid);
$person_uri = url('user/' . $user2->uid, array('fragment' => 'me'));
$user2_profile_about = $this->xpath('//div[@class="profile" and @typeof="sioc:UserAccount" and @about=:account-uri]', array(
':account-uri' => $account_uri,
));
$this->assertTrue(!empty($user2_profile_about), 'RDFa markup found on user profile page');
$user_account_holder = $this->xpath('//meta[contains(@typeof, "foaf:Person") and @about=:person-uri and @resource=:account-uri and contains(@rel, "foaf:account")]', array(
':person-uri' => $person_uri,
':account-uri' => $account_uri,
));
$this->assertTrue(!empty($user_account_holder), 'URI created for account holder and username set on sioc:UserAccount.');
$user_username = $this->xpath('//meta[@about=:account-uri and contains(@property, "foaf:name") and @content=:username]', array(
':account-uri' => $account_uri,
':username' => $username,
));
$this->assertTrue(!empty($user_username), 'foaf:name set on username.');
// User 2 creates node.
$this->drupalLogin($user2);
$node = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1));
$this->drupalLogin($user1);
$this->drupalGet('node/' . $node->nid);
// Ensures the default bundle mapping for user is used on the Authored By
// information on the node.
$author_about = $this->xpath('//a[@typeof="sioc:UserAccount" and @about=:account-uri and @property="foaf:name" and @datatype="" and contains(@xml:lang, "")]', array(
':account-uri' => $account_uri,
));
$this->assertTrue(!empty($author_about), 'RDFa markup found on author information on post. xml:lang on username is set to empty string.');
}
/**
* Creates a random term and ensures the right RDFa markup is used.
*/
function testTaxonomyTermRdfaAttributes() {
$vocabulary = $this->createVocabulary();
$term = $this->createTerm($vocabulary);
// Views the term and checks that the RDFa markup is correct.
$this->drupalGet('taxonomy/term/' . $term->tid);
$term_url = url('taxonomy/term/' . $term->tid);
$term_name = $term->name;
$term_rdfa_meta = $this->xpath('//meta[@typeof="skos:Concept" and @about=:term-url and contains(@property, "rdfs:label") and contains(@property, "skos:prefLabel") and @content=:term-name]', array(
':term-url' => $term_url,
':term-name' => $term_name,
));
$this->assertTrue(!empty($term_rdfa_meta), 'RDFa markup found on term page.');
}
}
class RdfCommentAttributesTestCase extends CommentHelperCase {
protected $node1;
protected $node2;
public static function getInfo() {
return array(
'name' => 'RDF comment mapping',
'description' => 'Tests the RDFa markup of comments.',
'group' => 'RDF',
);
}
public function setUp() {
parent::setUp('comment', 'rdf', 'rdf_test');
$this->admin_user = $this->drupalCreateUser(array('administer content types', 'administer comments', 'administer permissions', 'administer blocks'));
$this->web_user = $this->drupalCreateUser(array('access comments', 'post comments', 'create article content', 'access user profiles'));
// Enables anonymous user comments.
user_role_change_permissions(DRUPAL_ANONYMOUS_RID, array(
'access comments' => TRUE,
'post comments' => TRUE,
'skip comment approval' => TRUE,
));
// Allows anonymous to leave their contact information.
$this->setCommentAnonymous(COMMENT_ANONYMOUS_MAY_CONTACT);
$this->setCommentPreview(DRUPAL_OPTIONAL);
$this->setCommentForm(TRUE);
$this->setCommentSubject(TRUE);
$this->setCommentSettings('comment_default_mode', COMMENT_MODE_THREADED, 'Comment paging changed.');
// Creates the nodes on which the test comments will be posted.
$this->drupalLogin($this->web_user);
$this->node1 = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1));
$this->node2 = $this->drupalCreateNode(array('type' => 'article', 'promote' => 1));
$this->drupalLogout();
}
/**
* Tests the presence of the RDFa markup for the number of comments.
*/
public function testNumberOfCommentsRdfaMarkup() {
// Posts 2 comments as a registered user.
$this->drupalLogin($this->web_user);
$this->postComment($this->node1, $this->randomName(), $this->randomName());
$this->postComment($this->node1, $this->randomName(), $this->randomName());
// Tests number of comments in teaser view.
$this->drupalGet('node');
$node_url = url('node/' . $this->node1->nid);
$comment_count_teaser = $this->xpath('//div[@about=:node-url]/span[@property="sioc:num_replies" and @content="2" and @datatype="xsd:integer"]', array(':node-url' => $node_url));
$this->assertTrue(!empty($comment_count_teaser), 'RDFa markup for the number of comments found on teaser view.');
// Tests number of comments in full node view.
$this->drupalGet('node/' . $this->node1->nid);
$comment_count_teaser = $this->xpath('//div[@about=:node-url]/span[@property="sioc:num_replies" and @content="2" and @datatype="xsd:integer"]', array(':node-url' => $node_url));
$this->assertTrue(!empty($comment_count_teaser), 'RDFa markup for the number of comments found on full node view.');
}
/**
* Tests the presence of the RDFa markup for the title, date and author and
* homepage on registered users and anonymous comments.
*/
public function testCommentRdfaMarkup() {
// Posts comment #1 as a registered user.
$this->drupalLogin($this->web_user);
$comment1_subject = $this->randomName();
$comment1_body = $this->randomName();
$comment1 = $this->postComment($this->node1, $comment1_body, $comment1_subject);
// Tests comment #1 with access to the user profile.
$this->drupalGet('node/' . $this->node1->nid);
$this->_testBasicCommentRdfaMarkup($comment1);
// Tests comment #1 with no access to the user profile (as anonymous user).
$this->drupalLogout();
$this->drupalGet('node/' . $this->node1->nid);
$this->_testBasicCommentRdfaMarkup($comment1);
// Posts comment #2 as anonymous user.
$comment2_subject = $this->randomName();
$comment2_body = $this->randomName();
$anonymous_user = array();
$anonymous_user['name'] = $this->randomName();
$anonymous_user['mail'] = 'tester@simpletest.org';
$anonymous_user['homepage'] = 'http://example.org/';
$comment2 = $this->postComment($this->node2, $comment2_body, $comment2_subject, $anonymous_user);
$this->drupalGet('node/' . $this->node2->nid);
// Tests comment #2 as anonymous user.
$this->_testBasicCommentRdfaMarkup($comment2, $anonymous_user);
// Tests the RDFa markup for the homepage (specific to anonymous comments).
$comment_homepage = $this->xpath('//div[contains(@class, "comment") and contains(@typeof, "sioct:Comment")]//span[@rel="sioc:has_creator"]/a[contains(@class, "username") and @typeof="sioc:UserAccount" and @property="foaf:name" and @datatype="" and @href="http://example.org/" and contains(@rel, "foaf:page")]');
$this->assertTrue(!empty($comment_homepage), 'RDFa markup for the homepage of anonymous user found.');
// There should be no about attribute on anonymous comments.
$comment_homepage = $this->xpath('//div[contains(@class, "comment") and contains(@typeof, "sioct:Comment")]//span[@rel="sioc:has_creator"]/a[@about]');
$this->assertTrue(empty($comment_homepage), 'No about attribute is present on anonymous user comment.');
// Tests comment #2 as logged in user.
$this->drupalLogin($this->web_user);
$this->drupalGet('node/' . $this->node2->nid);
$this->_testBasicCommentRdfaMarkup($comment2, $anonymous_user);
// Tests the RDFa markup for the homepage (specific to anonymous comments).
$comment_homepage = $this->xpath('//div[contains(@class, "comment") and contains(@typeof, "sioct:Comment")]//span[@rel="sioc:has_creator"]/a[contains(@class, "username") and @typeof="sioc:UserAccount" and @property="foaf:name" and @datatype="" and @href="http://example.org/" and contains(@rel, "foaf:page")]');
$this->assertTrue(!empty($comment_homepage), "RDFa markup for the homepage of anonymous user found.");
// There should be no about attribute on anonymous comments.
$comment_homepage = $this->xpath('//div[contains(@class, "comment") and contains(@typeof, "sioct:Comment")]//span[@rel="sioc:has_creator"]/a[@about]');
$this->assertTrue(empty($comment_homepage), "No about attribute is present on anonymous user comment.");
}
/**
* Test RDF comment replies.
*/
public function testCommentReplyOfRdfaMarkup() {
// Posts comment #1 as a registered user.
$this->drupalLogin($this->web_user);
$comments[] = $this->postComment($this->node1, $this->randomName(), $this->randomName());
// Tests the reply_of relationship of a first level comment.
$result = $this->xpath("(id('comments')//div[contains(@class,'comment ')])[position()=1]//span[@rel='sioc:reply_of' and @resource=:node]", array(':node' => url("node/{$this->node1->nid}")));
$this->assertEqual(1, count($result), 'RDFa markup referring to the node is present.');
$result = $this->xpath("(id('comments')//div[contains(@class,'comment ')])[position()=1]//span[@rel='sioc:reply_of' and @resource=:comment]", array(':comment' => url('comment/1#comment-1')));
$this->assertFalse($result, 'No RDFa markup referring to the comment itself is present.');
// Posts a reply to the first comment.
$this->drupalGet('comment/reply/' . $this->node1->nid . '/' . $comments[0]->id);
$comments[] = $this->postComment(NULL, $this->randomName(), $this->randomName(), TRUE);
// Tests the reply_of relationship of a second level comment.
$result = $this->xpath("(id('comments')//div[contains(@class,'comment ')])[position()=2]//span[@rel='sioc:reply_of' and @resource=:node]", array(':node' => url("node/{$this->node1->nid}")));
$this->assertEqual(1, count($result), 'RDFa markup referring to the node is present.');
$result = $this->xpath("(id('comments')//div[contains(@class,'comment ')])[position()=2]//span[@rel='sioc:reply_of' and @resource=:comment]", array(':comment' => url('comment/1', array('fragment' => 'comment-1'))));
$this->assertEqual(1, count($result), 'RDFa markup referring to the parent comment is present.');
$comments = $this->xpath("(id('comments')//div[contains(@class,'comment ')])[position()=2]");
}
/**
* Helper function for testCommentRdfaMarkup().
*
* Tests the current page for basic comment RDFa markup.
*
* @param $comment
* Comment object.
* @param $account
* An array containing information about an anonymous user.
*/
function _testBasicCommentRdfaMarkup($comment, $account = array()) {
$comment_container = $this->xpath('//div[contains(@class, "comment") and contains(@typeof, "sioct:Comment")]');
$this->assertTrue(!empty($comment_container), "Comment RDF type for comment found.");
$comment_title = $this->xpath('//div[contains(@class, "comment") and contains(@typeof, "sioct:Comment")]//h3[@property="dc:title"]');
$this->assertEqual((string)$comment_title[0]->a, $comment->subject, "RDFa markup for the comment title found.");
$comment_date = $this->xpath('//div[contains(@class, "comment") and contains(@typeof, "sioct:Comment")]//*[contains(@property, "dc:date") and contains(@property, "dc:created")]');
$this->assertTrue(!empty($comment_date), "RDFa markup for the date of the comment found.");
// The author tag can be either a or span
$comment_author = $this->xpath('//div[contains(@class, "comment") and contains(@typeof, "sioct:Comment")]//span[@rel="sioc:has_creator"]/*[contains(@class, "username") and @typeof="sioc:UserAccount" and @property="foaf:name" and @datatype=""]');
$name = empty($account["name"]) ? $this->web_user->name : $account["name"] . " (not verified)";
$this->assertEqual((string)$comment_author[0], $name, "RDFa markup for the comment author found.");
$comment_body = $this->xpath('//div[contains(@class, "comment") and contains(@typeof, "sioct:Comment")]//div[@class="content"]//div[contains(@class, "comment-body")]//div[@property="content:encoded"]');
$this->assertEqual((string)$comment_body[0]->p, $comment->comment, "RDFa markup for the comment body found.");
}
}
class RdfTrackerAttributesTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'RDF tracker page mapping',
'description' => 'Test the mapping for the tracker page and ensure the proper RDFa markup in included.',
'group' => 'RDF',
);
}
function setUp() {
parent::setUp('rdf', 'rdf_test', 'tracker');
// Enable anonymous posting of content.
user_role_change_permissions(DRUPAL_ANONYMOUS_RID, array(
'create article content' => TRUE,
'access comments' => TRUE,
'post comments' => TRUE,
'skip comment approval' => TRUE,
));
}
/**
* Create nodes as both admin and anonymous user and test for correct RDFa
* markup on the tracker page for those nodes and their comments.
*/
function testAttributesInTracker() {
// Create node as anonymous user.
$node_anon = $this->drupalCreateNode(array('type' => 'article', 'uid' => 0));
// Create node as admin user.
$node_admin = $this->drupalCreateNode(array('type' => 'article', 'uid' => 1));
// Pass both the anonymously posted node and the administrator posted node
// through to test for the RDF attributes.
$this->_testBasicTrackerRdfaMarkup($node_anon);
$this->_testBasicTrackerRdfaMarkup($node_admin);
}
/**
* Helper function for testAttributesInTracker().
*
* Tests the tracker page for RDFa markup.
*
* @param $node
* The node just created.
*/
function _testBasicTrackerRdfaMarkup($node) {
$url = url('node/' . $node->nid);
$user = ($node->uid == 0) ? 'Anonymous user' : 'Registered user';
// Navigate to tracker page.
$this->drupalGet('tracker');
// Tests whether the about property is applied. This is implicit in the
// success of the following tests, but making it explicit will make
// debugging easier in case of failure.
$tracker_about = $this->xpath('//tr[@about=:url]', array(':url' => $url));
$this->assertTrue(!empty($tracker_about), format_string('About attribute found on table row for @user content.', array('@user'=> $user)));
// Tests whether the title has the correct property attribute.
$tracker_title = $this->xpath('//tr[@about=:url]/td[@property="dc:title" and @datatype=""]', array(':url' => $url));
$this->assertTrue(!empty($tracker_title), format_string('Title property attribute found on @user content.', array('@user'=> $user)));
// Tests whether the relationship between the content and user has been set.
$tracker_user = $this->xpath('//tr[@about=:url]//td[contains(@rel, "sioc:has_creator")]//*[contains(@typeof, "sioc:UserAccount") and contains(@property, "foaf:name")]', array(':url' => $url));
$this->assertTrue(!empty($tracker_user), format_string('Typeof and name property attributes found on @user.', array('@user'=> $user)));
// There should be an about attribute on logged in users and no about
// attribute for anonymous users.
$tracker_user = $this->xpath('//tr[@about=:url]//td[@rel="sioc:has_creator"]/*[@about]', array(':url' => $url));
if ($node->uid == 0) {
$this->assertTrue(empty($tracker_user), format_string('No about attribute is present on @user.', array('@user'=> $user)));
}
elseif ($node->uid > 0) {
$this->assertTrue(!empty($tracker_user), format_string('About attribute is present on @user.', array('@user'=> $user)));
}
// Tests whether the property has been set for number of comments.
$tracker_replies = $this->xpath('//tr[@about=:url]//td[contains(@property, "sioc:num_replies") and contains(@content, "0") and @datatype="xsd:integer"]', array(':url' => $url));
$this->assertTrue($tracker_replies, format_string('Num replies property and content attributes found on @user content.', array('@user'=> $user)));
// Tests that the appropriate RDFa markup to annotate the latest activity
// date has been added to the tracker output before comments have been
// posted, meaning the latest activity reflects changes to the node itself.
$isoDate = date('c', $node->changed);
$tracker_activity = $this->xpath('//tr[@about=:url]//td[contains(@property, "dc:modified") and contains(@property, "sioc:last_activity_date") and contains(@datatype, "xsd:dateTime") and @content=:date]', array(':url' => $url, ':date' => $isoDate));
$this->assertTrue(!empty($tracker_activity), format_string('Latest activity date and changed properties found when there are no comments on @user content. Latest activity date content is correct.', array('@user'=> $user)));
// Tests that the appropriate RDFa markup to annotate the latest activity
// date has been added to the tracker output after a comment is posted.
$comment = array(
'subject' => $this->randomName(),
'comment_body[' . LANGUAGE_NONE . '][0][value]' => $this->randomName(),
);
$this->drupalPost('comment/reply/' . $node->nid, $comment, t('Save'));
$this->drupalGet('tracker');
// Tests whether the property has been set for number of comments.
$tracker_replies = $this->xpath('//tr[@about=:url]//td[contains(@property, "sioc:num_replies") and contains(@content, "1") and @datatype="xsd:integer"]', array(':url' => $url));
$this->assertTrue($tracker_replies, format_string('Num replies property and content attributes found on @user content.', array('@user'=> $user)));
// Need to query database directly to obtain last_activity_date because
// it cannot be accessed via node_load().
$result = db_query('SELECT t.changed FROM {tracker_node} t WHERE t.nid = (:nid)', array(':nid' => $node->nid));
foreach ($result as $node) {
$expected_last_activity_date = $node->changed;
}
$isoDate = date('c', $expected_last_activity_date);
$tracker_activity = $this->xpath('//tr[@about=:url]//td[@property="sioc:last_activity_date" and @datatype="xsd:dateTime" and @content=:date]', array(':url' => $url, ':date' => $isoDate));
$this->assertTrue(!empty($tracker_activity), format_string('Latest activity date found when there are comments on @user content. Latest activity date content is correct.', array('@user'=> $user)));
}
}
/**
* Tests for RDF namespaces declaration with hook_rdf_namespaces().
*/
class RdfGetRdfNamespacesTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'RDF namespaces',
'description' => 'Test hook_rdf_namespaces() and ensure only "safe" namespaces are returned.',
'group' => 'RDF',
);
}
function setUp() {
parent::setUp('rdf', 'rdf_test');
}
/**
* Test getting RDF namesapces.
*/
function testGetRdfNamespaces() {
// Get all RDF namespaces.
$ns = rdf_get_namespaces();
$this->assertEqual($ns['rdfs'], 'http://www.w3.org/2000/01/rdf-schema#', 'A prefix declared once is included.');
$this->assertEqual($ns['foaf'], 'http://xmlns.com/foaf/0.1/', 'The same prefix declared in several implementations of hook_rdf_namespaces() is valid as long as all the namespaces are the same.');
$this->assertEqual($ns['foaf1'], 'http://xmlns.com/foaf/0.1/', 'Two prefixes can be assigned the same namespace.');
$this->assertTrue(!isset($ns['dc']), 'A prefix with conflicting namespaces is discarded.');
}
}
name = "RDF module tests"
description = "Support module for RDF module testing."
package = Testing
version = VERSION
core = 7.x
hidden = TRUE
dependencies[] = blog
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
'node',
'bundle' => 'test_bundle_hook_install',
'mapping' => array(
'rdftype' => array('foo:mapping_install1', 'bar:mapping_install2'),
),
),
);
foreach ($rdf_mappings as $rdf_mapping) {
rdf_mapping_save($rdf_mapping);
}
}
'test_entity',
'bundle' => 'test_bundle',
'mapping' => array(
'rdftype' => array('sioc:Post'),
'title' => array(
'predicates' => array('dc:title'),
),
'created' => array(
'predicates' => array('dc:created'),
'datatype' => 'xsd:dateTime',
'callback' => 'date_iso8601',
),
'uid' => array(
'predicates' => array('sioc:has_creator', 'dc:creator'),
'type' => 'rel',
),
'foobar' => array(
'predicates' => array('foo:bar'),
),
'foobar1' => array(
'datatype' => 'foo:bar1type',
'predicates' => array('foo:bar1'),
),
'foobar_objproperty1' => array(
'predicates' => array('sioc:has_creator', 'dc:creator'),
'type' => 'rel',
),
'foobar_objproperty2' => array(
'predicates' => array('sioc:reply_of'),
'type' => 'rev',
),
),
),
array(
'type' => 'node',
'bundle' => 'blog',
'mapping' => array(
'rdftype' => array('sioct:Weblog'),
),
),
);
}
/**
* Implements hook_rdf_namespaces().
*/
function rdf_test_rdf_namespaces() {
return array(
'dc' => 'http://purl.org/conflicting/namespace',
'foaf' => 'http://xmlns.com/foaf/0.1/',
'foaf1' => 'http://xmlns.com/foaf/0.1/',
);
}
*
*
* @endcode
*
* @see template_preprocess_search_block_form()
*/
?>
subject)): ?>
>
>
' . t('%percentage of the site has been indexed.', array('%percentage' => $percentage)) . ' ' . $count . '
';
$form['status'] = array('#type' => 'fieldset', '#title' => t('Indexing status'));
$form['status']['status'] = array('#markup' => $status);
$form['status']['wipe'] = array('#type' => 'submit', '#value' => t('Re-index site'), '#submit' => array('search_admin_reindex_submit'));
$items = drupal_map_assoc(array(10, 20, 50, 100, 200, 500));
// Indexing throttle:
$form['indexing_throttle'] = array(
'#type' => 'fieldset',
'#title' => t('Indexing throttle')
);
$form['indexing_throttle']['search_cron_limit'] = array(
'#type' => 'select',
'#title' => t('Number of items to index per cron run'),
'#default_value' => variable_get('search_cron_limit', 100),
'#options' => $items,
'#description' => t('The maximum number of items indexed in each pass of a cron maintenance task . If necessary, reduce the number of items to prevent timeouts and memory errors while indexing.', array('@cron' => url('admin/reports/status')))
);
// Indexing settings:
$form['indexing_settings'] = array(
'#type' => 'fieldset',
'#title' => t('Indexing settings')
);
$form['indexing_settings']['info'] = array(
'#markup' => t('Changing the settings below will cause the site index to be rebuilt. The search index is not cleared but systematically updated to reflect the new settings. Searching will continue to work but new content won\'t be indexed until all existing content has been re-indexed.
The default settings should be appropriate for the majority of sites.
')
);
$form['indexing_settings']['minimum_word_size'] = array(
'#type' => 'textfield',
'#title' => t('Minimum word length to index'),
'#default_value' => variable_get('minimum_word_size', 3),
'#size' => 5,
'#maxlength' => 3,
'#description' => t('The number of characters a word has to be to be indexed. A lower setting means better search result ranking, but also a larger database. Each search query must contain at least one keyword that is this size (or longer).'),
'#element_validate' => array('element_validate_integer_positive'),
);
$form['indexing_settings']['overlap_cjk'] = array(
'#type' => 'checkbox',
'#title' => t('Simple CJK handling'),
'#default_value' => variable_get('overlap_cjk', TRUE),
'#description' => t('Whether to apply a simple Chinese/Japanese/Korean tokenizer based on overlapping sequences. Turn this off if you want to use an external preprocessor for this instead. Does not affect other languages.')
);
$form['active'] = array(
'#type' => 'fieldset',
'#title' => t('Active search modules')
);
$module_options = _search_get_module_names();
$form['active']['search_active_modules'] = array(
'#type' => 'checkboxes',
'#title' => t('Active modules'),
'#title_display' => 'invisible',
'#default_value' => variable_get('search_active_modules', array('node', 'user')),
'#options' => $module_options,
'#description' => t('Choose which search modules are active from the available modules.')
);
$form['active']['search_default_module'] = array(
'#title' => t('Default search module'),
'#type' => 'radios',
'#default_value' => variable_get('search_default_module', 'node'),
'#options' => $module_options,
'#description' => t('Choose which search module is the default.')
);
$form['logging'] = array(
'#type' => 'fieldset',
'#title' => t('Logging')
);
$form['logging']['search_logging'] = array(
'#type' => 'checkbox',
'#title' => t('Log searches'),
'#default_value' => variable_get('search_logging', 1),
'#description' => t('If checked, all searches will be logged. Uncheck to skip logging. Logging may affect performance.'),
);
$form['#validate'][] = 'search_admin_settings_validate';
$form['#submit'][] = 'search_admin_settings_submit';
// Per module settings
foreach (variable_get('search_active_modules', array('node', 'user')) as $module) {
$added_form = module_invoke($module, 'search_admin');
if (is_array($added_form)) {
$form = array_merge($form, $added_form);
}
}
return system_settings_form($form);
}
/**
* Form validation handler for search_admin_settings().
*/
function search_admin_settings_validate($form, &$form_state) {
// Check whether we selected a valid default.
if ($form_state['triggering_element']['#value'] != t('Reset to defaults')) {
$new_modules = array_filter($form_state['values']['search_active_modules']);
$default = $form_state['values']['search_default_module'];
if (!in_array($default, $new_modules, TRUE)) {
form_set_error('search_default_module', t('Your default search module is not selected as an active module.'));
}
}
}
/**
* Form submission handler for search_admin_settings().
*/
function search_admin_settings_submit($form, &$form_state) {
// If these settings change, the index needs to be rebuilt.
if ((variable_get('minimum_word_size', 3) != $form_state['values']['minimum_word_size']) ||
(variable_get('overlap_cjk', TRUE) != $form_state['values']['overlap_cjk'])) {
drupal_set_message(t('The index will be rebuilt.'));
search_reindex();
}
$current_modules = variable_get('search_active_modules', array('node', 'user'));
// Check whether we are resetting the values.
if ($form_state['triggering_element']['#value'] == t('Reset to defaults')) {
$new_modules = array('node', 'user');
}
else {
$new_modules = array_filter($form_state['values']['search_active_modules']);
}
if (array_diff($current_modules, $new_modules)) {
drupal_set_message(t('The active search modules have been changed.'));
variable_set('menu_rebuild_needed', TRUE);
}
}
/**
* Form submission handler for reindex button on search_admin_settings_form().
*/
function search_admin_reindex_submit($form, &$form_state) {
// send the user to the confirmation page
$form_state['redirect'] = 'admin/config/search/settings/reindex';
}
'Content',
'path' => 'node',
'conditions_callback' => 'callback_search_conditions',
);
}
/**
* Define access to a custom search routine.
*
* This hook allows a module to define permissions for a search tab.
*
* @ingroup search
*/
function hook_search_access() {
return user_access('access content');
}
/**
* Take action when the search index is going to be rebuilt.
*
* Modules that use hook_update_index() should update their indexing
* bookkeeping so that it starts from scratch the next time
* hook_update_index() is called.
*
* @ingroup search
*/
function hook_search_reset() {
db_update('search_dataset')
->fields(array('reindex' => REQUEST_TIME))
->condition('type', 'node')
->execute();
}
/**
* Report the status of indexing.
*
* The core search module only invokes this hook on active modules.
* Implementing modules do not need to check whether they are active when
* calculating their return values.
*
* @return
* An associative array with the key-value pairs:
* - 'remaining': The number of items left to index.
* - 'total': The total number of items to index.
*
* @ingroup search
*/
function hook_search_status() {
$total = db_query('SELECT COUNT(*) FROM {node} WHERE status = 1')->fetchField();
$remaining = db_query("SELECT COUNT(*) FROM {node} n LEFT JOIN {search_dataset} d ON d.type = 'node' AND d.sid = n.nid WHERE n.status = 1 AND d.sid IS NULL OR d.reindex <> 0")->fetchField();
return array('remaining' => $remaining, 'total' => $total);
}
/**
* Add elements to the search settings form.
*
* @return
* Form array for the Search settings page at admin/config/search/settings.
*
* @ingroup search
*/
function hook_search_admin() {
// Output form for defining rank factor weights.
$form['content_ranking'] = array(
'#type' => 'fieldset',
'#title' => t('Content ranking'),
);
$form['content_ranking']['#theme'] = 'node_search_admin';
$form['content_ranking']['info'] = array(
'#value' => '' . t('The following numbers control which properties the content search should favor when ordering the results. Higher numbers mean more influence, zero means the property is ignored. Changing these numbers does not require the search index to be rebuilt. Changes take effect immediately.') . ' '
);
// Note: reversed to reflect that higher number = higher ranking.
$options = drupal_map_assoc(range(0, 10));
foreach (module_invoke_all('ranking') as $var => $values) {
$form['content_ranking']['factors']['node_rank_' . $var] = array(
'#title' => $values['title'],
'#type' => 'select',
'#options' => $options,
'#default_value' => variable_get('node_rank_' . $var, 0),
);
}
return $form;
}
/**
* Execute a search for a set of key words.
*
* Use database API with the 'PagerDefault' query extension to perform your
* search.
*
* If your module uses hook_update_index() and search_index() to index its
* items, use table 'search_index' aliased to 'i' as the main table in your
* query, with the 'SearchQuery' extension. You can join to your module's table
* using the 'i.sid' field, which will contain the $sid values you provided to
* search_index(). Add the main keywords to the query by using method
* searchExpression(). The functions search_expression_extract() and
* search_expression_insert() may also be helpful for adding custom search
* parameters to the search expression.
*
* See node_search_execute() for an example of a module that uses the search
* index, and user_search_execute() for an example that doesn't use the search
* index.
*
* @param $keys
* The search keywords as entered by the user.
* @param $conditions
* An optional array of additional conditions, such as filters.
*
* @return
* An array of search results. To use the default search result
* display, each item should have the following keys':
* - 'link': Required. The URL of the found item.
* - 'type': The type of item (such as the content type).
* - 'title': Required. The name of the item.
* - 'user': The author of the item.
* - 'date': A timestamp when the item was last modified.
* - 'extra': An array of optional extra information items.
* - 'snippet': An excerpt or preview to show with the result (can be
* generated with search_excerpt()).
* - 'language': Language code for the item (usually two characters).
*
* @ingroup search
*/
function hook_search_execute($keys = NULL, $conditions = NULL) {
// Build matching conditions
$query = db_select('search_index', 'i', array('target' => 'slave'))->extend('SearchQuery')->extend('PagerDefault');
$query->join('node', 'n', 'n.nid = i.sid');
$query
->condition('n.status', 1)
->addTag('node_access')
->searchExpression($keys, 'node');
// Insert special keywords.
$query->setOption('type', 'n.type');
$query->setOption('language', 'n.language');
if ($query->setOption('term', 'ti.tid')) {
$query->join('taxonomy_index', 'ti', 'n.nid = ti.nid');
}
// Only continue if the first pass query matches.
if (!$query->executeFirstPass()) {
return array();
}
// Add the ranking expressions.
_node_rankings($query);
// Load results.
$find = $query
->limit(10)
->execute();
$results = array();
foreach ($find as $item) {
// Build the node body.
$node = node_load($item->sid);
node_build_content($node, 'search_result');
$node->body = drupal_render($node->content);
// Fetch comments for snippet.
$node->rendered .= ' ' . module_invoke('comment', 'node_update_index', $node);
// Fetch terms for snippet.
$node->rendered .= ' ' . module_invoke('taxonomy', 'node_update_index', $node);
$extra = module_invoke_all('node_search_result', $node);
$results[] = array(
'link' => url('node/' . $item->sid, array('absolute' => TRUE)),
'type' => check_plain(node_type_get_name($node)),
'title' => $node->title,
'user' => theme('username', array('account' => $node)),
'date' => $node->changed,
'node' => $node,
'extra' => $extra,
'score' => $item->calculated_score,
'snippet' => search_excerpt($keys, $node->body),
);
}
return $results;
}
/**
* Override the rendering of search results.
*
* A module that implements hook_search_info() to define a type of search may
* implement this hook in order to override the default theming of its search
* results, which is otherwise themed using theme('search_results').
*
* Note that by default, theme('search_results') and theme('search_result')
* work together to create an ordered list (OL). So your hook_search_page()
* implementation should probably do this as well.
*
* @param $results
* An array of search results.
*
* @return
* A renderable array, which will render the formatted search results with a
* pager included.
*
* @see search-result.tpl.php
* @see search-results.tpl.php
*/
function hook_search_page($results) {
$output['prefix']['#markup'] = '';
foreach ($results as $entry) {
$output[] = array(
'#theme' => 'search_result',
'#result' => $entry,
'#module' => 'my_module_name',
);
}
$output['suffix']['#markup'] = ' ' . theme('pager');
return $output;
}
/**
* Preprocess text for search.
*
* This hook is called to preprocess both the text added to the search index and
* the keywords users have submitted for searching.
*
* Possible uses:
* - Adding spaces between words of Chinese or Japanese text.
* - Stemming words down to their root words to allow matches between, for
* instance, walk, walked, walking, and walks in searching.
* - Expanding abbreviations and acronymns that occur in text.
*
* @param $text
* The text to preprocess. This is a single piece of plain text extracted
* from between two HTML tags or from the search query. It will not contain
* any HTML entities or HTML tags.
*
* @return
* The text after preprocessing. Note that if your module decides not to alter
* the text, it should return the original text. Also, after preprocessing,
* words in the text should be separated by a space.
*
* @ingroup search
*/
function hook_search_preprocess($text) {
// Do processing on $text
return $text;
}
/**
* Update the search index for this module.
*
* This hook is called every cron run if search.module is enabled, your
* module has implemented hook_search_info(), and your module has been set as
* an active search module on the Search settings page
* (admin/config/search/settings). It allows your module to add items to the
* built-in search index using search_index(), or to add them to your module's
* own indexing mechanism.
*
* When implementing this hook, your module should index content items that
* were modified or added since the last run. PHP has a time limit
* for cron, though, so it is advisable to limit how many items you index
* per run using variable_get('search_cron_limit') (see example below). Also,
* since the cron run could time out and abort in the middle of your run, you
* should update your module's internal bookkeeping on when items have last
* been indexed as you go rather than waiting to the end of indexing.
*
* @ingroup search
*/
function hook_update_index() {
$limit = (int)variable_get('search_cron_limit', 100);
$result = db_query_range("SELECT n.nid FROM {node} n LEFT JOIN {search_dataset} d ON d.type = 'node' AND d.sid = n.nid WHERE d.sid IS NULL OR d.reindex <> 0 ORDER BY d.reindex ASC, n.nid ASC", 0, $limit);
foreach ($result as $node) {
$node = node_load($node->nid);
// Save the changed time of the most recent indexed node, for the search
// results half-life calculation.
variable_set('node_cron_last', $node->changed);
// Render the node.
node_build_content($node, 'search_index');
$node->rendered = drupal_render($node->content);
$text = '' . check_plain($node->title) . ' ' . $node->rendered;
// Fetch extra data normally not visible
$extra = module_invoke_all('node_update_index', $node);
foreach ($extra as $t) {
$text .= $t;
}
// Update index
search_index($node->nid, 'node', $text);
}
}
/**
* @} End of "addtogroup hooks".
*/
/**
* Provide search query conditions.
*
* Callback for hook_search_info().
*
* This callback is invoked by search_view() to get an array of additional
* search conditions to pass to search_data(). For example, a search module
* may get additional keywords, filters, or modifiers for the search from
* the query string.
*
* This example pulls additional search keywords out of the $_REQUEST variable,
* (i.e. from the query string of the request). The conditions may also be
* generated internally - for example based on a module's settings.
*
* @param $keys
* The search keywords string.
*
* @return
* An array of additional conditions, such as filters.
*
* @ingroup callbacks
* @ingroup search
*/
function callback_search_conditions($keys) {
$conditions = array();
if (!empty($_REQUEST['keys'])) {
$conditions['keys'] = $_REQUEST['keys'];
}
if (!empty($_REQUEST['sample_search_keys'])) {
$conditions['sample_search_keys'] = $_REQUEST['sample_search_keys'];
}
if ($force_keys = config('sample_search.settings')->get('force_keywords')) {
$conditions['sample_search_force_keywords'] = $force_keys;
}
return $conditions;
}
.search-form {
margin-bottom: 1em;
}
.search-form input {
margin-top: 0;
margin-bottom: 0;
}
.search-results {
list-style: none;
}
.search-results p {
margin-top: 0;
}
.search-results .title {
font-size: 1.2em;
}
.search-results li {
margin-bottom: 1em;
}
.search-results .search-snippet-info {
padding-left: 1em; /* LTR */
}
.search-results .search-info {
font-size: 0.85em;
}
.search-advanced .criterion {
float: left; /* LTR */
margin-right: 2em; /* LTR */
}
.search-advanced .action {
float: left; /* LTR */
clear: left; /* LTR */
}
array(), 'negative' => array());
/**
* Indicates whether the first pass query requires complex conditions (LIKE).
*
* @var boolean.
*/
protected $simple = TRUE;
/**
* Conditions that are used for exact searches.
*
* This is always used for the second pass query but not for the first pass,
* unless $this->simple is FALSE.
*
* @var DatabaseCondition
*/
protected $conditions;
/**
* Indicates how many matches for a search query are necessary.
*
* @var int
*/
protected $matches = 0;
/**
* Array of search words.
*
* These words have to match against {search_index}.word.
*
* @var array
*/
protected $words = array();
/**
* Multiplier for the normalized search score.
*
* This value is calculated by the first pass query and multiplied with the
* actual score of a specific word to make sure that the resulting calculated
* score is between 0 and 1.
*
* @var float
*/
protected $normalize;
/**
* Indicates whether the first pass query has been executed.
*
* @var boolean
*/
protected $executedFirstPass = FALSE;
/**
* Stores score expressions.
*
* @var array
*
* @see addScore()
*/
protected $scores = array();
/**
* Stores arguments for score expressions.
*
* @var array
*/
protected $scoresArguments = array();
/**
* Stores multipliers for score expressions.
*
* @var array
*/
protected $multiply = array();
/**
* Whether or not search expressions were ignored.
*
* The maximum number of AND/OR combinations exceeded can be configured to
* avoid Denial-of-Service attacks. Expressions beyond the limit are ignored.
*
* @var boolean
*/
protected $expressionsIgnored = FALSE;
/**
* Sets up the search query expression.
*
* @param $query
* A search query string, which can contain options.
* @param $module
* The search module. This maps to {search_index}.type in the database.
*
* @return
* The SearchQuery object.
*/
public function searchExpression($expression, $module) {
$this->searchExpression = $expression;
$this->type = $module;
// Add a search_* tag. This needs to be added before any preExecute methods
// for decorated queries are called, as $this->prepared will be set to TRUE
// and tags added in the execute method will never get used. For example,
// if $query is extended by 'SearchQuery' then 'PagerDefault', the
// search-specific tag will be added too late (when preExecute() has
// already been called from the PagerDefault extender), and as a
// consequence will not be available to hook_query_alter() implementations,
// nor will the correct hook_query_TAG_alter() implementations get invoked.
// See node_search_execute().
$this->addTag('search_' . $module);
return $this;
}
/**
* Applies a search option and removes it from the search query string.
*
* These options are in the form option:value,value2,value3.
*
* @param $option
* Name of the option.
* @param $column
* Name of the database column to which the value should be applied.
*
* @return
* TRUE if a value for that option was found, FALSE if not.
*/
public function setOption($option, $column) {
if ($values = search_expression_extract($this->searchExpression, $option)) {
$or = db_or();
foreach (explode(',', $values) as $value) {
$or->condition($column, $value);
}
$this->condition($or);
$this->searchExpression = search_expression_insert($this->searchExpression, $option);
return TRUE;
}
return FALSE;
}
/**
* Parses the search query into SQL conditions.
*
* We build two queries that match the dataset bodies.
*/
protected function parseSearchExpression() {
// Matchs words optionally prefixed by a dash. A word in this case is
// something between two spaces, optionally quoted.
preg_match_all('/ (-?)("[^"]+"|[^" ]+)/i', ' ' . $this->searchExpression , $keywords, PREG_SET_ORDER);
if (count($keywords) == 0) {
return;
}
// Classify tokens.
$or = FALSE;
$warning = '';
$limit_combinations = variable_get('search_and_or_limit', 7);
// The first search expression does not count as AND.
$and_count = -1;
$or_count = 0;
foreach ($keywords as $match) {
if ($or_count && $and_count + $or_count >= $limit_combinations) {
// Ignore all further search expressions to prevent Denial-of-Service
// attacks using a high number of AND/OR combinations.
$this->expressionsIgnored = TRUE;
break;
}
$phrase = FALSE;
// Strip off phrase quotes.
if ($match[2][0] == '"') {
$match[2] = substr($match[2], 1, -1);
$phrase = TRUE;
$this->simple = FALSE;
}
// Simplify keyword according to indexing rules and external
// preprocessors. Use same process as during search indexing, so it
// will match search index.
$words = search_simplify($match[2]);
// Re-explode in case simplification added more words, except when
// matching a phrase.
$words = $phrase ? array($words) : preg_split('/ /', $words, -1, PREG_SPLIT_NO_EMPTY);
// Negative matches.
if ($match[1] == '-') {
$this->keys['negative'] = array_merge($this->keys['negative'], $words);
}
// OR operator: instead of a single keyword, we store an array of all
// OR'd keywords.
elseif ($match[2] == 'OR' && count($this->keys['positive'])) {
$last = array_pop($this->keys['positive']);
// Starting a new OR?
if (!is_array($last)) {
$last = array($last);
}
$this->keys['positive'][] = $last;
$or = TRUE;
$or_count++;
continue;
}
// AND operator: implied, so just ignore it.
elseif ($match[2] == 'AND' || $match[2] == 'and') {
$warning = $match[2];
continue;
}
// Plain keyword.
else {
if ($match[2] == 'or') {
$warning = $match[2];
}
if ($or) {
// Add to last element (which is an array).
$this->keys['positive'][count($this->keys['positive']) - 1] = array_merge($this->keys['positive'][count($this->keys['positive']) - 1], $words);
}
else {
$this->keys['positive'] = array_merge($this->keys['positive'], $words);
$and_count++;
}
}
$or = FALSE;
}
// Convert keywords into SQL statements.
$this->conditions = db_and();
$simple_and = FALSE;
$simple_or = FALSE;
// Positive matches.
foreach ($this->keys['positive'] as $key) {
// Group of ORed terms.
if (is_array($key) && count($key)) {
$simple_or = TRUE;
$any = FALSE;
$queryor = db_or();
foreach ($key as $or) {
list($num_new_scores) = $this->parseWord($or);
$any |= $num_new_scores;
$queryor->condition('d.data', "% $or %", 'LIKE');
}
if (count($queryor)) {
$this->conditions->condition($queryor);
// A group of OR keywords only needs to match once.
$this->matches += ($any > 0);
}
}
// Single ANDed term.
else {
$simple_and = TRUE;
list($num_new_scores, $num_valid_words) = $this->parseWord($key);
$this->conditions->condition('d.data', "% $key %", 'LIKE');
if (!$num_valid_words) {
$this->simple = FALSE;
}
// Each AND keyword needs to match at least once.
$this->matches += $num_new_scores;
}
}
if ($simple_and && $simple_or) {
$this->simple = FALSE;
}
// Negative matches.
foreach ($this->keys['negative'] as $key) {
$this->conditions->condition('d.data', "% $key %", 'NOT LIKE');
$this->simple = FALSE;
}
if ($warning == 'or') {
drupal_set_message(t('Search for either of the two terms with uppercase OR . For example, cats OR dogs .'));
}
}
/**
* Helper function for parseQuery().
*/
protected function parseWord($word) {
$num_new_scores = 0;
$num_valid_words = 0;
// Determine the scorewords of this word/phrase.
$split = explode(' ', $word);
foreach ($split as $s) {
$num = is_numeric($s);
if ($num || drupal_strlen($s) >= variable_get('minimum_word_size', 3)) {
if (!isset($this->words[$s])) {
$this->words[$s] = $s;
$num_new_scores++;
}
$num_valid_words++;
}
}
// Return matching snippet and number of added words.
return array($num_new_scores, $num_valid_words);
}
/**
* Executes the first pass query.
*
* This can either be done explicitly, so that additional scores and
* conditions can be applied to the second pass query, or implicitly by
* addScore() or execute().
*
* @return
* TRUE if search items exist, FALSE if not.
*/
public function executeFirstPass() {
$this->parseSearchExpression();
if (count($this->words) == 0) {
form_set_error('keys', format_plural(variable_get('minimum_word_size', 3), 'You must include at least one positive keyword with 1 character or more.', 'You must include at least one positive keyword with @count characters or more.'));
return FALSE;
}
if ($this->expressionsIgnored) {
drupal_set_message(t('Your search used too many AND/OR expressions. Only the first @count terms were included in this search.', array('@count' => variable_get('search_and_or_limit', 7))), 'warning');
}
$this->executedFirstPass = TRUE;
if (!empty($this->words)) {
$or = db_or();
foreach ($this->words as $word) {
$or->condition('i.word', $word);
}
$this->condition($or);
}
// Build query for keyword normalization.
$this->join('search_total', 't', 'i.word = t.word');
$this
->condition('i.type', $this->type)
->groupBy('i.type')
->groupBy('i.sid')
->having('COUNT(*) >= :matches', array(':matches' => $this->matches));
// Clone the query object to do the firstPass query;
$first = clone $this->query;
// For complex search queries, add the LIKE conditions to the first pass query.
if (!$this->simple) {
$first->join('search_dataset', 'd', 'i.sid = d.sid AND i.type = d.type');
$first->condition($this->conditions);
}
// Calculate maximum keyword relevance, to normalize it.
$first->addExpression('SUM(i.score * t.count)', 'calculated_score');
$this->normalize = $first
->range(0, 1)
->orderBy('calculated_score', 'DESC')
->execute()
->fetchField();
if ($this->normalize) {
return TRUE;
}
return FALSE;
}
/**
* Adds a custom score expression to the search query.
*
* Score expressions are used to order search results. If no calls to
* addScore() have taken place, a default keyword relevance score will be
* used. However, if at least one call to addScore() has taken place, the
* keyword relevance score is not automatically added.
*
* Note that you must use this method to add ordering to your searches, and
* not call orderBy() directly, when using the SearchQuery extender. This is
* because of the two-pass system the SearchQuery class uses to normalize
* scores.
*
* @param $score
* The score expression, which should evaluate to a number between 0 and 1.
* The string 'i.relevance' in a score expression will be replaced by a
* measure of keyword relevance between 0 and 1.
* @param $arguments
* Query arguments needed to provide values to the score expression.
* @param $multiply
* If set, the score is multiplied with this value. However, all scores
* with multipliers are then divided by the total of all multipliers, so
* that overall, the normalization is maintained.
*
* @return object
* The updated query object.
*/
public function addScore($score, $arguments = array(), $multiply = FALSE) {
if ($multiply) {
$i = count($this->multiply);
// Modify the score expression so it is multiplied by the multiplier,
// with a divisor to renormalize.
$score = "CAST(:multiply_$i AS DECIMAL) * COALESCE(( " . $score . "), 0) / CAST(:total_$i AS DECIMAL)";
// Add an argument for the multiplier. The :total_$i argument is taken
// care of in the execute() method, which is when the total divisor is
// calculated.
$arguments[':multiply_' . $i] = $multiply;
$this->multiply[] = $multiply;
}
$this->scores[] = $score;
$this->scoresArguments += $arguments;
return $this;
}
/**
* Executes the search.
*
* If not already done, this executes the first pass query. Then the complex
* conditions are applied to the query including score expressions and
* ordering.
*
* @return
* FALSE if the first pass query returned no results, and a database result
* set if there were results.
*/
public function execute()
{
if (!$this->executedFirstPass) {
$this->executeFirstPass();
}
if (!$this->normalize) {
return new DatabaseStatementEmpty();
}
// Add conditions to query.
$this->join('search_dataset', 'd', 'i.sid = d.sid AND i.type = d.type');
$this->condition($this->conditions);
if (empty($this->scores)) {
// Add default score.
$this->addScore('i.relevance');
}
if (count($this->multiply)) {
// Re-normalize scores with multipliers by dividing by the total of all
// multipliers. The expressions were altered in addScore(), so here just
// add the arguments for the total.
$i = 0;
$sum = array_sum($this->multiply);
foreach ($this->multiply as $total) {
$this->scoresArguments[':total_' . $i] = $sum;
$i++;
}
}
// Replace the pseudo-expression 'i.relevance' with a measure of keyword
// relevance in all score expressions, using string replacement. Careful
// though! If you just print out a float, some locales use ',' as the
// decimal separator in PHP, while SQL always uses '.'. So, make sure to
// set the number format correctly.
$relevance = number_format((1.0 / $this->normalize), 10, '.', '');
$this->scores = str_replace('i.relevance', '(' . $relevance . ' * i.score * t.count)', $this->scores);
// Add all scores together to form a query field.
$this->addExpression('SUM(' . implode(' + ', $this->scores) . ')', 'calculated_score', $this->scoresArguments);
// If an order has not yet been set for this query, add a default order
// that sorts by the calculated sum of scores.
if (count($this->getOrderBy()) == 0) {
$this->orderBy('calculated_score', 'DESC');
}
// Add useful metadata.
$this
->addMetaData('normalize', $this->normalize)
->fields('i', array('type', 'sid'));
return $this->query->execute();
}
/**
* Builds the default count query for SearchQuery.
*
* Since SearchQuery always uses GROUP BY, we can default to a subquery. We
* also add the same conditions as execute() because countQuery() is called
* first.
*/
public function countQuery() {
// Clone the inner query.
$inner = clone $this->query;
// Add conditions to query.
$inner->join('search_dataset', 'd', 'i.sid = d.sid AND i.type = d.type');
$inner->condition($this->conditions);
// Remove existing fields and expressions, they are not needed for a count
// query.
$fields =& $inner->getFields();
$fields = array();
$expressions =& $inner->getExpressions();
$expressions = array();
// Add the sid as the only field and count them as a subquery.
$count = db_select($inner->fields('i', array('sid')), NULL, array('target' => 'slave'));
// Add the COUNT() expression.
$count->addExpression('COUNT(*)');
return $count;
}
}
name = Search
description = Enables site-wide keyword searching.
package = Core
version = VERSION
core = 7.x
files[] = search.extender.inc
files[] = search.test
configure = admin/config/search/settings
stylesheets[all][] = search.css
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
'Stores items that will be searched.',
'fields' => array(
'sid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => 'Search item ID, e.g. node ID for nodes.',
),
'type' => array(
'type' => 'varchar',
'length' => 16,
'not null' => TRUE,
'description' => 'Type of item, e.g. node.',
),
'data' => array(
'type' => 'text',
'not null' => TRUE,
'size' => 'big',
'description' => 'List of space-separated words from the item.',
),
'reindex' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => 'Set to force node reindexing.',
),
),
'primary key' => array('sid', 'type'),
);
$schema['search_index'] = array(
'description' => 'Stores the search index, associating words, items and scores.',
'fields' => array(
'word' => array(
'type' => 'varchar',
'length' => 50,
'not null' => TRUE,
'default' => '',
'description' => 'The {search_total}.word that is associated with the search item.',
),
'sid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => 'The {search_dataset}.sid of the searchable item to which the word belongs.',
),
'type' => array(
'type' => 'varchar',
'length' => 16,
'not null' => TRUE,
'description' => 'The {search_dataset}.type of the searchable item to which the word belongs.',
),
'score' => array(
'type' => 'float',
'not null' => FALSE,
'description' => 'The numeric score of the word, higher being more important.',
),
),
'indexes' => array(
'sid_type' => array('sid', 'type'),
),
'foreign keys' => array(
'search_dataset' => array(
'table' => 'search_dataset',
'columns' => array(
'sid' => 'sid',
'type' => 'type',
),
),
),
'primary key' => array('word', 'sid', 'type'),
);
$schema['search_total'] = array(
'description' => 'Stores search totals for words.',
'fields' => array(
'word' => array(
'description' => 'Primary Key: Unique word in the search index.',
'type' => 'varchar',
'length' => 50,
'not null' => TRUE,
'default' => '',
),
'count' => array(
'description' => "The count of the word in the index using Zipf's law to equalize the probability distribution.",
'type' => 'float',
'not null' => FALSE,
),
),
'primary key' => array('word'),
);
$schema['search_node_links'] = array(
'description' => 'Stores items (like nodes) that link to other nodes, used to improve search scores for nodes that are frequently linked to.',
'fields' => array(
'sid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => 'The {search_dataset}.sid of the searchable item containing the link to the node.',
),
'type' => array(
'type' => 'varchar',
'length' => 16,
'not null' => TRUE,
'default' => '',
'description' => 'The {search_dataset}.type of the searchable item containing the link to the node.',
),
'nid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => 'The {node}.nid that this item links to.',
),
'caption' => array(
'type' => 'text',
'size' => 'big',
'not null' => FALSE,
'description' => 'The text used to link to the {node}.nid.',
),
),
'primary key' => array('sid', 'type', 'nid'),
'indexes' => array(
'nid' => array('nid'),
),
);
return $schema;
}
/**
* Replace unique keys in 'search_dataset' and 'search_index' by primary keys.
*/
function search_update_7000() {
db_drop_unique_key('search_dataset', 'sid_type');
$dataset_type_spec = array(
'type' => 'varchar',
'length' => 16,
'not null' => TRUE,
'description' => 'Type of item, e.g. node.',
);
db_change_field('search_dataset', 'type', 'type', $dataset_type_spec);
db_add_primary_key('search_dataset', array('sid', 'type'));
db_drop_index('search_index', 'word');
db_drop_unique_key('search_index', 'word_sid_type');
$index_type_spec = array(
'type' => 'varchar',
'length' => 16,
'not null' => TRUE,
'description' => 'The {search_dataset}.type of the searchable item to which the word belongs.',
);
db_change_field('search_index', 'type', 'type', $index_type_spec);
db_add_primary_key('search_index', array('word', 'sid', 'type'));
}
' . t('About') . '';
$output .= '' . t('The Search module provides the ability to index and search for content by exact keywords, and for users by username or e-mail. For more information, see the online handbook entry for Search module .', array('@search-module' => 'http://drupal.org/documentation/modules/search/', '@search' => url('search'))) . '
';
$output .= '' . t('Uses') . ' ';
$output .= '';
$output .= '' . t('Searching content and users') . ' ';
$output .= '' . t('Users with Use search permission can use the search block and Search page . Users with the View published content permission can search for content containing exact keywords. Users with the View user profiles permission can search for users containing the keyword anywhere in the user name, and users with the Administer users permission can search for users by email address. Additionally, users with Use advanced search permission can find content using more complex search methods and filtering by choosing the Advanced search option on the Search page .', array('@search' => url('search'))) . ' ';
$output .= '' . t('Indexing content with cron') . ' ';
$output .= '' . t('To provide keyword searching, the search engine maintains an index of words found in the content and its fields, along with text added to your content by other modules (such as comments from the core Comment module, and taxonomy terms from the core Taxonomy module). To build and maintain this index, a correctly configured cron maintenance task is required. Users with Administer search permission can further configure the cron settings on the Search settings page .', array('@cron' => 'http://drupal.org/cron', '@searchsettings' => url('admin/config/search/settings'))) . ' ';
$output .= '' . t('Content reindexing') . ' ';
$output .= '' . t('Content-related actions on your site (creating, editing, or deleting content and comments) automatically cause affected content items to be marked for indexing or reindexing at the next cron run. When content is marked for reindexing, the previous content remains in the index until cron runs, at which time it is replaced by the new content. Unlike content-related actions, actions related to the structure of your site do not cause affected content to be marked for reindexing. Examples of structure-related actions that affect content include deleting or editing taxonomy terms, enabling or disabling modules that add text to content (such as Taxonomy, Comment, and field-providing modules), and modifying the fields or display parameters of your content types. If you take one of these actions and you want to ensure that the search index is updated to reflect your changed site structure, you can mark all content for reindexing by clicking the "Re-index site" button on the Search settings page . If you have a lot of content on your site, it may take several cron runs for the content to be reindexed.', array('@searchsettings' => url('admin/config/search/settings'))) . ' ';
$output .= '' . t('Configuring search settings') . ' ';
$output .= '' . t('Indexing behavior can be adjusted using the Search settings page . Users with Administer search permission can control settings such as the Number of items to index per cron run , Indexing settings (word length), Active search modules , and Content ranking , which lets you adjust the priority in which indexed content is returned in results.', array('@searchsettings' => url('admin/config/search/settings'))) . ' ';
$output .= '' . t('Search block') . ' ';
$output .= '' . t('The Search module includes a default Search form block, which can be enabled and configured on the Blocks administration page . The block is available to users with the Search content permission.', array('@blocks' => url('admin/structure/block'))) . ' ';
$output .= '' . t('Extending Search module') . ' ';
$output .= '' . t('By default, the Search module only supports exact keyword matching in content searches. You can modify this behavior by installing a language-specific stemming module for your language (such as Porter Stemmer for American English), which allows words such as walk, walking, and walked to be matched in the Search module. Another approach is to use a third-party search technology with stemming or partial word matching features built in, such as Apache Solr or Sphinx . These and other search-related contributed modules can be downloaded by visiting Drupal.org.', array('@contrib-search' => 'http://drupal.org/project/modules?filters=tid%3A105')) . ' ';
$output .= ' ';
return $output;
case 'admin/config/search/settings':
return '' . t('The search engine maintains an index of words found in your site\'s content. To build and maintain this index, a correctly configured cron maintenance task is required. Indexing behavior can be adjusted using the settings below.', array('@cron' => url('admin/reports/status'))) . '
';
case 'search#noresults':
return t('
Check if your spelling is correct.
Remove quotes around phrases to search for each word individually. bike shed will often show more results than "bike shed" .
Consider loosening your query with OR . bike OR shed will often show more results than bike shed .
');
}
}
/**
* Implements hook_theme().
*/
function search_theme() {
return array(
'search_block_form' => array(
'render element' => 'form',
'template' => 'search-block-form',
),
'search_result' => array(
'variables' => array('result' => NULL, 'module' => NULL),
'file' => 'search.pages.inc',
'template' => 'search-result',
),
'search_results' => array(
'variables' => array('results' => NULL, 'module' => NULL),
'file' => 'search.pages.inc',
'template' => 'search-results',
),
);
}
/**
* Implements hook_permission().
*/
function search_permission() {
return array(
'administer search' => array(
'title' => t('Administer search'),
),
'search content' => array(
'title' => t('Use search'),
),
'use advanced search' => array(
'title' => t('Use advanced search'),
),
);
}
/**
* Implements hook_block_info().
*/
function search_block_info() {
$blocks['form']['info'] = t('Search form');
// Not worth caching.
$blocks['form']['cache'] = DRUPAL_NO_CACHE;
$blocks['form']['properties']['administrative'] = TRUE;
return $blocks;
}
/**
* Implements hook_block_view().
*/
function search_block_view($delta = '') {
if (user_access('search content')) {
$block['content'] = drupal_get_form('search_block_form');
return $block;
}
}
/**
* Implements hook_menu().
*/
function search_menu() {
$items['search'] = array(
'title' => 'Search',
'page callback' => 'search_view',
'access callback' => 'search_is_active',
'type' => MENU_SUGGESTED_ITEM,
'file' => 'search.pages.inc',
);
$items['admin/config/search/settings'] = array(
'title' => 'Search settings',
'description' => 'Configure relevance settings for search and other indexing options.',
'page callback' => 'drupal_get_form',
'page arguments' => array('search_admin_settings'),
'access arguments' => array('administer search'),
'weight' => -10,
'file' => 'search.admin.inc',
);
$items['admin/config/search/settings/reindex'] = array(
'title' => 'Clear index',
'page callback' => 'drupal_get_form',
'page arguments' => array('search_reindex_confirm'),
'access arguments' => array('administer search'),
'type' => MENU_VISIBLE_IN_BREADCRUMB,
'file' => 'search.admin.inc',
);
// Add paths for searching. We add each module search path twice: once without
// and once with %menu_tail appended. The reason for this is that we want to
// preserve keywords when switching tabs, and also to have search tabs
// highlighted properly. The only way to do that within the Drupal menu
// system appears to be having two sets of tabs. See discussion on issue
// http://drupal.org/node/245103 for details.
drupal_static_reset('search_get_info');
$default_info = search_get_default_module_info();
if ($default_info) {
foreach (search_get_info() as $module => $search_info) {
$path = 'search/' . $search_info['path'];
$items[$path] = array(
'title' => $search_info['title'],
'page callback' => 'search_view',
'page arguments' => array($module, ''),
'access callback' => '_search_menu_access',
'access arguments' => array($module),
'type' => MENU_LOCAL_TASK,
'file' => 'search.pages.inc',
'weight' => $module == $default_info['module'] ? -10 : 0,
);
$items["$path/%menu_tail"] = array(
'title' => $search_info['title'],
'load arguments' => array('%map', '%index'),
'page callback' => 'search_view',
'page arguments' => array($module, 2),
'access callback' => '_search_menu_access',
'access arguments' => array($module),
// The default local task points to its parent, but this item points to
// where it should so it should not be changed.
'type' => MENU_LOCAL_TASK,
'file' => 'search.pages.inc',
'weight' => 0,
// These tabs are not subtabs.
'tab_root' => 'search/' . $default_info['path'] . '/%',
// These tabs need to display at the same level.
'tab_parent' => 'search/' . $default_info['path'],
);
}
}
return $items;
}
/**
* Determines access for the ?q=search path.
*/
function search_is_active() {
// This path cannot be accessed if there are no active modules.
return user_access('search content') && search_get_info();
}
/**
* Returns information about available search modules.
*
* @param $all
* If TRUE, information about all enabled modules implementing
* hook_search_info() will be returned. If FALSE (default), only modules that
* have been set to active on the search settings page will be returned.
*
* @return
* Array of hook_search_info() return values, keyed by module name. The
* 'title' and 'path' array elements will be set to defaults for each module
* if not supplied by hook_search_info(), and an additional array element of
* 'module' will be added (set to the module name).
*/
function search_get_info($all = FALSE) {
$search_hooks = &drupal_static(__FUNCTION__);
if (!isset($search_hooks)) {
foreach (module_implements('search_info') as $module) {
$search_hooks[$module] = call_user_func($module . '_search_info');
// Use module name as the default value.
$search_hooks[$module] += array('title' => $module, 'path' => $module);
// Include the module name itself in the array.
$search_hooks[$module]['module'] = $module;
}
}
if ($all) {
return $search_hooks;
}
$active = variable_get('search_active_modules', array('node', 'user'));
return array_intersect_key($search_hooks, array_flip($active));
}
/**
* Returns information about the default search module.
*
* @return
* The search_get_info() array element for the default search module, if any.
*/
function search_get_default_module_info() {
$info = search_get_info();
$default = variable_get('search_default_module', 'node');
if (isset($info[$default])) {
return $info[$default];
}
// The variable setting does not match any active module, so just return
// the info for the first active module (if any).
return reset($info);
}
/**
* Access callback for search tabs.
*/
function _search_menu_access($name) {
return user_access('search content') && (!function_exists($name . '_search_access') || module_invoke($name, 'search_access'));
}
/**
* Clears a part of or the entire search index.
*
* @param $sid
* (optional) The ID of the item to remove from the search index. If
* specified, $module must also be given. Omit both $sid and $module to clear
* the entire search index.
* @param $module
* (optional) The machine-readable name of the module for the item to remove
* from the search index.
*/
function search_reindex($sid = NULL, $module = NULL, $reindex = FALSE) {
if ($module == NULL && $sid == NULL) {
module_invoke_all('search_reset');
}
else {
db_delete('search_dataset')
->condition('sid', $sid)
->condition('type', $module)
->execute();
db_delete('search_index')
->condition('sid', $sid)
->condition('type', $module)
->execute();
// Don't remove links if re-indexing.
if (!$reindex) {
db_delete('search_node_links')
->condition('sid', $sid)
->condition('type', $module)
->execute();
}
}
}
/**
* Marks a word as "dirty" (changed), or retrieves the list of dirty words.
*
* This is used during indexing (cron). Words that are dirty have outdated
* total counts in the search_total table, and need to be recounted.
*/
function search_dirty($word = NULL) {
$dirty = &drupal_static(__FUNCTION__, array());
if ($word !== NULL) {
$dirty[$word] = TRUE;
}
else {
return $dirty;
}
}
/**
* Implements hook_cron().
*
* Fires hook_update_index() in all modules and cleans up dirty words.
*
* @see search_dirty()
*/
function search_cron() {
// We register a shutdown function to ensure that search_total is always up
// to date.
drupal_register_shutdown_function('search_update_totals');
foreach (variable_get('search_active_modules', array('node', 'user')) as $module) {
// Update word index
module_invoke($module, 'update_index');
}
}
/**
* Updates the {search_total} database table.
*
* This function is called on shutdown to ensure that {search_total} is always
* up to date (even if cron times out or otherwise fails).
*/
function search_update_totals() {
// Update word IDF (Inverse Document Frequency) counts for new/changed words.
foreach (search_dirty() as $word => $dummy) {
// Get total count
$total = db_query("SELECT SUM(score) FROM {search_index} WHERE word = :word", array(':word' => $word), array('target' => 'slave'))->fetchField();
// Apply Zipf's law to equalize the probability distribution.
$total = log10(1 + 1/(max(1, $total)));
db_merge('search_total')
->key(array('word' => $word))
->fields(array('count' => $total))
->execute();
}
// Find words that were deleted from search_index, but are still in
// search_total. We use a LEFT JOIN between the two tables and keep only the
// rows which fail to join.
$result = db_query("SELECT t.word AS realword, i.word FROM {search_total} t LEFT JOIN {search_index} i ON t.word = i.word WHERE i.word IS NULL", array(), array('target' => 'slave'));
$or = db_or();
foreach ($result as $word) {
$or->condition('word', $word->realword);
}
if (count($or) > 0) {
db_delete('search_total')
->condition($or)
->execute();
}
}
/**
* Simplifies a string according to indexing rules.
*
* @param $text
* Text to simplify.
*
* @return
* Simplified text.
*
* @see hook_search_preprocess()
*/
function search_simplify($text) {
// Decode entities to UTF-8
$text = decode_entities($text);
// Lowercase
$text = drupal_strtolower($text);
// Call an external processor for word handling.
search_invoke_preprocess($text);
// Simple CJK handling
if (variable_get('overlap_cjk', TRUE)) {
$text = preg_replace_callback('/[' . PREG_CLASS_CJK . ']+/u', 'search_expand_cjk', $text);
}
// To improve searching for numerical data such as dates, IP addresses
// or version numbers, we consider a group of numerical characters
// separated only by punctuation characters to be one piece.
// This also means that searching for e.g. '20/03/1984' also returns
// results with '20-03-1984' in them.
// Readable regexp: ([number]+)[punctuation]+(?=[number])
$text = preg_replace('/([' . PREG_CLASS_NUMBERS . ']+)[' . PREG_CLASS_PUNCTUATION . ']+(?=[' . PREG_CLASS_NUMBERS . '])/u', '\1', $text);
// Multiple dot and dash groups are word boundaries and replaced with space.
// No need to use the unicode modifer here because 0-127 ASCII characters
// can't match higher UTF-8 characters as the leftmost bit of those are 1.
$text = preg_replace('/[.-]{2,}/', ' ', $text);
// The dot, underscore and dash are simply removed. This allows meaningful
// search behavior with acronyms and URLs. See unicode note directly above.
$text = preg_replace('/[._-]+/', '', $text);
// With the exception of the rules above, we consider all punctuation,
// marks, spacers, etc, to be a word boundary.
$text = preg_replace('/[' . PREG_CLASS_UNICODE_WORD_BOUNDARY . ']+/u', ' ', $text);
// Truncate everything to 50 characters.
$words = explode(' ', $text);
array_walk($words, '_search_index_truncate');
$text = implode(' ', $words);
return $text;
}
/**
* Splits CJK (Chinese, Japanese, Korean) text into tokens.
*
* The Search module matches exact words, where a word is defined to be a
* sequence of characters delimited by spaces or punctuation. CJK languages are
* written in long strings of characters, though, not split up into words. So
* in order to allow search matching, we split up CJK text into tokens
* consisting of consecutive, overlapping sequences of characters whose length
* is equal to the 'minimum_word_size' variable. This tokenizing is only done if
* the 'overlap_cjk' variable is TRUE.
*
* @param $matches
* This function is a callback for preg_replace_callback(), which is called
* from search_simplify(). So, $matches is an array of regular expression
* matches, which means that $matches[0] contains the matched text -- a string
* of CJK characters to tokenize.
*
* @return
* Tokenized text, starting and ending with a space character.
*/
function search_expand_cjk($matches) {
$min = variable_get('minimum_word_size', 3);
$str = $matches[0];
$length = drupal_strlen($str);
// If the text is shorter than the minimum word size, don't tokenize it.
if ($length <= $min) {
return ' ' . $str . ' ';
}
$tokens = ' ';
// Build a FIFO queue of characters.
$chars = array();
for ($i = 0; $i < $length; $i++) {
// Add the next character off the beginning of the string to the queue.
$current = drupal_substr($str, 0, 1);
$str = substr($str, strlen($current));
$chars[] = $current;
if ($i >= $min - 1) {
// Make a token of $min characters, and add it to the token string.
$tokens .= implode('', $chars) . ' ';
// Shift out the first character in the queue.
array_shift($chars);
}
}
return $tokens;
}
/**
* Simplifies and splits a string into tokens for indexing.
*/
function search_index_split($text) {
$last = &drupal_static(__FUNCTION__);
$lastsplit = &drupal_static(__FUNCTION__ . ':lastsplit');
if ($last == $text) {
return $lastsplit;
}
// Process words
$text = search_simplify($text);
$words = explode(' ', $text);
// Save last keyword result
$last = $text;
$lastsplit = $words;
return $words;
}
/**
* Helper function for array_walk in search_index_split.
*/
function _search_index_truncate(&$text) {
if (is_numeric($text)) {
$text = ltrim($text, '0');
}
$text = truncate_utf8($text, 50);
}
/**
* Invokes hook_search_preprocess() in modules.
*/
function search_invoke_preprocess(&$text) {
foreach (module_implements('search_preprocess') as $module) {
$text = module_invoke($module, 'search_preprocess', $text);
}
}
/**
* Update the full-text search index for a particular item.
*
* @param $sid
* An ID number identifying this particular item (e.g., node ID).
* @param $module
* The machine-readable name of the module that this item comes from (a module
* that implements hook_search_info()).
* @param $text
* The content of this item. Must be a piece of HTML or plain text.
*
* @ingroup search
*/
function search_index($sid, $module, $text) {
$minimum_word_size = variable_get('minimum_word_size', 3);
// Link matching
global $base_url;
$node_regexp = '@href=[\'"]?(?:' . preg_quote($base_url, '@') . '/|' . preg_quote(base_path(), '@') . ')(?:\?q=)?/?((?![a-z]+:)[^\'">]+)[\'">]@i';
// Multipliers for scores of words inside certain HTML tags. The weights are stored
// in a variable so that modules can overwrite the default weights.
// Note: 'a' must be included for link ranking to work.
$tags = variable_get('search_tag_weights', array(
'h1' => 25,
'h2' => 18,
'h3' => 15,
'h4' => 12,
'h5' => 9,
'h6' => 6,
'u' => 3,
'b' => 3,
'i' => 3,
'strong' => 3,
'em' => 3,
'a' => 10));
// Strip off all ignored tags to speed up processing, but insert space before/after
// them to keep word boundaries.
$text = str_replace(array('<', '>'), array(' <', '> '), $text);
$text = strip_tags($text, '<' . implode('><', array_keys($tags)) . '>');
// Split HTML tags from plain text.
$split = preg_split('/\s*<([^>]+?)>\s*/', $text, -1, PREG_SPLIT_DELIM_CAPTURE);
// Note: PHP ensures the array consists of alternating delimiters and literals
// and begins and ends with a literal (inserting $null as required).
$tag = FALSE; // Odd/even counter. Tag or no tag.
$link = FALSE; // State variable for link analyzer
$score = 1; // Starting score per word
$accum = ' '; // Accumulator for cleaned up data
$tagstack = array(); // Stack with open tags
$tagwords = 0; // Counter for consecutive words
$focus = 1; // Focus state
$results = array(0 => array()); // Accumulator for words for index
foreach ($split as $value) {
if ($tag) {
// Increase or decrease score per word based on tag
list($tagname) = explode(' ', $value, 2);
$tagname = drupal_strtolower($tagname);
// Closing or opening tag?
if ($tagname[0] == '/') {
$tagname = substr($tagname, 1);
// If we encounter unexpected tags, reset score to avoid incorrect boosting.
if (!count($tagstack) || $tagstack[0] != $tagname) {
$tagstack = array();
$score = 1;
}
else {
// Remove from tag stack and decrement score
$score = max(1, $score - $tags[array_shift($tagstack)]);
}
if ($tagname == 'a') {
$link = FALSE;
}
}
else {
if (isset($tagstack[0]) && $tagstack[0] == $tagname) {
// None of the tags we look for make sense when nested identically.
// If they are, it's probably broken HTML.
$tagstack = array();
$score = 1;
}
else {
// Add to open tag stack and increment score
array_unshift($tagstack, $tagname);
$score += $tags[$tagname];
}
if ($tagname == 'a') {
// Check if link points to a node on this site
if (preg_match($node_regexp, $value, $match)) {
$path = drupal_get_normal_path($match[1]);
if (preg_match('!(?:node|book)/(?:view/)?([0-9]+)!i', $path, $match)) {
$linknid = $match[1];
if ($linknid > 0) {
$node = db_query('SELECT title, nid, vid FROM {node} WHERE nid = :nid', array(':nid' => $linknid), array('target' => 'slave'))->fetchObject();
$link = TRUE;
$linktitle = $node->title;
}
}
}
}
}
// A tag change occurred, reset counter.
$tagwords = 0;
}
else {
// Note: use of PREG_SPLIT_DELIM_CAPTURE above will introduce empty values
if ($value != '') {
if ($link) {
// Check to see if the node link text is its URL. If so, we use the target node title instead.
if (preg_match('!^https?://!i', $value)) {
$value = $linktitle;
}
}
$words = search_index_split($value);
foreach ($words as $word) {
// Add word to accumulator
$accum .= $word . ' ';
// Check wordlength
if (is_numeric($word) || drupal_strlen($word) >= $minimum_word_size) {
// Links score mainly for the target.
if ($link) {
if (!isset($results[$linknid])) {
$results[$linknid] = array();
}
$results[$linknid][] = $word;
// Reduce score of the link caption in the source.
$focus *= 0.2;
}
// Fall-through
if (!isset($results[0][$word])) {
$results[0][$word] = 0;
}
$results[0][$word] += $score * $focus;
// Focus is a decaying value in terms of the amount of unique words up to this point.
// From 100 words and more, it decays, to e.g. 0.5 at 500 words and 0.3 at 1000 words.
$focus = min(1, .01 + 3.5 / (2 + count($results[0]) * .015));
}
$tagwords++;
// Too many words inside a single tag probably mean a tag was accidentally left open.
if (count($tagstack) && $tagwords >= 15) {
$tagstack = array();
$score = 1;
}
}
}
}
$tag = !$tag;
}
search_reindex($sid, $module, TRUE);
// Insert cleaned up data into dataset
db_insert('search_dataset')
->fields(array(
'sid' => $sid,
'type' => $module,
'data' => $accum,
'reindex' => 0,
))
->execute();
// Insert results into search index
foreach ($results[0] as $word => $score) {
// If a word already exists in the database, its score gets increased
// appropriately. If not, we create a new record with the appropriate
// starting score.
db_merge('search_index')
->key(array(
'word' => $word,
'sid' => $sid,
'type' => $module,
))
->fields(array('score' => $score))
->expression('score', 'score + :score', array(':score' => $score))
->execute();
search_dirty($word);
}
unset($results[0]);
// Get all previous links from this item.
$result = db_query("SELECT nid, caption FROM {search_node_links} WHERE sid = :sid AND type = :type", array(
':sid' => $sid,
':type' => $module
), array('target' => 'slave'));
$links = array();
foreach ($result as $link) {
$links[$link->nid] = $link->caption;
}
// Now store links to nodes.
foreach ($results as $nid => $words) {
$caption = implode(' ', $words);
if (isset($links[$nid])) {
if ($links[$nid] != $caption) {
// Update the existing link and mark the node for reindexing.
db_update('search_node_links')
->fields(array('caption' => $caption))
->condition('sid', $sid)
->condition('type', $module)
->condition('nid', $nid)
->execute();
search_touch_node($nid);
}
// Unset the link to mark it as processed.
unset($links[$nid]);
}
elseif ($sid != $nid || $module != 'node') {
// Insert the existing link and mark the node for reindexing, but don't
// reindex if this is a link in a node pointing to itself.
db_insert('search_node_links')
->fields(array(
'caption' => $caption,
'sid' => $sid,
'type' => $module,
'nid' => $nid,
))
->execute();
search_touch_node($nid);
}
}
// Any left-over links in $links no longer exist. Delete them and mark the nodes for reindexing.
foreach ($links as $nid => $caption) {
db_delete('search_node_links')
->condition('sid', $sid)
->condition('type', $module)
->condition('nid', $nid)
->execute();
search_touch_node($nid);
}
}
/**
* Changes a node's changed timestamp to 'now' to force reindexing.
*
* @param $nid
* The node ID of the node that needs reindexing.
*/
function search_touch_node($nid) {
db_update('search_dataset')
->fields(array('reindex' => REQUEST_TIME))
->condition('type', 'node')
->condition('sid', $nid)
->execute();
}
/**
* Implements hook_node_update_index().
*/
function search_node_update_index($node) {
// Transplant links to a node into the target node.
$result = db_query("SELECT caption FROM {search_node_links} WHERE nid = :nid", array(':nid' => $node->nid), array('target' => 'slave'));
$output = array();
foreach ($result as $link) {
$output[] = $link->caption;
}
if (count($output)) {
return '(' . implode(', ', $output) . ') ';
}
}
/**
* Implements hook_node_update().
*/
function search_node_update($node) {
// Reindex the node when it is updated. The node is automatically indexed
// when it is added, simply by being added to the node table.
search_touch_node($node->nid);
}
/**
* Implements hook_comment_insert().
*/
function search_comment_insert($comment) {
// Reindex the node when comments are added.
search_touch_node($comment->nid);
}
/**
* Implements hook_comment_update().
*/
function search_comment_update($comment) {
// Reindex the node when comments are changed.
search_touch_node($comment->nid);
}
/**
* Implements hook_comment_delete().
*/
function search_comment_delete($comment) {
// Reindex the node when comments are deleted.
search_touch_node($comment->nid);
}
/**
* Implements hook_comment_publish().
*/
function search_comment_publish($comment) {
// Reindex the node when comments are published.
search_touch_node($comment->nid);
}
/**
* Implements hook_comment_unpublish().
*/
function search_comment_unpublish($comment) {
// Reindex the node when comments are unpublished.
search_touch_node($comment->nid);
}
/**
* Extracts a module-specific search option from a search expression.
*
* Search options are added using search_expression_insert(), and retrieved
* using search_expression_extract(). They take the form option:value, and
* are added to the ordinary keywords in the search expression.
*
* @param $expression
* The search expression to extract from.
* @param $option
* The name of the option to retrieve from the search expression.
*
* @return
* The value previously stored in the search expression for option $option,
* if any. Trailing spaces in values will not be included.
*/
function search_expression_extract($expression, $option) {
if (preg_match('/(^| )' . $option . ':([^ ]*)( |$)/i', $expression, $matches)) {
return $matches[2];
}
}
/**
* Adds a module-specific search option to a search expression.
*
* Search options are added using search_expression_insert(), and retrieved
* using search_expression_extract(). They take the form option:value, and
* are added to the ordinary keywords in the search expression.
*
* @param $expression
* The search expression to add to.
* @param $option
* The name of the option to add to the search expression.
* @param $value
* The value to add for the option. If present, it will replace any previous
* value added for the option. Cannot contain any spaces or | characters, as
* these are used as delimiters. If you want to add a blank value $option: to
* the search expression, pass in an empty string or a string that is composed
* of only spaces. To clear a previously-stored option without adding a
* replacement, pass in NULL for $value or omit.
*
* @return
* $expression, with any previous value for this option removed, and a new
* $option:$value pair added if $value was provided.
*/
function search_expression_insert($expression, $option, $value = NULL) {
// Remove any previous values stored with $option.
$expression = trim(preg_replace('/(^| )' . $option . ':[^ ]*/i', '', $expression));
// Set new value, if provided.
if (isset($value)) {
$expression .= ' ' . $option . ':' . trim($value);
}
return $expression;
}
/**
* @defgroup search Search interface
* @{
* The Drupal search interface manages a global search mechanism.
*
* Modules may plug into this system to provide searches of different types of
* data. Most of the system is handled by search.module, so this must be enabled
* for all of the search features to work.
*
* There are three ways to interact with the search system:
* - Specifically for searching nodes, you can implement
* hook_node_update_index() and hook_node_search_result(). However, note that
* the search system already indexes all visible output of a node; i.e.,
* everything displayed normally by hook_view() and hook_node_view(). This is
* usually sufficient. You should only use this mechanism if you want
* additional, non-visible data to be indexed.
* - Implement hook_search_info(). This will create a search tab for your module
* on the /search page with a simple keyword search form. You will also need
* to implement hook_search_execute() to perform the search.
* - Implement hook_update_index(). This allows your module to use Drupal's
* HTML indexing mechanism for searching full text efficiently.
*
* If your module needs to provide a more complicated search form, then you need
* to implement it yourself without hook_search_info(). In that case, you should
* define it as a local task (tab) under the /search page (e.g. /search/mymodule)
* so that users can easily find it.
*/
/**
* Builds a search form.
*
* @param $action
* Form action. Defaults to "search/$path", where $path is the search path
* associated with the module in its hook_search_info(). This will be
* run through url().
* @param $keys
* The search string entered by the user, containing keywords for the search.
* @param $module
* The search module to render the form for: a module that implements
* hook_search_info(). If not supplied, the default search module is used.
* @param $prompt
* Label for the keywords field. Defaults to t('Enter your keywords') if NULL.
* Supply '' to omit.
*
* @return
* A Form API array for the search form.
*/
function search_form($form, &$form_state, $action = '', $keys = '', $module = NULL, $prompt = NULL) {
$module_info = FALSE;
if (!$module) {
$module_info = search_get_default_module_info();
}
else {
$info = search_get_info();
$module_info = isset($info[$module]) ? $info[$module] : FALSE;
}
// Sanity check.
if (!$module_info) {
form_set_error(NULL, t('Search is currently disabled.'), 'error');
return $form;
}
if (!$action) {
$action = 'search/' . $module_info['path'];
}
if (!isset($prompt)) {
$prompt = t('Enter your keywords');
}
$form['#action'] = url($action);
// Record the $action for later use in redirecting.
$form_state['action'] = $action;
$form['#attributes']['class'][] = 'search-form';
$form['module'] = array('#type' => 'value', '#value' => $module);
$form['basic'] = array('#type' => 'container', '#attributes' => array('class' => array('container-inline')));
$form['basic']['keys'] = array(
'#type' => 'textfield',
'#title' => $prompt,
'#default_value' => $keys,
'#size' => $prompt ? 40 : 20,
'#maxlength' => 255,
);
// processed_keys is used to coordinate keyword passing between other forms
// that hook into the basic search form.
$form['basic']['processed_keys'] = array('#type' => 'value', '#value' => '');
$form['basic']['submit'] = array('#type' => 'submit', '#value' => t('Search'));
return $form;
}
/**
* Form builder; Output a search form for the search block's search box.
*
* @ingroup forms
* @see search_box_form_submit()
* @see search-block-form.tpl.php
*/
function search_box($form, &$form_state, $form_id) {
$form[$form_id] = array(
'#type' => 'textfield',
'#title' => t('Search'),
'#title_display' => 'invisible',
'#size' => 15,
'#default_value' => '',
'#attributes' => array('title' => t('Enter the terms you wish to search for.')),
);
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array('#type' => 'submit', '#value' => t('Search'));
$form['#submit'][] = 'search_box_form_submit';
return $form;
}
/**
* Process a block search form submission.
*/
function search_box_form_submit($form, &$form_state) {
// The search form relies on control of the redirect destination for its
// functionality, so we override any static destination set in the request,
// for example by drupal_access_denied() or drupal_not_found()
// (see http://drupal.org/node/292565).
if (isset($_GET['destination'])) {
unset($_GET['destination']);
}
// Check to see if the form was submitted empty.
// If it is empty, display an error message.
// (This method is used instead of setting #required to TRUE for this field
// because that results in a confusing error message. It would say a plain
// "field is required" because the search keywords field has no title.
// The error message would also complain about a missing #title field.)
if ($form_state['values']['search_block_form'] == '') {
form_set_error('keys', t('Please enter some keywords.'));
}
$form_id = $form['form_id']['#value'];
$info = search_get_default_module_info();
if ($info) {
$form_state['redirect'] = 'search/' . $info['path'] . '/' . trim($form_state['values'][$form_id]);
}
else {
form_set_error(NULL, t('Search is currently disabled.'), 'error');
}
}
/**
* Process variables for search-block-form.tpl.php.
*
* The $variables array contains the following arguments:
* - $form
*
* @see search-block-form.tpl.php
*/
function template_preprocess_search_block_form(&$variables) {
$variables['search'] = array();
$hidden = array();
// Provide variables named after form keys so themers can print each element independently.
foreach (element_children($variables['form']) as $key) {
$type = isset($variables['form'][$key]['#type']) ? $variables['form'][$key]['#type'] : '';
if ($type == 'hidden' || $type == 'token') {
$hidden[] = drupal_render($variables['form'][$key]);
}
else {
$variables['search'][$key] = drupal_render($variables['form'][$key]);
}
}
// Hidden form elements have no value to themers. No need for separation.
$variables['search']['hidden'] = implode($hidden);
// Collect all form elements to make it easier to print the whole form.
$variables['search_form'] = implode($variables['search']);
}
/**
* Performs a search by calling hook_search_execute().
*
* @param $keys
* Keyword query to search on.
* @param $module
* Search module to search.
* @param $conditions
* Optional array of additional search conditions.
*
* @return
* Renderable array of search results. No return value if $keys are not
* supplied or if the given search module is not active.
*/
function search_data($keys, $module, $conditions = NULL) {
if (module_hook($module, 'search_execute')) {
$results = module_invoke($module, 'search_execute', $keys, $conditions);
if (module_hook($module, 'search_page')) {
return module_invoke($module, 'search_page', $results);
}
else {
return array(
'#theme' => 'search_results',
'#results' => $results,
'#module' => $module,
);
}
}
}
/**
* Returns snippets from a piece of text, with certain keywords highlighted.
* Used for formatting search results.
*
* @param $keys
* A string containing a search query.
*
* @param $text
* The text to extract fragments from.
*
* @return
* A string containing HTML for the excerpt.
*/
function search_excerpt($keys, $text) {
// We highlight around non-indexable or CJK characters.
$boundary = '(?:(?<=[' . PREG_CLASS_UNICODE_WORD_BOUNDARY . PREG_CLASS_CJK . '])|(?=[' . PREG_CLASS_UNICODE_WORD_BOUNDARY . PREG_CLASS_CJK . ']))';
// Extract positive keywords and phrases
preg_match_all('/ ("([^"]+)"|(?!OR)([^" ]+))/', ' ' . $keys, $matches);
$keys = array_merge($matches[2], $matches[3]);
// Prepare text by stripping HTML tags and decoding HTML entities.
$text = strip_tags(str_replace(array('<', '>'), array(' <', '> '), $text));
$text = decode_entities($text);
// Slash-escape quotes in the search keyword string.
array_walk($keys, '_search_excerpt_replace');
$workkeys = $keys;
// Extract fragments around keywords.
// First we collect ranges of text around each keyword, starting/ending
// at spaces, trying to get to 256 characters.
// If the sum of all fragments is too short, we look for second occurrences.
$ranges = array();
$included = array();
$foundkeys = array();
$length = 0;
while ($length < 256 && count($workkeys)) {
foreach ($workkeys as $k => $key) {
if (strlen($key) == 0) {
unset($workkeys[$k]);
unset($keys[$k]);
continue;
}
if ($length >= 256) {
break;
}
// Remember occurrence of key so we can skip over it if more occurrences
// are desired.
if (!isset($included[$key])) {
$included[$key] = 0;
}
// Locate a keyword (position $p, always >0 because $text starts with a
// space). First try bare keyword, but if that doesn't work, try to find a
// derived form from search_simplify().
$p = 0;
if (preg_match('/' . $boundary . $key . $boundary . '/iu', $text, $match, PREG_OFFSET_CAPTURE, $included[$key])) {
$p = $match[0][1];
}
else {
$info = search_simplify_excerpt_match($key, $text, $included[$key], $boundary);
if (isset($info['where'])) {
$p = $info['where'];
if ($info['keyword']) {
$foundkeys[] = $info['keyword'];
}
}
}
// Now locate a space in front (position $q) and behind it (position $s),
// leaving about 60 characters extra before and after for context.
// Note that a space was added to the front and end of $text above.
if ($p) {
if (($q = strpos(' ' . $text, ' ', max(0, $p - 61))) !== FALSE) {
$end = substr($text . ' ', $p, 80);
if (($s = strrpos($end, ' ')) !== FALSE) {
// Account for the added spaces.
$q = max($q - 1, 0);
$s = min($s, strlen($end) - 1);
$ranges[$q] = $p + $s;
$length += $p + $s - $q;
$included[$key] = $p + 1;
}
else {
unset($workkeys[$k]);
}
}
else {
unset($workkeys[$k]);
}
}
else {
unset($workkeys[$k]);
}
}
}
if (count($ranges) == 0) {
// We didn't find any keyword matches, so just return the first part of the
// text. We also need to re-encode any HTML special characters that we
// entity-decoded above.
return check_plain(truncate_utf8($text, 256, TRUE, TRUE));
}
// Sort the text ranges by starting position.
ksort($ranges);
// Now we collapse overlapping text ranges into one. The sorting makes it O(n).
$newranges = array();
foreach ($ranges as $from2 => $to2) {
if (!isset($from1)) {
$from1 = $from2;
$to1 = $to2;
continue;
}
if ($from2 <= $to1) {
$to1 = max($to1, $to2);
}
else {
$newranges[$from1] = $to1;
$from1 = $from2;
$to1 = $to2;
}
}
$newranges[$from1] = $to1;
// Fetch text
$out = array();
foreach ($newranges as $from => $to) {
$out[] = substr($text, $from, $to - $from);
}
// Let translators have the ... separator text as one chunk.
$dots = explode('!excerpt', t('... !excerpt ... !excerpt ...'));
$text = (isset($newranges[0]) ? '' : $dots[0]) . implode($dots[1], $out) . $dots[2];
$text = check_plain($text);
// Slash-escape quotes in keys found in a derived form and merge with original keys.
array_walk($foundkeys, '_search_excerpt_replace');
$keys = array_merge($keys, $foundkeys);
// Highlight keywords. Must be done at once to prevent conflicts ('strong' and '').
$text = preg_replace('/' . $boundary . '(' . implode('|', $keys) . ')' . $boundary . '/iu', '\0 ', $text);
return $text;
}
/**
* @} End of "defgroup search".
*/
/**
* Helper function for array_walk() in search_excerpt().
*/
function _search_excerpt_replace(&$text) {
$text = preg_quote($text, '/');
}
/**
* Find words in the original text that matched via search_simplify().
*
* This is called in search_excerpt() if an exact match is not found in the
* text, so that we can find the derived form that matches.
*
* @param $key
* The keyword to find.
* @param $text
* The text to search for the keyword.
* @param $offset
* Offset position in $text to start searching at.
* @param $boundary
* Text to include in a regular expression that will match a word boundary.
*
* @return
* FALSE if no match is found. If a match is found, return an associative
* array with element 'where' giving the position of the match, and element
* 'keyword' giving the actual word found in the text at that position.
*/
function search_simplify_excerpt_match($key, $text, $offset, $boundary) {
$pos = NULL;
$simplified_key = search_simplify($key);
$simplified_text = search_simplify($text);
// Return immediately if simplified key or text are empty.
if (!$simplified_key || !$simplified_text) {
return FALSE;
}
// Check if we have a match after simplification in the text.
if (!preg_match('/' . $boundary . $simplified_key . $boundary . '/iu', $simplified_text, $match, PREG_OFFSET_CAPTURE, $offset)) {
return FALSE;
}
// If we get here, we have a match. Now find the exact location of the match
// and the original text that matched. Start by splitting up the text by all
// potential starting points of the matching text and iterating through them.
$split = array_filter(preg_split('/' . $boundary . '/iu', $text, -1, PREG_SPLIT_OFFSET_CAPTURE), '_search_excerpt_match_filter');
foreach ($split as $value) {
// Skip starting points before the offset.
if ($value[1] < $offset) {
continue;
}
// Check a window of 80 characters after the starting point for a match,
// based on the size of the excerpt window.
$window = substr($text, $value[1], 80);
$simplified_window = search_simplify($window);
if (strpos($simplified_window, $simplified_key) === 0) {
// We have a match in this window. Store the position of the match.
$pos = $value[1];
// Iterate through the text in the window until we find the full original
// matching text.
$length = strlen($window);
for ($i = 1; $i <= $length; $i++) {
$keyfound = substr($text, $value[1], $i);
if ($simplified_key == search_simplify($keyfound)) {
break;
}
}
break;
}
}
return $pos ? array('where' => $pos, 'keyword' => $keyfound) : FALSE;
}
/**
* Helper function for array_filter() in search_search_excerpt_match().
*/
function _search_excerpt_match_filter($var) {
return strlen(trim($var[0]));
}
/**
* Implements hook_forms().
*/
function search_forms() {
$forms['search_block_form']= array(
'callback' => 'search_box',
'callback arguments' => array('search_block_form'),
);
return $forms;
}
'');
// Process the search form. Note that if there is $_POST data,
// search_form_submit() will cause a redirect to search/[module path]/[keys],
// which will get us back to this page callback. In other words, the search
// form submits with POST but redirects to GET. This way we can keep
// the search query URL clean as a whistle.
if (empty($_POST['form_id']) || ($_POST['form_id'] != 'search_form' && $_POST['form_id'] != 'search_block_form')) {
$conditions = NULL;
if (isset($info['conditions_callback']) && function_exists($info['conditions_callback'])) {
// Build an optional array of more search conditions.
$conditions = call_user_func($info['conditions_callback'], $keys);
}
// Only search if there are keywords or non-empty conditions.
if ($keys || !empty($conditions)) {
if (variable_get('search_logging', TRUE)) {
// Log the search keys.
watchdog('search', 'Searched %type for %keys.', array('%keys' => $keys, '%type' => $info['title']), WATCHDOG_NOTICE, l(t('results'), 'search/' . $info['path'] . '/' . $keys));
}
// Collect the search results.
$results = search_data($keys, $info['module'], $conditions);
}
}
// The form may be altered based on whether the search was run.
$build['search_form'] = drupal_get_form('search_form', NULL, $keys, $info['module']);
$build['search_results'] = $results;
return $build;
}
/**
* Process variables for search-results.tpl.php.
*
* The $variables array contains the following arguments:
* - $results: Search results array.
* - $module: Module the search results came from (module implementing
* hook_search_info()).
*
* @see search-results.tpl.php
*/
function template_preprocess_search_results(&$variables) {
$variables['search_results'] = '';
if (!empty($variables['module'])) {
$variables['module'] = check_plain($variables['module']);
}
foreach ($variables['results'] as $result) {
$variables['search_results'] .= theme('search_result', array('result' => $result, 'module' => $variables['module']));
}
$variables['pager'] = theme('pager', array('tags' => NULL));
$variables['theme_hook_suggestions'][] = 'search_results__' . $variables['module'];
}
/**
* Process variables for search-result.tpl.php.
*
* The $variables array contains the following arguments:
* - $result
* - $module
*
* @see search-result.tpl.php
*/
function template_preprocess_search_result(&$variables) {
global $language;
$result = $variables['result'];
$variables['url'] = check_url($result['link']);
$variables['title'] = check_plain($result['title']);
if (isset($result['language']) && $result['language'] != $language->language && $result['language'] != LANGUAGE_NONE) {
$variables['title_attributes_array']['xml:lang'] = $result['language'];
$variables['content_attributes_array']['xml:lang'] = $result['language'];
}
$info = array();
if (!empty($result['module'])) {
$info['module'] = check_plain($result['module']);
}
if (!empty($result['user'])) {
$info['user'] = $result['user'];
}
if (!empty($result['date'])) {
$info['date'] = format_date($result['date'], 'short');
}
if (isset($result['extra']) && is_array($result['extra'])) {
$info = array_merge($info, $result['extra']);
}
// Check for existence. User search does not include snippets.
$variables['snippet'] = isset($result['snippet']) ? $result['snippet'] : '';
// Provide separated and grouped meta information..
$variables['info_split'] = $info;
$variables['info'] = implode(' - ', $info);
$variables['theme_hook_suggestions'][] = 'search_result__' . $variables['module'];
}
/**
* As the search form collates keys from other modules hooked in via
* hook_form_alter, the validation takes place in _submit.
* search_form_validate() is used solely to set the 'processed_keys' form
* value for the basic search form.
*/
function search_form_validate($form, &$form_state) {
form_set_value($form['basic']['processed_keys'], trim($form_state['values']['keys']), $form_state);
}
/**
* Process a search form submission.
*/
function search_form_submit($form, &$form_state) {
$keys = $form_state['values']['processed_keys'];
if ($keys == '') {
form_set_error('keys', t('Please enter some keywords.'));
// Fall through to the form redirect.
}
$form_state['redirect'] = $form_state['action'] . '/' . $keys;
}
'Search engine queries',
'description' => 'Indexes content and queries it.',
'group' => 'Search',
);
}
/**
* Implementation setUp().
*/
function setUp() {
parent::setUp('search');
}
/**
* Test search indexing.
*/
function testMatching() {
$this->_setup();
$this->_testQueries();
}
/**
* Set up a small index of items to test against.
*/
function _setup() {
variable_set('minimum_word_size', 3);
for ($i = 1; $i <= 7; ++$i) {
search_index($i, SEARCH_TYPE, $this->getText($i));
}
for ($i = 1; $i <= 5; ++$i) {
search_index($i + 7, SEARCH_TYPE_2, $this->getText2($i));
}
// No getText builder function for Japanese text; just a simple array.
foreach (array(
13 => '以呂波耳・ほへとち。リヌルヲ。',
14 => 'ドルーパルが大好きよ！',
15 => 'コーヒーとケーキ',
) as $i => $jpn) {
search_index($i, SEARCH_TYPE_JPN, $jpn);
}
search_update_totals();
}
/**
* _test_: Helper method for generating snippets of content.
*
* Generated items to test against:
* 1 ipsum
* 2 dolore sit
* 3 sit am ut
* 4 am ut enim am
* 5 ut enim am minim veniam
* 6 enim am minim veniam es cillum
* 7 am minim veniam es cillum dolore eu
*/
function getText($n) {
$words = explode(' ', "Ipsum dolore sit am. Ut enim am minim veniam. Es cillum dolore eu.");
return implode(' ', array_slice($words, $n - 1, $n));
}
/**
* _test2_: Helper method for generating snippets of content.
*
* Generated items to test against:
* 8 dear
* 9 king philip
* 10 philip came over
* 11 came over from germany
* 12 over from germany swimming
*/
function getText2($n) {
$words = explode(' ', "Dear King Philip came over from Germany swimming.");
return implode(' ', array_slice($words, $n - 1, $n));
}
/**
* Run predefine queries looking for indexed terms.
*/
function _testQueries() {
/*
Note: OR queries that include short words in OR groups are only accepted
if the ORed terms are ANDed with at least one long word in the rest of the query.
e.g. enim dolore OR ut = enim (dolore OR ut) = (enim dolor) OR (enim ut) -> good
e.g. dolore OR ut = (dolore) OR (ut) -> bad
This is a design limitation to avoid full table scans.
*/
$queries = array(
// Simple AND queries.
'ipsum' => array(1),
'enim' => array(4, 5, 6),
'xxxxx' => array(),
'enim minim' => array(5, 6),
'enim xxxxx' => array(),
'dolore eu' => array(7),
'dolore xx' => array(),
'ut minim' => array(5),
'xx minim' => array(),
'enim veniam am minim ut' => array(5),
// Simple OR queries.
'dolore OR ipsum' => array(1, 2, 7),
'dolore OR xxxxx' => array(2, 7),
'dolore OR ipsum OR enim' => array(1, 2, 4, 5, 6, 7),
'ipsum OR dolore sit OR cillum' => array(2, 7),
'minim dolore OR ipsum' => array(7),
'dolore OR ipsum veniam' => array(7),
'minim dolore OR ipsum OR enim' => array(5, 6, 7),
'dolore xx OR yy' => array(),
'xxxxx dolore OR ipsum' => array(),
// Negative queries.
'dolore -sit' => array(7),
'dolore -eu' => array(2),
'dolore -xxxxx' => array(2, 7),
'dolore -xx' => array(2, 7),
// Phrase queries.
'"dolore sit"' => array(2),
'"sit dolore"' => array(),
'"am minim veniam es"' => array(6, 7),
'"minim am veniam es"' => array(),
// Mixed queries.
'"am minim veniam es" OR dolore' => array(2, 6, 7),
'"minim am veniam es" OR "dolore sit"' => array(2),
'"minim am veniam es" OR "sit dolore"' => array(),
'"am minim veniam es" -eu' => array(6),
'"am minim veniam" -"cillum dolore"' => array(5, 6),
'"am minim veniam" -"dolore cillum"' => array(5, 6, 7),
'xxxxx "minim am veniam es" OR dolore' => array(),
'xx "minim am veniam es" OR dolore' => array()
);
foreach ($queries as $query => $results) {
$result = db_select('search_index', 'i')
->extend('SearchQuery')
->searchExpression($query, SEARCH_TYPE)
->execute();
$set = $result ? $result->fetchAll() : array();
$this->_testQueryMatching($query, $set, $results);
$this->_testQueryScores($query, $set, $results);
}
// These queries are run against the second index type, SEARCH_TYPE_2.
$queries = array(
// Simple AND queries.
'ipsum' => array(),
'enim' => array(),
'enim minim' => array(),
'dear' => array(8),
'germany' => array(11, 12),
);
foreach ($queries as $query => $results) {
$result = db_select('search_index', 'i')
->extend('SearchQuery')
->searchExpression($query, SEARCH_TYPE_2)
->execute();
$set = $result ? $result->fetchAll() : array();
$this->_testQueryMatching($query, $set, $results);
$this->_testQueryScores($query, $set, $results);
}
// These queries are run against the third index type, SEARCH_TYPE_JPN.
$queries = array(
// Simple AND queries.
'呂波耳' => array(13),
'以呂波耳' => array(13),
'ほへと ヌルヲ' => array(13),
'とちリ' => array(),
'ドルーパル' => array(14),
'パルが大' => array(14),
'コーヒー' => array(15),
'ヒーキ' => array(),
);
foreach ($queries as $query => $results) {
$result = db_select('search_index', 'i')
->extend('SearchQuery')
->searchExpression($query, SEARCH_TYPE_JPN)
->execute();
$set = $result ? $result->fetchAll() : array();
$this->_testQueryMatching($query, $set, $results);
$this->_testQueryScores($query, $set, $results);
}
}
/**
* Test the matching abilities of the engine.
*
* Verify if a query produces the correct results.
*/
function _testQueryMatching($query, $set, $results) {
// Get result IDs.
$found = array();
foreach ($set as $item) {
$found[] = $item->sid;
}
// Compare $results and $found.
sort($found);
sort($results);
$this->assertEqual($found, $results, "Query matching '$query'");
}
/**
* Test the scoring abilities of the engine.
*
* Verify if a query produces normalized, monotonous scores.
*/
function _testQueryScores($query, $set, $results) {
// Get result scores.
$scores = array();
foreach ($set as $item) {
$scores[] = $item->calculated_score;
}
// Check order.
$sorted = $scores;
sort($sorted);
$this->assertEqual($scores, array_reverse($sorted), "Query order '$query'");
// Check range.
$this->assertEqual(!count($scores) || (min($scores) > 0.0 && max($scores) <= 1.0001), TRUE, "Query scoring '$query'");
}
}
/**
* Tests the bike shed text on no results page, and text on the search page.
*/
class SearchPageText extends DrupalWebTestCase {
protected $searching_user;
public static function getInfo() {
return array(
'name' => 'Search page text',
'description' => 'Tests the bike shed text on the no results page, and various other text on search pages.',
'group' => 'Search'
);
}
function setUp() {
parent::setUp('search');
// Create user.
$this->searching_user = $this->drupalCreateUser(array('search content', 'access user profiles'));
}
/**
* Tests the failed search text, and various other text on the search page.
*/
function testSearchText() {
$this->drupalLogin($this->searching_user);
$this->drupalGet('search/node');
$this->assertText(t('Enter your keywords'));
$this->assertText(t('Search'));
$title = t('Search') . ' | Drupal';
$this->assertTitle($title, 'Search page title is correct');
$edit = array();
$edit['keys'] = 'bike shed ' . $this->randomName();
$this->drupalPost('search/node', $edit, t('Search'));
$this->assertText(t('Consider loosening your query with OR. bike OR shed will often show more results than bike shed.'), 'Help text is displayed when search returns no results.');
$this->assertText(t('Search'));
$this->assertTitle($title, 'Search page title is correct');
$edit['keys'] = $this->searching_user->name;
$this->drupalPost('search/user', $edit, t('Search'));
$this->assertText(t('Search'));
$this->assertTitle($title, 'Search page title is correct');
// Test that search keywords containing slashes are correctly loaded
// from the path and displayed in the search form.
$arg = $this->randomName() . '/' . $this->randomName();
$this->drupalGet('search/node/' . $arg);
$input = $this->xpath("//input[@id='edit-keys' and @value='{$arg}']");
$this->assertFalse(empty($input), 'Search keys with a / are correctly set as the default value in the search box.');
// Test a search input exceeding the limit of AND/OR combinations to test
// the Denial-of-Service protection.
$limit = variable_get('search_and_or_limit', 7);
$keys = array();
for ($i = 0; $i < $limit + 1; $i++) {
$keys[] = $this->randomName(3);
if ($i % 2 == 0) {
$keys[] = 'OR';
}
}
$edit['keys'] = implode(' ', $keys);
$this->drupalPost('search/node', $edit, t('Search'));
$this->assertRaw(t('Your search used too many AND/OR expressions. Only the first @count terms were included in this search.', array('@count' => $limit)));
}
}
/**
* Indexes content and tests the advanced search form.
*/
class SearchAdvancedSearchForm extends DrupalWebTestCase {
protected $node;
public static function getInfo() {
return array(
'name' => 'Advanced search form',
'description' => 'Indexes content and tests the advanced search form.',
'group' => 'Search',
);
}
function setUp() {
parent::setUp('search');
// Create and login user.
$test_user = $this->drupalCreateUser(array('access content', 'search content', 'use advanced search', 'administer nodes'));
$this->drupalLogin($test_user);
// Create initial node.
$node = $this->drupalCreateNode();
$this->node = $this->drupalCreateNode();
// First update the index. This does the initial processing.
node_update_index();
// Then, run the shutdown function. Testing is a unique case where indexing
// and searching has to happen in the same request, so running the shutdown
// function manually is needed to finish the indexing process.
search_update_totals();
}
/**
* Test using the search form with GET and POST queries.
* Test using the advanced search form to limit search to nodes of type "Basic page".
*/
function testNodeType() {
$this->assertTrue($this->node->type == 'page', 'Node type is Basic page.');
// Assert that the dummy title doesn't equal the real title.
$dummy_title = 'Lorem ipsum';
$this->assertNotEqual($dummy_title, $this->node->title, "Dummy title doesn't equal node title");
// Search for the dummy title with a GET query.
$this->drupalGet('search/node/' . $dummy_title);
$this->assertNoText($this->node->title, 'Basic page node is not found with dummy title.');
// Search for the title of the node with a GET query.
$this->drupalGet('search/node/' . $this->node->title);
$this->assertText($this->node->title, 'Basic page node is found with GET query.');
// Search for the title of the node with a POST query.
$edit = array('or' => $this->node->title);
$this->drupalPost('search/node', $edit, t('Advanced search'));
$this->assertText($this->node->title, 'Basic page node is found with POST query.');
// Advanced search type option.
$this->drupalPost('search/node', array_merge($edit, array('type[page]' => 'page')), t('Advanced search'));
$this->assertText($this->node->title, 'Basic page node is found with POST query and type:page.');
$this->drupalPost('search/node', array_merge($edit, array('type[article]' => 'article')), t('Advanced search'));
$this->assertText('bike shed', 'Article node is not found with POST query and type:article.');
}
}
/**
* Indexes content and tests ranking factors.
*/
class SearchRankingTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Search engine ranking',
'description' => 'Indexes content and tests ranking factors.',
'group' => 'Search',
);
}
/**
* Implementation setUp().
*/
function setUp() {
parent::setUp('search', 'statistics', 'comment');
}
function testRankings() {
// Login with sufficient privileges.
$this->drupalLogin($this->drupalCreateUser(array('skip comment approval', 'create page content')));
// Build a list of the rankings to test.
$node_ranks = array('sticky', 'promote', 'relevance', 'recent', 'comments', 'views');
// Create nodes for testing.
foreach ($node_ranks as $node_rank) {
$settings = array(
'type' => 'page',
'title' => 'Drupal rocks',
'body' => array(LANGUAGE_NONE => array(array('value' => "Drupal's search rocks"))),
);
foreach (array(0, 1) as $num) {
if ($num == 1) {
switch ($node_rank) {
case 'sticky':
case 'promote':
$settings[$node_rank] = 1;
break;
case 'relevance':
$settings['body'][LANGUAGE_NONE][0]['value'] .= " really rocks";
break;
case 'recent':
$settings['created'] = REQUEST_TIME + 3600;
break;
case 'comments':
$settings['comment'] = 2;
break;
}
}
$nodes[$node_rank][$num] = $this->drupalCreateNode($settings);
}
}
// Update the search index.
module_invoke_all('update_index');
search_update_totals();
// Refresh variables after the treatment.
$this->refreshVariables();
// Add a comment to one of the nodes.
$edit = array();
$edit['subject'] = 'my comment title';
$edit['comment_body[' . LANGUAGE_NONE . '][0][value]'] = 'some random comment';
$this->drupalGet('comment/reply/' . $nodes['comments'][1]->nid);
$this->drupalPost(NULL, $edit, t('Preview'));
$this->drupalPost(NULL, $edit, t('Save'));
// Enable counting of statistics.
variable_set('statistics_count_content_views', 1);
// Then View one of the nodes a bunch of times.
for ($i = 0; $i < 5; $i ++) {
$this->drupalGet('node/' . $nodes['views'][1]->nid);
}
// Test each of the possible rankings.
foreach ($node_ranks as $node_rank) {
// Disable all relevancy rankings except the one we are testing.
foreach ($node_ranks as $var) {
variable_set('node_rank_' . $var, $var == $node_rank ? 10 : 0);
}
// Do the search and assert the results.
$set = node_search_execute('rocks');
$this->assertEqual($set[0]['node']->nid, $nodes[$node_rank][1]->nid, 'Search ranking "' . $node_rank . '" order.');
}
}
/**
* Test rankings of HTML tags.
*/
function testHTMLRankings() {
// Login with sufficient privileges.
$this->drupalLogin($this->drupalCreateUser(array('create page content')));
// Test HTML tags with different weights.
$sorted_tags = array('h1', 'h2', 'h3', 'h4', 'a', 'h5', 'h6', 'notag');
$shuffled_tags = $sorted_tags;
// Shuffle tags to ensure HTML tags are ranked properly.
shuffle($shuffled_tags);
$settings = array(
'type' => 'page',
'title' => 'Simple node',
);
foreach ($shuffled_tags as $tag) {
switch ($tag) {
case 'a':
$settings['body'] = array(LANGUAGE_NONE => array(array('value' => l('Drupal Rocks', 'node'), 'format' => 'full_html')));
break;
case 'notag':
$settings['body'] = array(LANGUAGE_NONE => array(array('value' => 'Drupal Rocks')));
break;
default:
$settings['body'] = array(LANGUAGE_NONE => array(array('value' => "<$tag>Drupal Rocks", 'format' => 'full_html')));
break;
}
$nodes[$tag] = $this->drupalCreateNode($settings);
}
// Update the search index.
module_invoke_all('update_index');
search_update_totals();
// Refresh variables after the treatment.
$this->refreshVariables();
// Disable all other rankings.
$node_ranks = array('sticky', 'promote', 'recent', 'comments', 'views');
foreach ($node_ranks as $node_rank) {
variable_set('node_rank_' . $node_rank, 0);
}
$set = node_search_execute('rocks');
// Test the ranking of each tag.
foreach ($sorted_tags as $tag_rank => $tag) {
// Assert the results.
if ($tag == 'notag') {
$this->assertEqual($set[$tag_rank]['node']->nid, $nodes[$tag]->nid, 'Search tag ranking for plain text order.');
} else {
$this->assertEqual($set[$tag_rank]['node']->nid, $nodes[$tag]->nid, 'Search tag ranking for "<' . $sorted_tags[$tag_rank] . '>" order.');
}
}
// Test tags with the same weight against the sorted tags.
$unsorted_tags = array('u', 'b', 'i', 'strong', 'em');
foreach ($unsorted_tags as $tag) {
$settings['body'] = array(LANGUAGE_NONE => array(array('value' => "<$tag>Drupal Rocks", 'format' => 'full_html')));
$node = $this->drupalCreateNode($settings);
// Update the search index.
module_invoke_all('update_index');
search_update_totals();
// Refresh variables after the treatment.
$this->refreshVariables();
$set = node_search_execute('rocks');
// Ranking should always be second to last.
$set = array_slice($set, -2, 1);
// Assert the results.
$this->assertEqual($set[0]['node']->nid, $node->nid, 'Search tag ranking for "<' . $tag . '>" order.');
// Delete node so it doesn't show up in subsequent search results.
node_delete($node->nid);
}
}
/**
* Verifies that if we combine two rankings, search still works.
*
* See issue http://drupal.org/node/771596
*/
function testDoubleRankings() {
// Login with sufficient privileges.
$this->drupalLogin($this->drupalCreateUser(array('skip comment approval', 'create page content')));
// See testRankings() above - build a node that will rank high for sticky.
$settings = array(
'type' => 'page',
'title' => 'Drupal rocks',
'body' => array(LANGUAGE_NONE => array(array('value' => "Drupal's search rocks"))),
'sticky' => 1,
);
$node = $this->drupalCreateNode($settings);
// Update the search index.
module_invoke_all('update_index');
search_update_totals();
// Refresh variables after the treatment.
$this->refreshVariables();
// Set up for ranking sticky and lots of comments; make sure others are
// disabled.
$node_ranks = array('sticky', 'promote', 'relevance', 'recent', 'comments', 'views');
foreach ($node_ranks as $var) {
$value = ($var == 'sticky' || $var == 'comments') ? 10 : 0;
variable_set('node_rank_' . $var, $value);
}
// Do the search and assert the results.
$set = node_search_execute('rocks');
$this->assertEqual($set[0]['node']->nid, $node->nid, 'Search double ranking order.');
}
}
/**
* Tests the rendering of the search block.
*/
class SearchBlockTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Block availability',
'description' => 'Check if the search form block is available.',
'group' => 'Search',
);
}
function setUp() {
parent::setUp('search');
// Create and login user
$admin_user = $this->drupalCreateUser(array('administer blocks', 'search content'));
$this->drupalLogin($admin_user);
}
function testSearchFormBlock() {
// Set block title to confirm that the interface is available.
$this->drupalPost('admin/structure/block/manage/search/form/configure', array('title' => $this->randomName(8)), t('Save block'));
$this->assertText(t('The block configuration has been saved.'), 'Block configuration set.');
// Set the block to a region to confirm block is available.
$edit = array();
$edit['blocks[search_form][region]'] = 'footer';
$this->drupalPost('admin/structure/block', $edit, t('Save blocks'));
$this->assertText(t('The block settings have been updated.'), 'Block successfully move to footer region.');
}
/**
* Test that the search block form works correctly.
*/
function testBlock() {
// Enable the block, and place it in the 'content' region so that it isn't
// hidden on 404 pages.
$edit = array('blocks[search_form][region]' => 'content');
$this->drupalPost('admin/structure/block', $edit, t('Save blocks'));
// Test a normal search via the block form, from the front page.
$terms = array('search_block_form' => 'test');
$this->drupalPost('node', $terms, t('Search'));
$this->assertText('Your search yielded no results');
// Test a search from the block on a 404 page.
$this->drupalGet('foo');
$this->assertResponse(404);
$this->drupalPost(NULL, $terms, t('Search'));
$this->assertResponse(200);
$this->assertText('Your search yielded no results');
// Test a search from the block when it doesn't appear on the search page.
$edit = array('pages' => 'search');
$this->drupalPost('admin/structure/block/manage/search/form/configure', $edit, t('Save block'));
$this->drupalPost('node', $terms, t('Search'));
$this->assertText('Your search yielded no results');
// Confirm that the user is redirected to the search page.
$this->assertEqual(
$this->getUrl(),
url('search/node/' . $terms['search_block_form'], array('absolute' => TRUE)),
'Redirected to correct url.'
);
// Test an empty search via the block form, from the front page.
$terms = array('search_block_form' => '');
$this->drupalPost('node', $terms, t('Search'));
$this->assertText('Please enter some keywords');
// Confirm that the user is redirected to the search page, when form is submitted empty.
$this->assertEqual(
$this->getUrl(),
url('search/node/', array('absolute' => TRUE)),
'Redirected to correct url.'
);
// Test that after entering a too-short keyword in the form, you can then
// search again with a longer keyword. First test using the block form.
$terms = array('search_block_form' => 'a');
$this->drupalPost('node', $terms, t('Search'));
$this->assertText('You must include at least one positive keyword with 3 characters or more');
$terms = array('search_block_form' => 'foo');
$this->drupalPost(NULL, $terms, t('Search'));
$this->assertNoText('You must include at least one positive keyword with 3 characters or more');
$this->assertText('Your search yielded no results');
// Same test again, using the search page form for the second search this time.
$terms = array('search_block_form' => 'a');
$this->drupalPost('node', $terms, t('Search'));
$terms = array('keys' => 'foo');
$this->drupalPost(NULL, $terms, t('Search'));
$this->assertNoText('You must include at least one positive keyword with 3 characters or more');
$this->assertText('Your search yielded no results');
}
}
/**
* Tests that searching for a phrase gets the correct page count.
*/
class SearchExactTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Search engine phrase queries',
'description' => 'Tests that searching for a phrase gets the correct page count.',
'group' => 'Search',
);
}
function setUp() {
parent::setUp('search');
}
/**
* Tests that the correct number of pager links are found for both keywords and phrases.
*/
function testExactQuery() {
// Login with sufficient privileges.
$this->drupalLogin($this->drupalCreateUser(array('create page content', 'search content')));
$settings = array(
'type' => 'page',
'title' => 'Simple Node',
);
// Create nodes with exact phrase.
for ($i = 0; $i <= 17; $i++) {
$settings['body'] = array(LANGUAGE_NONE => array(array('value' => 'love pizza')));
$this->drupalCreateNode($settings);
}
// Create nodes containing keywords.
for ($i = 0; $i <= 17; $i++) {
$settings['body'] = array(LANGUAGE_NONE => array(array('value' => 'love cheesy pizza')));
$this->drupalCreateNode($settings);
}
// Update the search index.
module_invoke_all('update_index');
search_update_totals();
// Refresh variables after the treatment.
$this->refreshVariables();
// Test that the correct number of pager links are found for keyword search.
$edit = array('keys' => 'love pizza');
$this->drupalPost('search/node', $edit, t('Search'));
$this->assertLinkByHref('page=1', 0, '2nd page link is found for keyword search.');
$this->assertLinkByHref('page=2', 0, '3rd page link is found for keyword search.');
$this->assertLinkByHref('page=3', 0, '4th page link is found for keyword search.');
$this->assertNoLinkByHref('page=4', '5th page link is not found for keyword search.');
// Test that the correct number of pager links are found for exact phrase search.
$edit = array('keys' => '"love pizza"');
$this->drupalPost('search/node', $edit, t('Search'));
$this->assertLinkByHref('page=1', 0, '2nd page link is found for exact phrase search.');
$this->assertNoLinkByHref('page=2', '3rd page link is not found for exact phrase search.');
}
}
/**
* Test integration searching comments.
*/
class SearchCommentTestCase extends DrupalWebTestCase {
protected $admin_user;
protected $comment_subject;
protected $admin_role;
protected $node;
public static function getInfo() {
return array(
'name' => 'Comment Search tests',
'description' => 'Test integration searching comments.',
'group' => 'Search',
);
}
function setUp() {
parent::setUp('comment', 'search');
// Create and log in an administrative user having access to the Full HTML
// text format.
$full_html_format = filter_format_load('full_html');
$permissions = array(
'administer filters',
filter_permission_name($full_html_format),
'administer permissions',
'create page content',
'skip comment approval',
'access comments',
);
$this->admin_user = $this->drupalCreateUser($permissions);
$this->drupalLogin($this->admin_user);
}
/**
* Verify that comments are rendered using proper format in search results.
*/
function testSearchResultsComment() {
$comment_body = 'Test comment body';
variable_set('comment_preview_article', DRUPAL_OPTIONAL);
// Enable check_plain() for 'Filtered HTML' text format.
$filtered_html_format_id = 'filtered_html';
$edit = array(
'filters[filter_html_escape][status]' => TRUE,
);
$this->drupalPost('admin/config/content/formats/' . $filtered_html_format_id, $edit, t('Save configuration'));
// Allow anonymous users to search content.
$edit = array(
DRUPAL_ANONYMOUS_RID . '[search content]' => 1,
DRUPAL_ANONYMOUS_RID . '[access comments]' => 1,
DRUPAL_ANONYMOUS_RID . '[post comments]' => 1,
);
$this->drupalPost('admin/people/permissions', $edit, t('Save permissions'));
// Create a node.
$node = $this->drupalCreateNode(array('type' => 'article'));
// Post a comment using 'Full HTML' text format.
$edit_comment = array();
$edit_comment['subject'] = 'Test comment subject';
$edit_comment['comment_body[' . LANGUAGE_NONE . '][0][value]'] = '' . $comment_body . ' ';
$full_html_format_id = 'full_html';
$edit_comment['comment_body[' . LANGUAGE_NONE . '][0][format]'] = $full_html_format_id;
$this->drupalPost('comment/reply/' . $node->nid, $edit_comment, t('Save'));
// Invoke search index update.
$this->drupalLogout();
$this->cronRun();
// Search for the comment subject.
$edit = array(
'search_block_form' => "'" . $edit_comment['subject'] . "'",
);
$this->drupalPost('', $edit, t('Search'));
$this->assertText($node->title, 'Node found in search results.');
$this->assertText($edit_comment['subject'], 'Comment subject found in search results.');
// Search for the comment body.
$edit = array(
'search_block_form' => "'" . $comment_body . "'",
);
$this->drupalPost('', $edit, t('Search'));
$this->assertText($node->title, 'Node found in search results.');
// Verify that comment is rendered using proper format.
$this->assertText($comment_body, 'Comment body text found in search results.');
$this->assertNoRaw(t('n/a'), 'HTML in comment body is not hidden.');
$this->assertNoRaw(check_plain($edit_comment['comment_body[' . LANGUAGE_NONE . '][0][value]']), 'HTML in comment body is not escaped.');
// Hide comments.
$this->drupalLogin($this->admin_user);
$node->comment = 0;
node_save($node);
// Invoke search index update.
$this->drupalLogout();
$this->cronRun();
// Search for $title.
$this->drupalPost('', $edit, t('Search'));
$this->assertNoText($comment_body, 'Comment body text not found in search results.');
}
/**
* Verify access rules for comment indexing with different permissions.
*/
function testSearchResultsCommentAccess() {
$comment_body = 'Test comment body';
$this->comment_subject = 'Test comment subject';
$this->admin_role = $this->admin_user->roles;
unset($this->admin_role[DRUPAL_AUTHENTICATED_RID]);
$this->admin_role = key($this->admin_role);
// Create a node.
variable_set('comment_preview_article', DRUPAL_OPTIONAL);
$this->node = $this->drupalCreateNode(array('type' => 'article'));
// Post a comment using 'Full HTML' text format.
$edit_comment = array();
$edit_comment['subject'] = $this->comment_subject;
$edit_comment['comment_body[' . LANGUAGE_NONE . '][0][value]'] = '' . $comment_body . ' ';
$this->drupalPost('comment/reply/' . $this->node->nid, $edit_comment, t('Save'));
$this->drupalLogout();
$this->setRolePermissions(DRUPAL_ANONYMOUS_RID);
$this->checkCommentAccess('Anon user has search permission but no access comments permission, comments should not be indexed');
$this->setRolePermissions(DRUPAL_ANONYMOUS_RID, TRUE);
$this->checkCommentAccess('Anon user has search permission and access comments permission, comments should be indexed', TRUE);
$this->drupalLogin($this->admin_user);
$this->drupalGet('admin/people/permissions');
// Disable search access for authenticated user to test admin user.
$this->setRolePermissions(DRUPAL_AUTHENTICATED_RID, FALSE, FALSE);
$this->setRolePermissions($this->admin_role);
$this->checkCommentAccess('Admin user has search permission but no access comments permission, comments should not be indexed');
$this->setRolePermissions($this->admin_role, TRUE);
$this->checkCommentAccess('Admin user has search permission and access comments permission, comments should be indexed', TRUE);
$this->setRolePermissions(DRUPAL_AUTHENTICATED_RID);
$this->checkCommentAccess('Authenticated user has search permission but no access comments permission, comments should not be indexed');
$this->setRolePermissions(DRUPAL_AUTHENTICATED_RID, TRUE);
$this->checkCommentAccess('Authenticated user has search permission and access comments permission, comments should be indexed', TRUE);
// Verify that access comments permission is inherited from the
// authenticated role.
$this->setRolePermissions(DRUPAL_AUTHENTICATED_RID, TRUE, FALSE);
$this->setRolePermissions($this->admin_role);
$this->checkCommentAccess('Admin user has search permission and no access comments permission, but comments should be indexed because admin user inherits authenticated user\'s permission to access comments', TRUE);
// Verify that search content permission is inherited from the authenticated
// role.
$this->setRolePermissions(DRUPAL_AUTHENTICATED_RID, TRUE, TRUE);
$this->setRolePermissions($this->admin_role, TRUE, FALSE);
$this->checkCommentAccess('Admin user has access comments permission and no search permission, but comments should be indexed because admin user inherits authenticated user\'s permission to search', TRUE);
}
/**
* Set permissions for role.
*/
function setRolePermissions($rid, $access_comments = FALSE, $search_content = TRUE) {
$permissions = array(
'access comments' => $access_comments,
'search content' => $search_content,
);
user_role_change_permissions($rid, $permissions);
}
/**
* Update search index and search for comment.
*/
function checkCommentAccess($message, $assume_access = FALSE) {
// Invoke search index update.
search_touch_node($this->node->nid);
$this->cronRun();
// Search for the comment subject.
$edit = array(
'search_block_form' => "'" . $this->comment_subject . "'",
);
$this->drupalPost('', $edit, t('Search'));
$method = $assume_access ? 'assertText' : 'assertNoText';
$verb = $assume_access ? 'found' : 'not found';
$this->{$method}($this->node->title, "Node $verb in search results: " . $message);
$this->{$method}($this->comment_subject, "Comment subject $verb in search results: " . $message);
}
/**
* Verify that 'add new comment' does not appear in search results or index.
*/
function testAddNewComment() {
// Create a node with a short body.
$settings = array(
'type' => 'article',
'title' => 'short title',
'body' => array(LANGUAGE_NONE => array(array('value' => 'short body text'))),
);
$user = $this->drupalCreateUser(array('search content', 'create article content', 'access content'));
$this->drupalLogin($user);
$node = $this->drupalCreateNode($settings);
// Verify that if you view the node on its own page, 'add new comment'
// is there.
$this->drupalGet('node/' . $node->nid);
$this->assertText(t('Add new comment'), 'Add new comment appears on node page');
// Run cron to index this page.
$this->drupalLogout();
$this->cronRun();
// Search for 'comment'. Should be no results.
$this->drupalLogin($user);
$this->drupalPost('search/node', array('keys' => 'comment'), t('Search'));
$this->assertText(t('Your search yielded no results'), 'No results searching for the word comment');
// Search for the node title. Should be found, and 'Add new comment' should
// not be part of the search snippet.
$this->drupalPost('search/node', array('keys' => 'short'), t('Search'));
$this->assertText($node->title, 'Search for keyword worked');
$this->assertNoText(t('Add new comment'), 'Add new comment does not appear on search results page');
}
}
/**
* Tests search_expression_insert() and search_expression_extract().
*
* @see http://drupal.org/node/419388 (issue)
*/
class SearchExpressionInsertExtractTestCase extends DrupalUnitTestCase {
public static function getInfo() {
return array(
'name' => 'Search expression insert/extract',
'description' => 'Tests the functions search_expression_insert() and search_expression_extract()',
'group' => 'Search',
);
}
function setUp() {
drupal_load('module', 'search');
parent::setUp();
}
/**
* Tests search_expression_insert() and search_expression_extract().
*/
function testInsertExtract() {
$base_expression = "mykeyword";
// Build an array of option, value, what should be in the expression, what
// should be retrieved from expression.
$cases = array(
array('foo', 'bar', 'foo:bar', 'bar'), // Normal case.
array('foo', NULL, '', NULL), // Empty value: shouldn't insert.
array('foo', ' ', 'foo:', ''), // Space as value: should insert but retrieve empty string.
array('foo', '', 'foo:', ''), // Empty string as value: should insert but retrieve empty string.
array('foo', '0', 'foo:0', '0'), // String zero as value: should insert.
array('foo', 0, 'foo:0', '0'), // Numeric zero as value: should insert.
);
foreach ($cases as $index => $case) {
$after_insert = search_expression_insert($base_expression, $case[0], $case[1]);
if (empty($case[2])) {
$this->assertEqual($after_insert, $base_expression, "Empty insert does not change expression in case $index");
}
else {
$this->assertEqual($after_insert, $base_expression . ' ' . $case[2], "Insert added correct expression for case $index");
}
$retrieved = search_expression_extract($after_insert, $case[0]);
if (!isset($case[3])) {
$this->assertFalse(isset($retrieved), "Empty retrieval results in unset value in case $index");
}
else {
$this->assertEqual($retrieved, $case[3], "Value is retrieved for case $index");
}
$after_clear = search_expression_insert($after_insert, $case[0]);
$this->assertEqual(trim($after_clear), $base_expression, "After clearing, base expression is restored for case $index");
$cleared = search_expression_extract($after_clear, $case[0]);
$this->assertFalse(isset($cleared), "After clearing, value could not be retrieved for case $index");
}
}
}
/**
* Tests that comment count display toggles properly on comment status of node
*
* Issue 537278
*
* - Nodes with comment status set to Open should always how comment counts
* - Nodes with comment status set to Closed should show comment counts
* only when there are comments
* - Nodes with comment status set to Hidden should never show comment counts
*/
class SearchCommentCountToggleTestCase extends DrupalWebTestCase {
protected $searching_user;
protected $searchable_nodes;
public static function getInfo() {
return array(
'name' => 'Comment count toggle',
'description' => 'Verify that comment count display toggles properly on comment status of node.',
'group' => 'Search',
);
}
function setUp() {
parent::setUp('search');
// Create searching user.
$this->searching_user = $this->drupalCreateUser(array('search content', 'access content', 'access comments', 'skip comment approval'));
// Create initial nodes.
$node_params = array('type' => 'article', 'body' => array(LANGUAGE_NONE => array(array('value' => 'SearchCommentToggleTestCase'))));
$this->searchable_nodes['1 comment'] = $this->drupalCreateNode($node_params);
$this->searchable_nodes['0 comments'] = $this->drupalCreateNode($node_params);
// Login with sufficient privileges.
$this->drupalLogin($this->searching_user);
// Create a comment array
$edit_comment = array();
$edit_comment['subject'] = $this->randomName();
$edit_comment['comment_body[' . LANGUAGE_NONE . '][0][value]'] = $this->randomName();
$filtered_html_format_id = 'filtered_html';
$edit_comment['comment_body[' . LANGUAGE_NONE . '][0][format]'] = $filtered_html_format_id;
// Post comment to the test node with comment
$this->drupalPost('comment/reply/' . $this->searchable_nodes['1 comment']->nid, $edit_comment, t('Save'));
// First update the index. This does the initial processing.
node_update_index();
// Then, run the shutdown function. Testing is a unique case where indexing
// and searching has to happen in the same request, so running the shutdown
// function manually is needed to finish the indexing process.
search_update_totals();
}
/**
* Verify that comment count display toggles properly on comment status of node
*/
function testSearchCommentCountToggle() {
// Search for the nodes by string in the node body.
$edit = array(
'search_block_form' => "'SearchCommentToggleTestCase'",
);
// Test comment count display for nodes with comment status set to Open
$this->drupalPost('', $edit, t('Search'));
$this->assertText(t('0 comments'), 'Empty comment count displays for nodes with comment status set to Open');
$this->assertText(t('1 comment'), 'Non-empty comment count displays for nodes with comment status set to Open');
// Test comment count display for nodes with comment status set to Closed
$this->searchable_nodes['0 comments']->comment = COMMENT_NODE_CLOSED;
node_save($this->searchable_nodes['0 comments']);
$this->searchable_nodes['1 comment']->comment = COMMENT_NODE_CLOSED;
node_save($this->searchable_nodes['1 comment']);
$this->drupalPost('', $edit, t('Search'));
$this->assertNoText(t('0 comments'), 'Empty comment count does not display for nodes with comment status set to Closed');
$this->assertText(t('1 comment'), 'Non-empty comment count displays for nodes with comment status set to Closed');
// Test comment count display for nodes with comment status set to Hidden
$this->searchable_nodes['0 comments']->comment = COMMENT_NODE_HIDDEN;
node_save($this->searchable_nodes['0 comments']);
$this->searchable_nodes['1 comment']->comment = COMMENT_NODE_HIDDEN;
node_save($this->searchable_nodes['1 comment']);
$this->drupalPost('', $edit, t('Search'));
$this->assertNoText(t('0 comments'), 'Empty comment count does not display for nodes with comment status set to Hidden');
$this->assertNoText(t('1 comment'), 'Non-empty comment count does not display for nodes with comment status set to Hidden');
}
}
/**
* Test search_simplify() on every Unicode character, and some other cases.
*/
class SearchSimplifyTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Search simplify',
'description' => 'Check that the search_simply() function works as intended.',
'group' => 'Search',
);
}
/**
* Tests that all Unicode characters simplify correctly.
*/
function testSearchSimplifyUnicode() {
// This test uses a file that was constructed so that the even lines are
// boundary characters, and the odd lines are valid word characters. (It
// was generated as a sequence of all the Unicode characters, and then the
// boundary chararacters (punctuation, spaces, etc.) were split off into
// their own lines). So the even-numbered lines should simplify to nothing,
// and the odd-numbered lines we need to split into shorter chunks and
// verify that simplification doesn't lose any characters.
$input = file_get_contents(DRUPAL_ROOT . '/modules/search/tests/UnicodeTest.txt');
$basestrings = explode(chr(10), $input);
$strings = array();
foreach ($basestrings as $key => $string) {
if ($key %2) {
// Even line - should simplify down to a space.
$simplified = search_simplify($string);
$this->assertIdentical($simplified, ' ', "Line $key is excluded from the index");
}
else {
// Odd line, should be word characters.
// Split this into 30-character chunks, so we don't run into limits
// of truncation in search_simplify().
$start = 0;
while ($start < drupal_strlen($string)) {
$newstr = drupal_substr($string, $start, 30);
// Special case: leading zeros are removed from numeric strings,
// and there's one string in this file that is numbers starting with
// zero, so prepend a 1 on that string.
if (preg_match('/^[0-9]+$/', $newstr)) {
$newstr = '1' . $newstr;
}
$strings[] = $newstr;
$start += 30;
}
}
}
foreach ($strings as $key => $string) {
$simplified = search_simplify($string);
$this->assertTrue(drupal_strlen($simplified) >= drupal_strlen($string), "Nothing is removed from string $key.");
}
// Test the low-numbered ASCII control characters separately. They are not
// in the text file because they are problematic for diff, especially \0.
$string = '';
for ($i = 0; $i < 32; $i++) {
$string .= chr($i);
}
$this->assertIdentical(' ', search_simplify($string), 'Search simplify works for ASCII control characters.');
}
/**
* Tests that search_simplify() does the right thing with punctuation.
*/
function testSearchSimplifyPunctuation() {
$cases = array(
array('20.03/94-28,876', '20039428876', 'Punctuation removed from numbers'),
array('great...drupal--module', 'great drupal module', 'Multiple dot and dashes are word boundaries'),
array('very_great-drupal.module', 'verygreatdrupalmodule', 'Single dot, dash, underscore are removed'),
array('regular,punctuation;word', 'regular punctuation word', 'Punctuation is a word boundary'),
);
foreach ($cases as $case) {
$out = trim(search_simplify($case[0]));
$this->assertEqual($out, $case[1], $case[2]);
}
}
}
/**
* Tests keywords and conditions.
*/
class SearchKeywordsConditions extends DrupalWebTestCase {
protected $searching_user;
public static function getInfo() {
return array(
'name' => 'Keywords and conditions',
'description' => 'Verify the search pulls in keywords and extra conditions.',
'group' => 'Search',
);
}
function setUp() {
parent::setUp('search', 'search_extra_type');
// Create searching user.
$this->searching_user = $this->drupalCreateUser(array('search content', 'access content', 'access comments', 'skip comment approval'));
// Login with sufficient privileges.
$this->drupalLogin($this->searching_user);
// Test with all search modules enabled.
variable_set('search_active_modules', array('node' => 'node', 'user' => 'user', 'search_extra_type' => 'search_extra_type'));
menu_rebuild();
}
/**
* Verify the kewords are captured and conditions respected.
*/
function testSearchKeyswordsConditions() {
// No keys, not conditions - no results.
$this->drupalGet('search/dummy_path');
$this->assertNoText('Dummy search snippet to display');
// With keys - get results.
$keys = 'bike shed ' . $this->randomName();
$this->drupalGet("search/dummy_path/{$keys}");
$this->assertText("Dummy search snippet to display. Keywords: {$keys}");
$keys = 'blue drop ' . $this->randomName();
$this->drupalGet("search/dummy_path", array('query' => array('keys' => $keys)));
$this->assertText("Dummy search snippet to display. Keywords: {$keys}");
// Add some conditions and keys.
$keys = 'moving drop ' . $this->randomName();
$this->drupalGet("search/dummy_path/bike", array('query' => array('search_conditions' => $keys)));
$this->assertText("Dummy search snippet to display.");
$this->assertRaw(print_r(array('search_conditions' => $keys), TRUE));
// Add some conditions and no keys.
$keys = 'drop kick ' . $this->randomName();
$this->drupalGet("search/dummy_path", array('query' => array('search_conditions' => $keys)));
$this->assertText("Dummy search snippet to display.");
$this->assertRaw(print_r(array('search_conditions' => $keys), TRUE));
}
}
/**
* Tests that numbers can be searched.
*/
class SearchNumbersTestCase extends DrupalWebTestCase {
protected $test_user;
protected $numbers;
protected $nodes;
public static function getInfo() {
return array(
'name' => 'Search numbers',
'description' => 'Check that numbers can be searched',
'group' => 'Search',
);
}
function setUp() {
parent::setUp('search');
$this->test_user = $this->drupalCreateUser(array('search content', 'access content', 'administer nodes', 'access site reports'));
$this->drupalLogin($this->test_user);
// Create content with various numbers in it.
// Note: 50 characters is the current limit of the search index's word
// field.
$this->numbers = array(
'ISBN' => '978-0446365383',
'UPC' => '036000 291452',
'EAN bar code' => '5901234123457',
'negative' => '-123456.7890',
'quoted negative' => '"-123456.7890"',
'leading zero' => '0777777777',
'tiny' => '111',
'small' => '22222222222222',
'medium' => '333333333333333333333333333',
'large' => '444444444444444444444444444444444444444',
'gigantic' => '5555555555555555555555555555555555555555555555555',
'over fifty characters' => '666666666666666666666666666666666666666666666666666666666666',
'date', '01/02/2009',
'commas', '987,654,321',
);
foreach ($this->numbers as $doc => $num) {
$info = array(
'body' => array(LANGUAGE_NONE => array(array('value' => $num))),
'type' => 'page',
'language' => LANGUAGE_NONE,
'title' => $doc . ' number',
);
$this->nodes[$doc] = $this->drupalCreateNode($info);
}
// Run cron to ensure the content is indexed.
$this->cronRun();
$this->drupalGet('admin/reports/dblog');
$this->assertText(t('Cron run completed'), 'Log shows cron run completed');
}
/**
* Tests that all the numbers can be searched.
*/
function testNumberSearching() {
$types = array_keys($this->numbers);
foreach ($types as $type) {
$number = $this->numbers[$type];
// If the number is negative, remove the - sign, because - indicates
// "not keyword" when searching.
$number = ltrim($number, '-');
$node = $this->nodes[$type];
// Verify that the node title does not appear on the search page
// with a dummy search.
$this->drupalPost('search/node',
array('keys' => 'foo'),
t('Search'));
$this->assertNoText($node->title, $type . ': node title not shown in dummy search');
// Verify that the node title does appear as a link on the search page
// when searching for the number.
$this->drupalPost('search/node',
array('keys' => $number),
t('Search'));
$this->assertText($node->title, format_string('%type: node title shown (search found the node) in search for number %number.', array('%type' => $type, '%number' => $number)));
}
}
}
/**
* Tests that numbers can be searched, with more complex matching.
*/
class SearchNumberMatchingTestCase extends DrupalWebTestCase {
protected $test_user;
protected $numbers;
protected $nodes;
public static function getInfo() {
return array(
'name' => 'Search number matching',
'description' => 'Check that numbers can be searched with more complex matching',
'group' => 'Search',
);
}
function setUp() {
parent::setUp('search');
$this->test_user = $this->drupalCreateUser(array('search content', 'access content', 'administer nodes', 'access site reports'));
$this->drupalLogin($this->test_user);
// Define a group of numbers that should all match each other --
// numbers with internal punctuation should match each other, as well
// as numbers with and without leading zeros and leading/trailing
// . and -.
$this->numbers = array(
'123456789',
'12/34/56789',
'12.3456789',
'12-34-56789',
'123,456,789',
'-123456789',
'0123456789',
);
foreach ($this->numbers as $num) {
$info = array(
'body' => array(LANGUAGE_NONE => array(array('value' => $num))),
'type' => 'page',
'language' => LANGUAGE_NONE,
);
$this->nodes[] = $this->drupalCreateNode($info);
}
// Run cron to ensure the content is indexed.
$this->cronRun();
$this->drupalGet('admin/reports/dblog');
$this->assertText(t('Cron run completed'), 'Log shows cron run completed');
}
/**
* Tests that all the numbers can be searched.
*/
function testNumberSearching() {
for ($i = 0; $i < count($this->numbers); $i++) {
$node = $this->nodes[$i];
// Verify that the node title does not appear on the search page
// with a dummy search.
$this->drupalPost('search/node',
array('keys' => 'foo'),
t('Search'));
$this->assertNoText($node->title, format_string('%number: node title not shown in dummy search', array('%number' => $i)));
// Now verify that we can find node i by searching for any of the
// numbers.
for ($j = 0; $j < count($this->numbers); $j++) {
$number = $this->numbers[$j];
// If the number is negative, remove the - sign, because - indicates
// "not keyword" when searching.
$number = ltrim($number, '-');
$this->drupalPost('search/node',
array('keys' => $number),
t('Search'));
$this->assertText($node->title, format_string('%i: node title shown (search found the node) in search for number %number', array('%i' => $i, '%number' => $number)));
}
}
}
}
/**
* Test config page.
*/
class SearchConfigSettingsForm extends DrupalWebTestCase {
public $search_user;
public $search_node;
public static function getInfo() {
return array(
'name' => 'Config settings form',
'description' => 'Verify the search config settings form.',
'group' => 'Search',
);
}
function setUp() {
parent::setUp('search', 'search_extra_type');
// Login as a user that can create and search content.
$this->search_user = $this->drupalCreateUser(array('search content', 'administer search', 'administer nodes', 'bypass node access', 'access user profiles', 'administer users', 'administer blocks', 'access site reports'));
$this->drupalLogin($this->search_user);
// Add a single piece of content and index it.
$node = $this->drupalCreateNode();
$this->search_node = $node;
// Link the node to itself to test that it's only indexed once. The content
// also needs the word "pizza" so we can use it as the search keyword.
$langcode = LANGUAGE_NONE;
$body_key = "body[$langcode][0][value]";
$edit[$body_key] = l($node->title, 'node/' . $node->nid) . ' pizza sandwich';
$this->drupalPost('node/' . $node->nid . '/edit', $edit, t('Save'));
node_update_index();
search_update_totals();
// Enable the search block.
$edit = array();
$edit['blocks[search_form][region]'] = 'content';
$this->drupalPost('admin/structure/block', $edit, t('Save blocks'));
}
/**
* Verify the search settings form.
*/
function testSearchSettingsPage() {
// Test that the settings form displays the correct count of items left to index.
$this->drupalGet('admin/config/search/settings');
$this->assertText(t('There are @count items left to index.', array('@count' => 0)));
// Test the re-index button.
$this->drupalPost('admin/config/search/settings', array(), t('Re-index site'));
$this->assertText(t('Are you sure you want to re-index the site'));
$this->drupalPost('admin/config/search/settings/reindex', array(), t('Re-index site'));
$this->assertText(t('The index will be rebuilt'));
$this->drupalGet('admin/config/search/settings');
$this->assertText(t('There is 1 item left to index.'));
// Test that the form saves with the default values.
$this->drupalPost('admin/config/search/settings', array(), t('Save configuration'));
$this->assertText(t('The configuration options have been saved.'), 'Form saves with the default values.');
// Test that the form does not save with an invalid word length.
$edit = array(
'minimum_word_size' => $this->randomName(3),
);
$this->drupalPost('admin/config/search/settings', $edit, t('Save configuration'));
$this->assertNoText(t('The configuration options have been saved.'), 'Form does not save with an invalid word length.');
// Test logging setting. It should be on by default.
$text = $this->randomName(5);
$this->drupalPost('search/node', array('keys' => $text), t('Search'));
$this->drupalGet('admin/reports/dblog');
$this->assertLink('Searched Content for ' . $text . '.', 0, 'Search was logged');
// Turn off logging.
variable_set('search_logging', FALSE);
$text = $this->randomName(5);
$this->drupalPost('search/node', array('keys' => $text), t('Search'));
$this->drupalGet('admin/reports/dblog');
$this->assertNoLink('Searched Content for ' . $text . '.', 'Search was not logged');
}
/**
* Verify that you can disable individual search modules.
*/
function testSearchModuleDisabling() {
// Array of search modules to test: 'path' is the search path, 'title' is
// the tab title, 'keys' are the keywords to search for, and 'text' is
// the text to assert is on the results page.
$module_info = array(
'node' => array(
'path' => 'node',
'title' => 'Content',
'keys' => 'pizza',
'text' => $this->search_node->title,
),
'user' => array(
'path' => 'user',
'title' => 'User',
'keys' => $this->search_user->name,
'text' => $this->search_user->mail,
),
'search_extra_type' => array(
'path' => 'dummy_path',
'title' => 'Dummy search type',
'keys' => 'foo',
'text' => 'Dummy search snippet to display',
),
);
$modules = array_keys($module_info);
// Test each module if it's enabled as the only search module.
foreach ($modules as $module) {
// Enable the one module and disable other ones.
$info = $module_info[$module];
$edit = array();
foreach ($modules as $other) {
$edit['search_active_modules[' . $other . ']'] = (($other == $module) ? $module : FALSE);
}
$edit['search_default_module'] = $module;
$this->drupalPost('admin/config/search/settings', $edit, t('Save configuration'));
// Run a search from the correct search URL.
$this->drupalGet('search/' . $info['path'] . '/' . $info['keys']);
$this->assertNoText('no results', $info['title'] . ' search found results');
$this->assertText($info['text'], 'Correct search text found');
// Verify that other module search tab titles are not visible.
foreach ($modules as $other) {
if ($other != $module) {
$title = $module_info[$other]['title'];
$this->assertNoText($title, $title . ' search tab is not shown');
}
}
// Run a search from the search block on the node page. Verify you get
// to this module's search results page.
$terms = array('search_block_form' => $info['keys']);
$this->drupalPost('node', $terms, t('Search'));
$this->assertEqual(
$this->getURL(),
url('search/' . $info['path'] . '/' . $info['keys'], array('absolute' => TRUE)),
'Block redirected to right search page');
// Try an invalid search path. Should redirect to our active module.
$this->drupalGet('search/not_a_module_path');
$this->assertEqual(
$this->getURL(),
url('search/' . $info['path'], array('absolute' => TRUE)),
'Invalid search path redirected to default search page');
}
// Test with all search modules enabled. When you go to the search
// page or run search, all modules should be shown.
$edit = array();
foreach ($modules as $module) {
$edit['search_active_modules[' . $module . ']'] = $module;
}
$edit['search_default_module'] = 'node';
$this->drupalPost('admin/config/search/settings', $edit, t('Save configuration'));
foreach (array('search/node/pizza', 'search/node') as $path) {
$this->drupalGet($path);
foreach ($modules as $module) {
$title = $module_info[$module]['title'];
$this->assertText($title, format_string('%title search tab is shown', array('%title' => $title)));
}
}
}
}
/**
* Tests the search_excerpt() function.
*/
class SearchExcerptTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Search excerpt extraction',
'description' => 'Tests that the search_excerpt() function works.',
'group' => 'Search',
);
}
function setUp() {
parent::setUp('search');
}
/**
* Tests search_excerpt() with several simulated search keywords.
*
* Passes keywords and a sample marked up string, "The quick
* brown fox jumps over the lazy dog", and compares it to the
* correctly marked up string. The correctly marked up string
* contains either highlighted keywords or the original marked
* up string if no keywords matched the string.
*/
function testSearchExcerpt() {
// Make some text with entities and tags.
$text = 'The quick brown fox & jumps over the lazy dog';
// Note: The search_excerpt() function adds some extra spaces -- not
// important for HTML formatting. Remove these for comparison.
$expected = 'The quick brown fox & jumps over the lazy dog';
$result = preg_replace('| +|', ' ', search_excerpt('nothing', $text));
$this->assertEqual(preg_replace('| +|', ' ', $result), $expected, 'Entire string is returned when keyword is not found in short string');
$result = preg_replace('| +|', ' ', search_excerpt('fox', $text));
$this->assertEqual($result, 'The quick brown fox & jumps over the lazy dog ...', 'Found keyword is highlighted');
$longtext = str_repeat($text . ' ', 10);
$result = preg_replace('| +|', ' ', search_excerpt('nothing', $longtext));
$this->assertTrue(strpos($result, $expected) === 0, 'When keyword is not found in long string, return value starts as expected');
$entities = str_repeat('készítése ', 20);
$result = preg_replace('| +|', ' ', search_excerpt('nothing', $entities));
$this->assertFalse(strpos($result, '&'), 'Entities are not present in excerpt');
$this->assertTrue(strpos($result, 'í') > 0, 'Entities are converted in excerpt');
// The node body that will produce this rendered $text is:
// 123456789 HTMLTest +123456789+‘ +‘ +‘ +‘ +12345678 +‘ +‘ +‘ ‘
$text = "123456789 HTMLTest +123456789+‘ +‘ +‘ +‘ +12345678 +‘ +‘ +‘ ‘
\n
123456.7890 ') !== FALSE, 'Numeric keyword is highlighted with exact match');
$result = preg_replace('| +|', ' ', search_excerpt('1234567890', $text));
$this->assertTrue(strpos($result, 'Number: 123456.7890 ') !== FALSE, 'Numeric keyword is highlighted with simplified match');
$result = preg_replace('| +|', ' ', search_excerpt('Number 1234567890', $text));
$this->assertTrue(strpos($result, 'Number : 123456.7890 ') !== FALSE, 'Punctuated and numeric keyword is highlighted with simplified match');
$result = preg_replace('| +|', ' ', search_excerpt('"Number 1234567890"', $text));
$this->assertTrue(strpos($result, 'Number: 123456.7890 ') !== FALSE, 'Phrase with punctuated and numeric keyword is highlighted with simplified match');
$result = preg_replace('| +|', ' ', search_excerpt('"Hyphenated onetwo"', $text));
$this->assertTrue(strpos($result, 'Hyphenated: one-two ') !== FALSE, 'Phrase with punctuated and hyphenated keyword is highlighted with simplified match');
$result = preg_replace('| +|', ' ', search_excerpt('"abc def"', $text));
$this->assertTrue(strpos($result, 'abc,def ') !== FALSE, 'Phrase with keyword simplified into two separate words is highlighted with simplified match');
// Test phrases with characters which are being truncated.
$result = preg_replace('| +|', ' ', search_excerpt('"ipsum _"', $text));
$this->assertTrue(strpos($result, 'ipsum ') !== FALSE, 'Only valid part of the phrase is highlighted and invalid part containing "_" is ignored.');
$result = preg_replace('| +|', ' ', search_excerpt('"ipsum 0000"', $text));
$this->assertTrue(strpos($result, 'ipsum ') !== FALSE, 'Only valid part of the phrase is highlighted and invalid part "0000" is ignored.');
// Test combination of the valid keyword and keyword containing only
// characters which are being truncated during simplification.
$result = preg_replace('| +|', ' ', search_excerpt('ipsum _', $text));
$this->assertTrue(strpos($result, 'ipsum ') !== FALSE, 'Only valid keyword is highlighted and invalid keyword "_" is ignored.');
$result = preg_replace('| +|', ' ', search_excerpt('ipsum 0000', $text));
$this->assertTrue(strpos($result, 'ipsum ') !== FALSE, 'Only valid keyword is highlighted and invalid keyword "0000" is ignored.');
}
}
/**
* Test the CJK tokenizer.
*/
class SearchTokenizerTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'CJK tokenizer',
'description' => 'Check that CJK tokenizer works as intended.',
'group' => 'Search',
);
}
function setUp() {
parent::setUp('search');
}
/**
* Verifies that strings of CJK characters are tokenized.
*
* The search_simplify() function does special things with numbers, symbols,
* and punctuation. So we only test that CJK characters that are not in these
* character classes are tokenized properly. See PREG_CLASS_CKJ for more
* information.
*/
function testTokenizer() {
// Set the minimum word size to 1 (to split all CJK characters) and make
// sure CJK tokenizing is turned on.
variable_set('minimum_word_size', 1);
variable_set('overlap_cjk', TRUE);
$this->refreshVariables();
// Create a string of CJK characters from various character ranges in
// the Unicode tables.
// Beginnings of the character ranges.
$starts = array(
'CJK unified' => 0x4e00,
'CJK Ext A' => 0x3400,
'CJK Compat' => 0xf900,
'Hangul Jamo' => 0x1100,
'Hangul Ext A' => 0xa960,
'Hangul Ext B' => 0xd7b0,
'Hangul Compat' => 0x3131,
'Half non-punct 1' => 0xff21,
'Half non-punct 2' => 0xff41,
'Half non-punct 3' => 0xff66,
'Hangul Syllables' => 0xac00,
'Hiragana' => 0x3040,
'Katakana' => 0x30a1,
'Katakana Ext' => 0x31f0,
'CJK Reserve 1' => 0x20000,
'CJK Reserve 2' => 0x30000,
'Bomofo' => 0x3100,
'Bomofo Ext' => 0x31a0,
'Lisu' => 0xa4d0,
'Yi' => 0xa000,
);
// Ends of the character ranges.
$ends = array(
'CJK unified' => 0x9fcf,
'CJK Ext A' => 0x4dbf,
'CJK Compat' => 0xfaff,
'Hangul Jamo' => 0x11ff,
'Hangul Ext A' => 0xa97f,
'Hangul Ext B' => 0xd7ff,
'Hangul Compat' => 0x318e,
'Half non-punct 1' => 0xff3a,
'Half non-punct 2' => 0xff5a,
'Half non-punct 3' => 0xffdc,
'Hangul Syllables' => 0xd7af,
'Hiragana' => 0x309f,
'Katakana' => 0x30ff,
'Katakana Ext' => 0x31ff,
'CJK Reserve 1' => 0x2fffd,
'CJK Reserve 2' => 0x3fffd,
'Bomofo' => 0x312f,
'Bomofo Ext' => 0x31b7,
'Lisu' => 0xa4fd,
'Yi' => 0xa48f,
);
// Generate characters consisting of starts, midpoints, and ends.
$chars = array();
$charcodes = array();
foreach ($starts as $key => $value) {
$charcodes[] = $starts[$key];
$chars[] = $this->code2utf($starts[$key]);
$mid = round(0.5 * ($starts[$key] + $ends[$key]));
$charcodes[] = $mid;
$chars[] = $this->code2utf($mid);
$charcodes[] = $ends[$key];
$chars[] = $this->code2utf($ends[$key]);
}
// Merge into a string and tokenize.
$string = implode('', $chars);
$out = trim(search_simplify($string));
$expected = drupal_strtolower(implode(' ', $chars));
// Verify that the output matches what we expect.
$this->assertEqual($out, $expected, 'CJK tokenizer worked on all supplied CJK characters');
}
/**
* Verifies that strings of non-CJK characters are not tokenized.
*
* This is just a sanity check - it verifies that strings of letters are
* not tokenized.
*/
function testNoTokenizer() {
// Set the minimum word size to 1 (to split all CJK characters) and make
// sure CJK tokenizing is turned on.
variable_set('minimum_word_size', 1);
variable_set('overlap_cjk', TRUE);
$this->refreshVariables();
$letters = 'abcdefghijklmnopqrstuvwxyz';
$out = trim(search_simplify($letters));
$this->assertEqual($letters, $out, 'Letters are not CJK tokenized');
}
/**
* Like PHP chr() function, but for unicode characters.
*
* chr() only works for ASCII characters up to character 255. This function
* converts a number to the corresponding unicode character. Adapted from
* functions supplied in comments on several functions on php.net.
*/
function code2utf($num) {
if ($num < 128) {
return chr($num);
}
if ($num < 2048) {
return chr(($num >> 6) + 192) . chr(($num & 63) + 128);
}
if ($num < 65536) {
return chr(($num >> 12) + 224) . chr((($num >> 6) & 63) + 128) . chr(($num & 63) + 128);
}
if ($num < 2097152) {
return chr(($num >> 18) + 240) . chr((($num >> 12) & 63) + 128) . chr((($num >> 6) & 63) + 128) . chr(($num & 63) + 128);
}
return '';
}
}
/**
* Tests that we can embed a form in search results and submit it.
*/
class SearchEmbedForm extends DrupalWebTestCase {
/**
* Node used for testing.
*/
public $node;
/**
* Count of how many times the form has been submitted.
*/
public $submit_count = 0;
public static function getInfo() {
return array(
'name' => 'Embedded forms',
'description' => 'Verifies that a form embedded in search results works',
'group' => 'Search',
);
}
function setUp() {
parent::setUp('search', 'search_embedded_form');
// Create a user and a node, and update the search index.
$test_user = $this->drupalCreateUser(array('access content', 'search content', 'administer nodes'));
$this->drupalLogin($test_user);
$this->node = $this->drupalCreateNode();
node_update_index();
search_update_totals();
// Set up a dummy initial count of times the form has been submitted.
$this->submit_count = 12;
variable_set('search_embedded_form_submitted', $this->submit_count);
$this->refreshVariables();
}
/**
* Tests that the embedded form appears and can be submitted.
*/
function testEmbeddedForm() {
// First verify we can submit the form from the module's page.
$this->drupalPost('search_embedded_form',
array('name' => 'John'),
t('Send away'));
$this->assertText(t('Test form was submitted'), 'Form message appears');
$count = variable_get('search_embedded_form_submitted', 0);
$this->assertEqual($this->submit_count + 1, $count, 'Form submission count is correct');
$this->submit_count = $count;
// Now verify that we can see and submit the form from the search results.
$this->drupalGet('search/node/' . $this->node->title);
$this->assertText(t('Your name'), 'Form is visible');
$this->drupalPost('search/node/' . $this->node->title,
array('name' => 'John'),
t('Send away'));
$this->assertText(t('Test form was submitted'), 'Form message appears');
$count = variable_get('search_embedded_form_submitted', 0);
$this->assertEqual($this->submit_count + 1, $count, 'Form submission count is correct');
$this->submit_count = $count;
// Now verify that if we submit the search form, it doesn't count as
// our form being submitted.
$this->drupalPost('search',
array('keys' => 'foo'),
t('Search'));
$this->assertNoText(t('Test form was submitted'), 'Form message does not appear');
$count = variable_get('search_embedded_form_submitted', 0);
$this->assertEqual($this->submit_count, $count, 'Form submission count is correct');
$this->submit_count = $count;
}
}
/**
* Tests that hook_search_page runs.
*/
class SearchPageOverride extends DrupalWebTestCase {
public $search_user;
public static function getInfo() {
return array(
'name' => 'Search page override',
'description' => 'Verify that hook_search_page can override search page display.',
'group' => 'Search',
);
}
function setUp() {
parent::setUp('search', 'search_extra_type');
// Login as a user that can create and search content.
$this->search_user = $this->drupalCreateUser(array('search content', 'administer search'));
$this->drupalLogin($this->search_user);
// Enable the extra type module for searching.
variable_set('search_active_modules', array('node' => 'node', 'user' => 'user', 'search_extra_type' => 'search_extra_type'));
menu_rebuild();
}
function testSearchPageHook() {
$keys = 'bike shed ' . $this->randomName();
$this->drupalGet("search/dummy_path/{$keys}");
$this->assertText('Dummy search snippet', 'Dummy search snippet is shown');
$this->assertText('Test page text is here', 'Page override is working');
}
}
/**
* Test node search with multiple languages.
*/
class SearchLanguageTestCase extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Search language selection',
'description' => 'Tests advanced search with different languages enabled.',
'group' => 'Search',
);
}
/**
* Implementation setUp().
*/
function setUp() {
parent::setUp('search', 'locale');
// Create and login user.
$test_user = $this->drupalCreateUser(array('access content', 'search content', 'use advanced search', 'administer nodes', 'administer languages', 'access administration pages'));
$this->drupalLogin($test_user);
}
function testLanguages() {
// Check that there are initially no languages displayed.
$this->drupalGet('search/node');
$this->assertNoText(t('Languages'), 'No languages to choose from.');
// Add predefined language.
$edit = array('langcode' => 'fr');
$this->drupalPost('admin/config/regional/language/add', $edit, t('Add language'));
$this->assertText('fr', 'Language added successfully.');
// Now we should have languages displayed.
$this->drupalGet('search/node');
$this->assertText(t('Languages'), 'Languages displayed to choose from.');
$this->assertText(t('English'), 'English is a possible choice.');
$this->assertText(t('French'), 'French is a possible choice.');
// Ensure selecting no language does not make the query different.
$this->drupalPost('search/node', array(), t('Advanced search'));
$this->assertEqual($this->getUrl(), url('search/node/', array('absolute' => TRUE)), 'Correct page redirection, no language filtering.');
// Pick French and ensure it is selected.
$edit = array('language[fr]' => TRUE);
$this->drupalPost('search/node', $edit, t('Advanced search'));
$this->assertFieldByXPath('//input[@name="keys"]', 'language:fr', 'Language filter added to query.');
// Change the default language and disable English.
$path = 'admin/config/regional/language';
$this->drupalGet($path);
$this->assertFieldChecked('edit-site-default-en', 'English is the default language.');
$edit = array('site_default' => 'fr');
$this->drupalPost(NULL, $edit, t('Save configuration'));
$this->assertNoFieldChecked('edit-site-default-en', 'Default language updated.');
$edit = array('enabled[en]' => FALSE);
$this->drupalPost('admin/config/regional/language', $edit, t('Save configuration'));
$this->assertNoFieldChecked('edit-enabled-en', 'Language disabled.');
// Check that there are again no languages displayed.
$this->drupalGet('search/node');
$this->assertNoText(t('Languages'), 'No languages to choose from.');
}
}
/**
* Tests node search with node access control.
*/
class SearchNodeAccessTest extends DrupalWebTestCase {
public $test_user;
public static function getInfo() {
return array(
'name' => 'Search and node access',
'description' => 'Tests search functionality with node access control.',
'group' => 'Search',
);
}
function setUp() {
parent::setUp('search', 'node_access_test');
node_access_rebuild();
// Create a test user and log in.
$this->test_user = $this->drupalCreateUser(array('access content', 'search content', 'use advanced search'));
$this->drupalLogin($this->test_user);
}
/**
* Tests that search works with punctuation and HTML entities.
*/
function testPhraseSearchPunctuation() {
$node = $this->drupalCreateNode(array('body' => array(LANGUAGE_NONE => array(array('value' => "The bunny's ears were fuzzy.")))));
$node2 = $this->drupalCreateNode(array('body' => array(LANGUAGE_NONE => array(array('value' => 'Dignissim Aliquam & Quieligo meus natu quae quia te. Damnum© erat— neo pneum. Facilisi feugiat ibidem ratis.')))));
// Update the search index.
module_invoke_all('update_index');
search_update_totals();
// Refresh variables after the treatment.
$this->refreshVariables();
// Submit a phrase wrapped in double quotes to include the punctuation.
$edit = array('keys' => '"bunny\'s"');
$this->drupalPost('search/node', $edit, t('Search'));
$this->assertText($node->title);
// Search for "&" and verify entities are not broken up in the output.
$edit = array('keys' => '&');
$this->drupalPost('search/node', $edit, t('Search'));
$this->assertNoRaw('& amp;');
$this->assertText('You must include at least one positive keyword');
$edit = array('keys' => '&');
$this->drupalPost('search/node', $edit, t('Search'));
$this->assertNoRaw('& amp;');
$this->assertText('You must include at least one positive keyword');
}
}
/**
* Tests node search with query tags.
*/
class SearchNodeTagTest extends DrupalWebTestCase {
public $test_user;
public static function getInfo() {
return array(
'name' => 'Node search query tags',
'description' => 'Tests Node search tags functionality.',
'group' => 'Search',
);
}
function setUp() {
parent::setUp('search', 'search_node_tags');
node_access_rebuild();
// Create a test user and log in.
$this->test_user = $this->drupalCreateUser(array('search content'));
$this->drupalLogin($this->test_user);
}
/**
* Tests that the correct tags are available and hooks invoked.
*/
function testNodeSearchQueryTags() {
$this->drupalCreateNode(array('body' => array(LANGUAGE_NONE => array(array('value' => 'testing testing testing.')))));
// Update the search index.
module_invoke_all('update_index');
search_update_totals();
$edit = array('keys' => 'testing');
$this->drupalPost('search/node', $edit, t('Search'));
$this->assertTrue(variable_get('search_node_tags_test_query_tag', FALSE), 'hook_query_alter() was invoked and the query contained the "search_node" tag.');
$this->assertTrue(variable_get('search_node_tags_test_query_tag_hook', FALSE), 'hook_query_search_node_alter() was invoked.');
}
}
/**
* Tests searching with locale values set.
*/
class SearchSetLocaleTest extends DrupalWebTestCase {
public static function getInfo() {
return array(
'name' => 'Search with numeric locale set',
'description' => 'Check that search works with numeric locale settings',
'group' => 'Search',
);
}
function setUp() {
parent::setUp('search');
// Create a simple node so something will be put in the index.
$info = array(
'body' => array(LANGUAGE_NONE => array(array('value' => 'Tapir'))),
);
$this->drupalCreateNode($info);
// Run cron to index.
$this->cronRun();
}
/**
* Verify that search works with a numeric locale set.
*/
public function testSearchWithNumericLocale() {
// French decimal point is comma.
setlocale(LC_NUMERIC, 'fr_FR');
// An exception will be thrown if a float in the wrong format occurs in the
// query to the database, so an assertion is not necessary here.
db_select('search_index', 'i')
->extend('searchquery')
->searchexpression('tapir', 'node')
->execute();
}
}
!"#$%&'()*+,-./
0123456789
:;<=>?@
ABCDEFGHIJKLMNOPQRSTUVWXYZ
[\]^_`
abcdefghijklmnopqrstuvwxyz
{|}~
¡¢£¤¥¦§¨©
ª
«¬®¯°±
²³
´
µ
¶·¸
¹º
»
¼½¾
¿
ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ
×
ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö
÷
øùúûüýþÿĀāĂ㥹ĆćĈĉĊċČčĎďĐđĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħĨĩĪīĬĭĮįİıIJijĴĵĶķĸĹĺĻļĽľĿŀŁłŃńŅņŇňʼnŊŋŌōŎŏŐőŒœŔŕŖŗŘřŚśŜŝŞşŠšŢţŤťŦŧŨũŪūŬŭŮůŰűŲųŴŵŶŷŸŹźŻżŽžſƀƁƂƃƄƅƆƇƈƉƊƋƌƍƎƏƐƑƒƓƔƕƖƗƘƙƚƛƜƝƞƟƠơƢƣƤƥƦƧƨƩƪƫƬƭƮƯưƱƲƳƴƵƶƷƸƹƺƻƼƽƾƿǀǁǂǃDŽDždžLJLjljNJNjnjǍǎǏǐǑǒǓǔǕǖǗǘǙǚǛǜǝǞǟǠǡǢǣǤǥǦǧǨǩǪǫǬǭǮǯǰDZDzdzǴǵǶǷǸǹǺǻǼǽǾǿȀȁȂȃȄȅȆȇȈȉȊȋȌȍȎȏȐȑȒȓȔȕȖȗȘșȚțȜȝȞȟȠȡȢȣȤȥȦȧȨȩȪȫȬȭȮȯȰȱȲȳȴȵȶȷȸȹȺȻȼȽȾȿɀɁɂɃɄɅɆɇɈɉɊɋɌɍɎɏɐɑɒɓɔɕɖɗɘəɚɛɜɝɞɟɠɡɢɣɤɥɦɧɨɩɪɫɬɭɮɯɰɱɲɳɴɵɶɷɸɹɺɻɼɽɾɿʀʁʂʃʄʅʆʇʈʉʊʋʌʍʎʏʐʑʒʓʔʕʖʗʘʙʚʛʜʝʞʟʠʡʢʣʤʥʦʧʨʩʪʫʬʭʮʯʰʱʲʳʴʵʶʷʸʹʺʻʼʽʾʿˀˁ
˂˃˄˅
ˆˇˈˉˊˋˌˍˎˏːˑ
˒˓˔˕˖˗˘˙˚˛˜˝˞˟
ˠˡˢˣˤ
˥˦˧˨˩˪˫
ˬ
˭
ˮ
˯˰˱˲˳˴˵˶˷˸˹˺˻˼˽˾˿
̴̵̶̷̸̡̢̧̨̛̖̗̘̙̜̝̞̟̠̣̤̥̦̩̪̫̬̭̮̯̰̱̲̳̹̺̻̼͇͈͉͍͎̀́̂̃̄̅̆̇̈̉̊̋̌̍̎̏̐̑̒̓̔̽̾̿̀́͂̓̈́͆͊͋͌̕̚ͅ͏͓͔͕͖͙͚͐͑͒͗͛ͣͤͥͦͧͨͩͪͫͬͭͮͯ͘͜͟͢͝͞͠͡ͰͱͲͳʹ
͵
Ͷͷͺͻͼͽ
;΄΅
Ά
·
ΈΉΊΌΎΏΐΑΒΓΔΕΖΗΘΙΚΛΜΝΞΟΠΡΣΤΥΦΧΨΩΪΫάέήίΰαβγδεζηθικλμνξοπρςστυφχψωϊϋόύώϏϐϑϒϓϔϕϖϗϘϙϚϛϜϝϞϟϠϡϢϣϤϥϦϧϨϩϪϫϬϭϮϯϰϱϲϳϴϵ
϶
ϷϸϹϺϻϼϽϾϿЀЁЂЃЄЅІЇЈЉЊЋЌЍЎЏАБВГДЕЖЗИЙКЛМНОПРСТУФХЦЧШЩЪЫЬЭЮЯабвгдежзийклмнопрстуфхцчшщъыьэюяѐёђѓєѕіїјљњћќѝўџѠѡѢѣѤѥѦѧѨѩѪѫѬѭѮѯѰѱѲѳѴѵѶѷѸѹѺѻѼѽѾѿҀҁ
҂
҃҄҅҆҇҈҉ҊҋҌҍҎҏҐґҒғҔҕҖҗҘҙҚқҜҝҞҟҠҡҢңҤҥҦҧҨҩҪҫҬҭҮүҰұҲҳҴҵҶҷҸҹҺһҼҽҾҿӀӁӂӃӄӅӆӇӈӉӊӋӌӍӎӏӐӑӒӓӔӕӖӗӘәӚӛӜӝӞӟӠӡӢӣӤӥӦӧӨөӪӫӬӭӮӯӰӱӲӳӴӵӶӷӸӹӺӻӼӽӾӿԀԁԂԃԄԅԆԇԈԉԊԋԌԍԎԏԐԑԒԓԔԕԖԗԘԙԚԛԜԝԞԟԠԡԢԣԤԥԱԲԳԴԵԶԷԸԹԺԻԼԽԾԿՀՁՂՃՄՅՆՇՈՉՊՋՌՍՎՏՐՑՒՓՔՕՖՙ
՚՛՜՝՞՟
աբգդեզէըթժիլխծկհձղճմյնշոչպջռսվտրցւփքօֆև
։֊
ְֱֲֳִֵֶַָֹֺֻּֽ֑֖֛֢֣֤֥֦֧֪֚֭֮֒֓֔֕֗֘֙֜֝֞֟֠֡֨֩֫֬֯
־
ֿ
׀
ׁׂ
׃
ׅׄ
׆
ׇאבגדהוזחטיךכלםמןנסעףפץצקרשתװױײ
׳״؆؇؈؉؊؋،؍؎؏
ؘؙؚؐؑؒؓؔؕؖؗ
؛؞؟
ءآأؤإئابةتثجحخدذرزسشصضطظعغػؼؽؾؿـفقكلمنهوىيًٌٍَُِّْٕٖٜٓٔٗ٘ٙٚٛٝٞ٠١٢٣٤٥٦٧٨٩
٪٫٬٭
ٮٯٰٱٲٳٴٵٶٷٸٹٺٻټٽپٿڀځڂڃڄڅچڇڈډڊڋڌڍڎڏڐڑڒړڔڕږڗژڙښڛڜڝڞڟڠڡڢڣڤڥڦڧڨکڪګڬڭڮگڰڱڲڳڴڵڶڷڸڹںڻڼڽھڿۀہۂۃۄۅۆۇۈۉۊۋیۍێۏېۑےۓ
۔
ەۖۗۘۙۚۛۜ
۞ۣ۟۠ۡۢۤۥۦۧۨ
۩
۪ۭ۫۬ۮۯ۰۱۲۳۴۵۶۷۸۹ۺۻۼ
۽۾
ۿ
܀܁܂܃܄܅܆܇܈܉܊܋܌܍
ܐܑܒܓܔܕܖܗܘܙܚܛܜܝܞܟܠܡܢܣܤܥܦܧܨܩܪܫܬܭܮܯܱܴܷܸܹܻܼܾ݂݄݆݈ܰܲܳܵܶܺܽܿ݀݁݃݅݇݉݊ݍݎݏݐݑݒݓݔݕݖݗݘݙݚݛݜݝݞݟݠݡݢݣݤݥݦݧݨݩݪݫݬݭݮݯݰݱݲݳݴݵݶݷݸݹݺݻݼݽݾݿހށނރބޅކއވމފދތލގޏސޑޒޓޔޕޖޗޘޙޚޛޜޝޞޟޠޡޢޣޤޥަާިީުޫެޭޮޯްޱ߀߁߂߃߄߅߆߇߈߉ߊߋߌߍߎߏߐߑߒߓߔߕߖߗߘߙߚߛߜߝߞߟߠߡߢߣߤߥߦߧߨߩߪ߲߫߬߭߮߯߰߱߳ߴߵ
߶߷߸߹
ߺࠀࠁࠂࠃࠄࠅࠆࠇࠈࠉࠊࠋࠌࠍࠎࠏࠐࠑࠒࠓࠔࠕࠖࠗ࠘࠙ࠚࠛࠜࠝࠞࠟࠠࠡࠢࠣࠤࠥࠦࠧࠨࠩࠪࠫࠬ࠭
࠰࠱࠲࠳࠴࠵࠶࠷࠸࠹࠺࠻࠼࠽࠾
ऀँंःऄअआइईउऊऋऌऍऎएऐऑऒओऔकखगघङचछजझञटठडढणतथदधनऩपफबभमयरऱलळऴवशषसह़ऽािीुूृॄॅॆेैॉॊोौ्ॎॐ॒॑॓॔ॕक़ख़ग़ज़ड़ढ़फ़य़ॠॡॢॣ
।॥
०१२३४५६७८९
॰
ॱॲॹॺॻॼॽॾॿঁংঃঅআইঈউঊঋঌএঐওঔকখগঘঙচছজঝঞটঠডঢণতথদধনপফবভমযরলশষসহ়ঽািীুূৃৄেৈোৌ্ৎৗড়ঢ়য়ৠৡৢৣ০১২৩৪৫৬৭৮৯ৰৱ
৲৳
৴৵৶৷৸৹
৺৻
ਁਂਃਅਆਇਈਉਊਏਐਓਔਕਖਗਘਙਚਛਜਝਞਟਠਡਢਣਤਥਦਧਨਪਫਬਭਮਯਰਲਲ਼ਵਸ਼ਸਹ਼ਾਿੀੁੂੇੈੋੌ੍ੑਖ਼ਗ਼ਜ਼ੜਫ਼੦੧੨੩੪੫੬੭੮੯ੰੱੲੳੴੵઁંઃઅઆઇઈઉઊઋઌઍએઐઑઓઔકખગઘઙચછજઝઞટઠડઢણતથદધનપફબભમયરલળવશષસહ઼ઽાિીુૂૃૄૅેૈૉોૌ્ૐૠૡૢૣ૦૧૨૩૪૫૬૭૮૯
૱
ଁଂଃଅଆଇଈଉଊଋଌଏଐଓଔକଖଗଘଙଚଛଜଝଞଟଠଡଢଣତଥଦଧନପଫବଭମଯରଲଳଵଶଷସହ଼ଽାିୀୁୂୃୄେୈୋୌ୍ୖୗଡ଼ଢ଼ୟୠୡୢୣ୦୧୨୩୪୫୬୭୮୯
୰
ୱஂஃஅஆஇஈஉஊஎஏஐஒஓஔகஙசஜஞடணதநனபமயரறலளழவஶஷஸஹாிீுூெேைொோௌ்ௐௗ௦௧௨௩௪௫௬௭௮௯௰௱௲
௳௴௵௶௷௸௹௺
ఁంఃఅఆఇఈఉఊఋఌఎఏఐఒఓఔకఖగఘఙచఛజఝఞటఠడఢణతథదధనపఫబభమయరఱలళవశషసహఽాిీుూృౄెేైొోౌ్ౕౖౘౙౠౡౢౣ౦౧౨౩౪౫౬౭౮౯౸౹౺౻౼౽౾
౿
ಂಃಅಆಇಈಉಊಋಌಎಏಐಒಓಔಕಖಗಘಙಚಛಜಝಞಟಠಡಢಣತಥದಧನಪಫಬಭಮಯರಱಲಳವಶಷಸಹ಼ಽಾಿೀುೂೃೄೆೇೈೊೋೌ್ೕೖೞೠೡೢೣ೦೧೨೩೪೫೬೭೮೯
ೱೲ
ംഃഅആഇഈഉഊഋഌഎഏഐഒഓഔകഖഗഘങചഛജഝഞടഠഡഢണതഥദധനപഫബഭമയരറലളഴവശഷസഹഽാിീുൂൃൄെേൈൊോൌ്ൗൠൡൢൣ൦൧൨൩൪൫൬൭൮൯൰൱൲൳൴൵
൹
ൺൻർൽൾൿංඃඅආඇඈඉඊඋඌඍඎඏඐඑඒඓඔඕඖකඛගඝඞඟචඡජඣඤඥඦටඨඩඪණඬතථදධනඳපඵබභමඹයරලවශෂසහළෆ්ාැෑිීුූෘෙේෛොෝෞෟෲෳ
෴
กขฃคฅฆงจฉชซฌญฎฏฐฑฒณดตถทธนบปผฝพฟภมยรฤลฦวศษสหฬอฮฯะัาำิีึืฺุู
฿
เแโใไๅๆ็่้๊๋์ํ๎
๏
๐๑๒๓๔๕๖๗๘๙
๚๛
ກຂຄງຈຊຍດຕຖທນບປຜຝພຟມຢຣລວສຫອຮຯະັາຳິີຶືຸູົຼຽເແໂໃໄໆ່້໊໋໌ໍ໐໑໒໓໔໕໖໗໘໙ໜໝༀ
༁༂༃༄༅༆༇༈༉༊་༌།༎༏༐༑༒༓༔༕༖༗
༘༙
༚༛༜༝༞༟
༠༡༢༣༤༥༦༧༨༩༪༫༬༭༮༯༰༱༲༳
༴
༵
༶
༷
༸
༹
༺༻༼༽
༾༿ཀཁགགྷངཅཆཇཉཊཋཌཌྷཎཏཐདདྷནཔཕབབྷམཙཚཛཛྷཝཞཟའཡརལཤཥསཧཨཀྵཪཫཬཱཱཱིིུུྲྀཷླྀཹེཻོཽཾཿ྄ཱྀྀྂྃ
྅
྆྇ྈྉྊྋྐྑྒྒྷྔྕྖྗྙྚྛྜྜྷྞྟྠྡྡྷྣྤྥྦྦྷྨྩྪྫྫྷྭྮྯྰྱྲླྴྵྶྷྸྐྵྺྻྼ
྾྿࿀࿁࿂࿃࿄࿅
࿆
࿇࿈࿉࿊࿋࿌࿎࿏࿐࿑࿒࿓࿔࿕࿖࿗࿘
ကခဂဃငစဆဇဈဉညဋဌဍဎဏတထဒဓနပဖဗဘမယရလဝသဟဠအဢဣဤဥဦဧဨဩဪါာိီုူေဲဳဴဵံ့း္်ျြွှဿ၀၁၂၃၄၅၆၇၈၉
၊။၌၍၎၏
ၐၑၒၓၔၕၖၗၘၙၚၛၜၝၞၟၠၡၢၣၤၥၦၧၨၩၪၫၬၭၮၯၰၱၲၳၴၵၶၷၸၹၺၻၼၽၾၿႀႁႂႃႄႅႆႇႈႉႊႋႌႍႎႏ႐႑႒႓႔႕႖႗႘႙ႚႛႜႝ
႞႟
ႠႡႢႣႤႥႦႧႨႩႪႫႬႭႮႯႰႱႲႳႴႵႶႷႸႹႺႻႼႽႾႿჀჁჂჃჄჅაბგდევზთიკლმნოპჟრსტუფქღყშჩცძწჭხჯჰჱჲჳჴჵჶჷჸჹჺ
჻
ჼᄀᄁᄂᄃᄄᄅᄆᄇᄈᄉᄊᄋᄌᄍᄎᄏᄐᄑᄒᄓᄔᄕᄖᄗᄘᄙᄚᄛᄜᄝᄞᄟᄠᄡᄢᄣᄤᄥᄦᄧᄨᄩᄪᄫᄬᄭᄮᄯᄰᄱᄲᄳᄴᄵᄶᄷᄸᄹᄺᄻᄼᄽᄾᄿᅀᅁᅂᅃᅄᅅᅆᅇᅈᅉᅊᅋᅌᅍᅎᅏᅐᅑᅒᅓᅔᅕᅖᅗᅘᅙᅚᅛᅜᅝᅞᅟᅠᅡᅢᅣᅤᅥᅦᅧᅨᅩᅪᅫᅬᅭᅮᅯᅰᅱᅲᅳᅴᅵᅶᅷᅸᅹᅺᅻᅼᅽᅾᅿᆀᆁᆂᆃᆄᆅᆆᆇᆈᆉᆊᆋᆌᆍᆎᆏᆐᆑᆒᆓᆔᆕᆖᆗᆘᆙᆚᆛᆜᆝᆞᆟᆠᆡᆢᆣᆤᆥᆦᆧᆨᆩᆪᆫᆬᆭᆮᆯᆰᆱᆲᆳᆴᆵᆶᆷᆸᆹᆺᆻᆼᆽᆾᆿᇀᇁᇂᇃᇄᇅᇆᇇᇈᇉᇊᇋᇌᇍᇎᇏᇐᇑᇒᇓᇔᇕᇖᇗᇘᇙᇚᇛᇜᇝᇞᇟᇠᇡᇢᇣᇤᇥᇦᇧᇨᇩᇪᇫᇬᇭᇮᇯᇰᇱᇲᇳᇴᇵᇶᇷᇸᇹᇺᇻᇼᇽᇾᇿሀሁሂሃሄህሆሇለሉሊላሌልሎሏሐሑሒሓሔሕሖሗመሙሚማሜምሞሟሠሡሢሣሤሥሦሧረሩሪራሬርሮሯሰሱሲሳሴስሶሷሸሹሺሻሼሽሾሿቀቁቂቃቄቅቆቇቈቊቋቌቍቐቑቒቓቔቕቖቘቚቛቜቝበቡቢባቤብቦቧቨቩቪቫቬቭቮቯተቱቲታቴትቶቷቸቹቺቻቼችቾቿኀኁኂኃኄኅኆኇኈኊኋኌኍነኑኒናኔንኖኗኘኙኚኛኜኝኞኟአኡኢኣኤእኦኧከኩኪካኬክኮኯኰኲኳኴኵኸኹኺኻኼኽኾዀዂዃዄዅወዉዊዋዌውዎዏዐዑዒዓዔዕዖዘዙዚዛዜዝዞዟዠዡዢዣዤዥዦዧየዩዪያዬይዮዯደዱዲዳዴድዶዷዸዹዺዻዼዽዾዿጀጁጂጃጄጅጆጇገጉጊጋጌግጎጏጐጒጓጔጕጘጙጚጛጜጝጞጟጠጡጢጣጤጥጦጧጨጩጪጫጬጭጮጯጰጱጲጳጴጵጶጷጸጹጺጻጼጽጾጿፀፁፂፃፄፅፆፇፈፉፊፋፌፍፎፏፐፑፒፓፔፕፖፗፘፙፚ፟
፠፡።፣፤፥፦፧፨
፩፪፫፬፭፮፯፰፱፲፳፴፵፶፷፸፹፺፻፼ᎀᎁᎂᎃᎄᎅᎆᎇᎈᎉᎊᎋᎌᎍᎎᎏ
᎐᎑᎒᎓᎔᎕᎖᎗᎘᎙
ᎠᎡᎢᎣᎤᎥᎦᎧᎨᎩᎪᎫᎬᎭᎮᎯᎰᎱᎲᎳᎴᎵᎶᎷᎸᎹᎺᎻᎼᎽᎾᎿᏀᏁᏂᏃᏄᏅᏆᏇᏈᏉᏊᏋᏌᏍᏎᏏᏐᏑᏒᏓᏔᏕᏖᏗᏘᏙᏚᏛᏜᏝᏞᏟᏠᏡᏢᏣᏤᏥᏦᏧᏨᏩᏪᏫᏬᏭᏮᏯᏰᏱᏲᏳᏴ
᐀
ᐁᐂᐃᐄᐅᐆᐇᐈᐉᐊᐋᐌᐍᐎᐏᐐᐑᐒᐓᐔᐕᐖᐗᐘᐙᐚᐛᐜᐝᐞᐟᐠᐡᐢᐣᐤᐥᐦᐧᐨᐩᐪᐫᐬᐭᐮᐯᐰᐱᐲᐳᐴᐵᐶᐷᐸᐹᐺᐻᐼᐽᐾᐿᑀᑁᑂᑃᑄᑅᑆᑇᑈᑉᑊᑋᑌᑍᑎᑏᑐᑑᑒᑓᑔᑕᑖᑗᑘᑙᑚᑛᑜᑝᑞᑟᑠᑡᑢᑣᑤᑥᑦᑧᑨᑩᑪᑫᑬᑭᑮᑯᑰᑱᑲᑳᑴᑵᑶᑷᑸᑹᑺᑻᑼᑽᑾᑿᒀᒁᒂᒃᒄᒅᒆᒇᒈᒉᒊᒋᒌᒍᒎᒏᒐᒑᒒᒓᒔᒕᒖᒗᒘᒙᒚᒛᒜᒝᒞᒟᒠᒡᒢᒣᒤᒥᒦᒧᒨᒩᒪᒫᒬᒭᒮᒯᒰᒱᒲᒳᒴᒵᒶᒷᒸᒹᒺᒻᒼᒽᒾᒿᓀᓁᓂᓃᓄᓅᓆᓇᓈᓉᓊᓋᓌᓍᓎᓏᓐᓑᓒᓓᓔᓕᓖᓗᓘᓙᓚᓛᓜᓝᓞᓟᓠᓡᓢᓣᓤᓥᓦᓧᓨᓩᓪᓫᓬᓭᓮᓯᓰᓱᓲᓳᓴᓵᓶᓷᓸᓹᓺᓻᓼᓽᓾᓿᔀᔁᔂᔃᔄᔅᔆᔇᔈᔉᔊᔋᔌᔍᔎᔏᔐᔑᔒᔓᔔᔕᔖᔗᔘᔙᔚᔛᔜᔝᔞᔟᔠᔡᔢᔣᔤᔥᔦᔧᔨᔩᔪᔫᔬᔭᔮᔯᔰᔱᔲᔳᔴᔵᔶᔷᔸᔹᔺᔻᔼᔽᔾᔿᕀᕁᕂᕃᕄᕅᕆᕇᕈᕉᕊᕋᕌᕍᕎᕏᕐᕑᕒᕓᕔᕕᕖᕗᕘᕙᕚᕛᕜᕝᕞᕟᕠᕡᕢᕣᕤᕥᕦᕧᕨᕩᕪᕫᕬᕭᕮᕯᕰᕱᕲᕳᕴᕵᕶᕷᕸᕹᕺᕻᕼᕽᕾᕿᖀᖁᖂᖃᖄᖅᖆᖇᖈᖉᖊᖋᖌᖍᖎᖏᖐᖑᖒᖓᖔᖕᖖᖗᖘᖙᖚᖛᖜᖝᖞᖟᖠᖡᖢᖣᖤᖥᖦᖧᖨᖩᖪᖫᖬᖭᖮᖯᖰᖱᖲᖳᖴᖵᖶᖷᖸᖹᖺᖻᖼᖽᖾᖿᗀᗁᗂᗃᗄᗅᗆᗇᗈᗉᗊᗋᗌᗍᗎᗏᗐᗑᗒᗓᗔᗕᗖᗗᗘᗙᗚᗛᗜᗝᗞᗟᗠᗡᗢᗣᗤᗥᗦᗧᗨᗩᗪᗫᗬᗭᗮᗯᗰᗱᗲᗳᗴᗵᗶᗷᗸᗹᗺᗻᗼᗽᗾᗿᘀᘁᘂᘃᘄᘅᘆᘇᘈᘉᘊᘋᘌᘍᘎᘏᘐᘑᘒᘓᘔᘕᘖᘗᘘᘙᘚᘛᘜᘝᘞᘟᘠᘡᘢᘣᘤᘥᘦᘧᘨᘩᘪᘫᘬᘭᘮᘯᘰᘱᘲᘳᘴᘵᘶᘷᘸᘹᘺᘻᘼᘽᘾᘿᙀᙁᙂᙃᙄᙅᙆᙇᙈᙉᙊᙋᙌᙍᙎᙏᙐᙑᙒᙓᙔᙕᙖᙗᙘᙙᙚᙛᙜᙝᙞᙟᙠᙡᙢᙣᙤᙥᙦᙧᙨᙩᙪᙫᙬ
᙭᙮
ᙯᙰᙱᙲᙳᙴᙵᙶᙷᙸᙹᙺᙻᙼᙽᙾᙿ
ᚁᚂᚃᚄᚅᚆᚇᚈᚉᚊᚋᚌᚍᚎᚏᚐᚑᚒᚓᚔᚕᚖᚗᚘᚙᚚ
᚛᚜
ᚠᚡᚢᚣᚤᚥᚦᚧᚨᚩᚪᚫᚬᚭᚮᚯᚰᚱᚲᚳᚴᚵᚶᚷᚸᚹᚺᚻᚼᚽᚾᚿᛀᛁᛂᛃᛄᛅᛆᛇᛈᛉᛊᛋᛌᛍᛎᛏᛐᛑᛒᛓᛔᛕᛖᛗᛘᛙᛚᛛᛜᛝᛞᛟᛠᛡᛢᛣᛤᛥᛦᛧᛨᛩᛪ
᛫᛬᛭
ᛮᛯᛰᜀᜁᜂᜃᜄᜅᜆᜇᜈᜉᜊᜋᜌᜎᜏᜐᜑᜒᜓ᜔ᜠᜡᜢᜣᜤᜥᜦᜧᜨᜩᜪᜫᜬᜭᜮᜯᜰᜱᜲᜳ᜴
᜵᜶
ᝀᝁᝂᝃᝄᝅᝆᝇᝈᝉᝊᝋᝌᝍᝎᝏᝐᝑᝒᝓᝠᝡᝢᝣᝤᝥᝦᝧᝨᝩᝪᝫᝬᝮᝯᝰᝲᝳកខគឃងចឆជឈញដឋឌឍណតថទធនបផពភមយរលវឝឞសហឡអឣឤឥឦឧឨឩឪឫឬឭឮឯឰឱឲឳ
឴឵
ាិីឹឺុូួើឿៀេែៃោៅំះៈ៉៊់៌៍៎៏័៑្៓
។៕៖
ៗ
៘៙៚៛
ៜ៝០១២៣៤៥៦៧៨៩៰៱៲៳៴៵៶៷៸៹
᠀᠁᠂᠃᠄᠅᠆᠇᠈᠉᠊
᠋᠌᠍
᠐᠑᠒᠓᠔᠕᠖᠗᠘᠙ᠠᠡᠢᠣᠤᠥᠦᠧᠨᠩᠪᠫᠬᠭᠮᠯᠰᠱᠲᠳᠴᠵᠶᠷᠸᠹᠺᠻᠼᠽᠾᠿᡀᡁᡂᡃᡄᡅᡆᡇᡈᡉᡊᡋᡌᡍᡎᡏᡐᡑᡒᡓᡔᡕᡖᡗᡘᡙᡚᡛᡜᡝᡞᡟᡠᡡᡢᡣᡤᡥᡦᡧᡨᡩᡪᡫᡬᡭᡮᡯᡰᡱᡲᡳᡴᡵᡶᡷᢀᢁᢂᢃᢄᢅᢆᢇᢈᢉᢊᢋᢌᢍᢎᢏᢐᢑᢒᢓᢔᢕᢖᢗᢘᢙᢚᢛᢜᢝᢞᢟᢠᢡᢢᢣᢤᢥᢦᢧᢨᢩᢪᢰᢱᢲᢳᢴᢵᢶᢷᢸᢹᢺᢻᢼᢽᢾᢿᣀᣁᣂᣃᣄᣅᣆᣇᣈᣉᣊᣋᣌᣍᣎᣏᣐᣑᣒᣓᣔᣕᣖᣗᣘᣙᣚᣛᣜᣝᣞᣟᣠᣡᣢᣣᣤᣥᣦᣧᣨᣩᣪᣫᣬᣭᣮᣯᣰᣱᣲᣳᣴᣵᤀᤁᤂᤃᤄᤅᤆᤇᤈᤉᤊᤋᤌᤍᤎᤏᤐᤑᤒᤓᤔᤕᤖᤗᤘᤙᤚᤛᤜᤠᤡᤢᤣᤤᤥᤦᤧᤨᤩᤪᤫᤰᤱᤲᤳᤴᤵᤶᤷᤸ᤻᤹᤺
᥀᥄᥅
᥆᥇᥈᥉᥊᥋᥌᥍᥎᥏ᥐᥑᥒᥓᥔᥕᥖᥗᥘᥙᥚᥛᥜᥝᥞᥟᥠᥡᥢᥣᥤᥥᥦᥧᥨᥩᥪᥫᥬᥭᥰᥱᥲᥳᥴᦀᦁᦂᦃᦄᦅᦆᦇᦈᦉᦊᦋᦌᦍᦎᦏᦐᦑᦒᦓᦔᦕᦖᦗᦘᦙᦚᦛᦜᦝᦞᦟᦠᦡᦢᦣᦤᦥᦦᦧᦨᦩᦪᦫᦰᦱᦲᦳᦴᦵᦶᦷᦸᦹᦺᦻᦼᦽᦾᦿᧀᧁᧂᧃᧄᧅᧆᧇᧈᧉ᧐᧑᧒᧓᧔᧕᧖᧗᧘᧙᧚
᧞᧟᧠᧡᧢᧣᧤᧥᧦᧧᧨᧩᧪᧫᧬᧭᧮᧯᧰᧱᧲᧳᧴᧵᧶᧷᧸᧹᧺᧻᧼᧽᧾᧿
ᨀᨁᨂᨃᨄᨅᨆᨇᨈᨉᨊᨋᨌᨍᨎᨏᨐᨑᨒᨓᨔᨕᨖᨘᨗᨙᨚᨛ
᨞᨟
ᨠᨡᨢᨣᨤᨥᨦᨧᨨᨩᨪᨫᨬᨭᨮᨯᨰᨱᨲᨳᨴᨵᨶᨷᨸᨹᨺᨻᨼᨽᨾᨿᩀᩁᩂᩃᩄᩅᩆᩇᩈᩉᩊᩋᩌᩍᩎᩏᩐᩑᩒᩓᩔᩕᩖᩗᩘᩙᩚᩛᩜᩝᩞ᩠ᩡᩢᩣᩤᩥᩦᩧᩨᩩᩪᩫᩬᩭᩮᩯᩰᩱᩲᩳᩴ᩿᩵᩶᩷᩸᩹᩺᩻᩼᪀᪁᪂᪃᪄᪅᪆᪇᪈᪉᪐᪑᪒᪓᪔᪕᪖᪗᪘᪙
᪠᪡᪢᪣᪤᪥᪦
ᪧ
᪨᪩᪪᪫᪬᪭
ᬀᬁᬂᬃᬄᬅᬆᬇᬈᬉᬊᬋᬌᬍᬎᬏᬐᬑᬒᬓᬔᬕᬖᬗᬘᬙᬚᬛᬜᬝᬞᬟᬠᬡᬢᬣᬤᬥᬦᬧᬨᬩᬪᬫᬬᬭᬮᬯᬰᬱᬲᬳ᬴ᬵᬶᬷᬸᬹᬺᬻᬼᬽᬾᬿᭀᭁᭂᭃ᭄ᭅᭆᭇᭈᭉᭊᭋ᭐᭑᭒᭓᭔᭕᭖᭗᭘᭙
᭚᭛᭜᭝᭞᭟᭠᭡᭢᭣᭤᭥᭦᭧᭨᭩᭪
᭬᭫᭭᭮᭯᭰᭱᭲᭳
᭴᭵᭶᭷᭸᭹᭺᭻᭼
ᮀᮁᮂᮃᮄᮅᮆᮇᮈᮉᮊᮋᮌᮍᮎᮏᮐᮑᮒᮓᮔᮕᮖᮗᮘᮙᮚᮛᮜᮝᮞᮟᮠᮡᮢᮣᮤᮥᮦᮧᮨᮩ᮪ᮮᮯ᮰᮱᮲᮳᮴᮵᮶᮷᮸᮹ᰀᰁᰂᰃᰄᰅᰆᰇᰈᰉᰊᰋᰌᰍᰎᰏᰐᰑᰒᰓᰔᰕᰖᰗᰘᰙᰚᰛᰜᰝᰞᰟᰠᰡᰢᰣᰤᰥᰦᰧᰨᰩᰪᰫᰬᰭᰮᰯᰰᰱᰲᰳᰴᰵᰶ᰷
᰻᰼᰽᰾᰿
᱀᱁᱂᱃᱄᱅᱆᱇᱈᱉ᱍᱎᱏ᱐᱑᱒᱓᱔᱕᱖᱗᱘᱙ᱚᱛᱜᱝᱞᱟᱠᱡᱢᱣᱤᱥᱦᱧᱨᱩᱪᱫᱬᱭᱮᱯᱰᱱᱲᱳᱴᱵᱶᱷᱸᱹᱺᱻᱼᱽ
᱾᱿
᳐᳑᳒
᳓
᳔᳕᳖᳗᳘᳙᳜᳝᳞᳟᳚᳛᳠᳡᳢᳣᳤᳥᳦᳧᳨ᳩᳪᳫᳬ᳭ᳮᳯᳰᳱᳲᴀᴁᴂᴃᴄᴅᴆᴇᴈᴉᴊᴋᴌᴍᴎᴏᴐᴑᴒᴓᴔᴕᴖᴗᴘᴙᴚᴛᴜᴝᴞᴟᴠᴡᴢᴣᴤᴥᴦᴧᴨᴩᴪᴫᴬᴭᴮᴯᴰᴱᴲᴳᴴᴵᴶᴷᴸᴹᴺᴻᴼᴽᴾᴿᵀᵁᵂᵃᵄᵅᵆᵇᵈᵉᵊᵋᵌᵍᵎᵏᵐᵑᵒᵓᵔᵕᵖᵗᵘᵙᵚᵛᵜᵝᵞᵟᵠᵡᵢᵣᵤᵥᵦᵧᵨᵩᵪᵫᵬᵭᵮᵯᵰᵱᵲᵳᵴᵵᵶᵷᵸᵹᵺᵻᵼᵽᵾᵿᶀᶁᶂᶃᶄᶅᶆᶇᶈᶉᶊᶋᶌᶍᶎᶏᶐᶑᶒᶓᶔᶕᶖᶗᶘᶙᶚᶛᶜᶝᶞᶟᶠᶡᶢᶣᶤᶥᶦᶧᶨᶩᶪᶫᶬᶭᶮᶯᶰᶱᶲᶳᶴᶵᶶᶷᶸᶹᶺᶻᶼᶽᶾᶿ᷐᷎᷂᷊᷏᷽᷿᷀᷁᷃᷄᷅᷆᷇᷈᷉᷋᷌᷑᷒ᷓᷔᷕᷖᷗᷘᷙᷚᷛᷜᷝᷞᷟᷠᷡᷢᷣᷤᷥᷦ᷾᷍ḀḁḂḃḄḅḆḇḈḉḊḋḌḍḎḏḐḑḒḓḔḕḖḗḘḙḚḛḜḝḞḟḠḡḢḣḤḥḦḧḨḩḪḫḬḭḮḯḰḱḲḳḴḵḶḷḸḹḺḻḼḽḾḿṀṁṂṃṄṅṆṇṈṉṊṋṌṍṎṏṐṑṒṓṔṕṖṗṘṙṚṛṜṝṞṟṠṡṢṣṤṥṦṧṨṩṪṫṬṭṮṯṰṱṲṳṴṵṶṷṸṹṺṻṼṽṾṿẀẁẂẃẄẅẆẇẈẉẊẋẌẍẎẏẐẑẒẓẔẕẖẗẘẙẚẛẜẝẞẟẠạẢảẤấẦầẨẩẪẫẬậẮắẰằẲẳẴẵẶặẸẹẺẻẼẽẾếỀềỂểỄễỆệỈỉỊịỌọỎỏỐốỒồỔổỖỗỘộỚớỜờỞởỠỡỢợỤụỦủỨứỪừỬửỮữỰựỲỳỴỵỶỷỸỹỺỻỼỽỾỿἀἁἂἃἄἅἆἇἈἉἊἋἌἍἎἏἐἑἒἓἔἕἘἙἚἛἜἝἠἡἢἣἤἥἦἧἨἩἪἫἬἭἮἯἰἱἲἳἴἵἶἷἸἹἺἻἼἽἾἿὀὁὂὃὄὅὈὉὊὋὌὍὐὑὒὓὔὕὖὗὙὛὝὟὠὡὢὣὤὥὦὧὨὩὪὫὬὭὮὯὰάὲέὴήὶίὸόὺύὼώᾀᾁᾂᾃᾄᾅᾆᾇᾈᾉᾊᾋᾌᾍᾎᾏᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝᾞᾟᾠᾡᾢᾣᾤᾥᾦᾧᾨᾩᾪᾫᾬᾭᾮᾯᾰᾱᾲᾳᾴᾶᾷᾸᾹᾺΆᾼ
᾽
ι
᾿῀῁
ῂῃῄῆῇῈΈῊΉῌ
῍῎῏
ῐῑῒΐῖῗῘῙῚΊ
῝῞῟
ῠῡῢΰῤῥῦῧῨῩῪΎῬ
῭΅`
ῲῳῴῶῷῸΌῺΏῼ
´῾ ‐‑‒–—―‖‗‘’‚‛“”„‟†‡•‣․‥…‧
‰‱′″‴‵‶‷‸‹›※‼‽‾‿⁀⁁⁂⁃⁄⁅⁆⁇⁈⁉⁊⁋⁌⁍⁎⁏⁐⁑⁒⁓⁔⁕⁖⁗⁘⁙⁚⁛⁜⁝⁞
⁰ⁱ⁴⁵⁶⁷⁸⁹
⁺⁻⁼⁽⁾
ⁿ₀₁₂₃₄₅₆₇₈₉
₊₋₌₍₎
ₐₑₒₓₔ
₠₡₢₣₤₥₦₧₨₩₪₫€₭₮₯₰₱₲₳₴₵₶₷₸
⃒⃓⃘⃙⃚⃐⃑⃔⃕⃖⃗⃛⃜⃝⃞⃟⃠⃡⃢⃣⃤⃥⃦⃪⃫⃨⃬⃭⃮⃯⃧⃩⃰
℀℁
ℂ
℃℄℅℆
ℇ
℈℉
ℊℋℌℍℎℏℐℑℒℓ
℔
ℕ
№℗℘
ℙℚℛℜℝ
℞℟℠℡™℣
ℤ
℥
Ω
℧
ℨ
℩
KÅℬℭ
℮
ℯℰℱℲℳℴℵℶℷℸℹ
℺℻
ℼℽℾℿ
⅀⅁⅂⅃⅄
ⅅⅆⅇⅈⅉ
⅊⅋⅌⅍
ⅎ
⅏
⅐⅑⅒⅓⅔⅕⅖⅗⅘⅙⅚⅛⅜⅝⅞⅟ⅠⅡⅢⅣⅤⅥⅦⅧⅨⅩⅪⅫⅬⅭⅮⅯⅰⅱⅲⅳⅴⅵⅶⅷⅸⅹⅺⅻⅼⅽⅾⅿↀↁↂↃↄↅↆↇↈ↉
←↑→↓↔↕↖↗↘↙↚↛↜↝↞↟↠↡↢↣↤↥↦↧↨↩↪↫↬↭↮↯↰↱↲↳↴↵↶↷↸↹↺↻↼↽↾↿⇀⇁⇂⇃⇄⇅⇆⇇⇈⇉⇊⇋⇌⇍⇎⇏⇐⇑⇒⇓⇔⇕⇖⇗⇘⇙⇚⇛⇜⇝⇞⇟⇠⇡⇢⇣⇤⇥⇦⇧⇨⇩⇪⇫⇬⇭⇮⇯⇰⇱⇲⇳⇴⇵⇶⇷⇸⇹⇺⇻⇼⇽⇾⇿∀∁∂∃∄∅∆∇∈∉∊∋∌∍∎∏∐∑−∓∔∕∖∗∘∙√∛∜∝∞∟∠∡∢∣∤∥∦∧∨∩∪∫∬∭∮∯∰∱∲∳∴∵∶∷∸∹∺∻∼∽∾∿≀≁≂≃≄≅≆≇≈≉≊≋≌≍≎≏≐≑≒≓≔≕≖≗≘≙≚≛≜≝≞≟≠≡≢≣≤≥≦≧≨≩≪≫≬≭≮≯≰≱≲≳≴≵≶≷≸≹≺≻≼≽≾≿⊀⊁⊂⊃⊄⊅⊆⊇⊈⊉⊊⊋⊌⊍⊎⊏⊐⊑⊒⊓⊔⊕⊖⊗⊘⊙⊚⊛⊜⊝⊞⊟⊠⊡⊢⊣⊤⊥⊦⊧⊨⊩⊪⊫⊬⊭⊮⊯⊰⊱⊲⊳⊴⊵⊶⊷⊸⊹⊺⊻⊼⊽⊾⊿⋀⋁⋂⋃⋄⋅⋆⋇⋈⋉⋊⋋⋌⋍⋎⋏⋐⋑⋒⋓⋔⋕⋖⋗⋘⋙⋚⋛⋜⋝⋞⋟⋠⋡⋢⋣⋤⋥⋦⋧⋨⋩⋪⋫⋬⋭⋮⋯⋰⋱⋲⋳⋴⋵⋶⋷⋸⋹⋺⋻⋼⋽⋾⋿⌀⌁⌂⌃⌄⌅⌆⌇⌈⌉⌊⌋⌌⌍⌎⌏⌐⌑⌒⌓⌔⌕⌖⌗⌘⌙⌚⌛⌜⌝⌞⌟⌠⌡⌢⌣⌤⌥⌦⌧⌨〈〉⌫⌬⌭⌮⌯⌰⌱⌲⌳⌴⌵⌶⌷⌸⌹⌺⌻⌼⌽⌾⌿⍀⍁⍂⍃⍄⍅⍆⍇⍈⍉⍊⍋⍌⍍⍎⍏⍐⍑⍒⍓⍔⍕⍖⍗⍘⍙⍚⍛⍜⍝⍞⍟⍠⍡⍢⍣⍤⍥⍦⍧⍨⍩⍪⍫⍬⍭⍮⍯⍰⍱⍲⍳⍴⍵⍶⍷⍸⍹⍺⍻⍼⍽⍾⍿⎀⎁⎂⎃⎄⎅⎆⎇⎈⎉⎊⎋⎌⎍⎎⎏⎐⎑⎒⎓⎔⎕⎖⎗⎘⎙⎚⎛⎜⎝⎞⎟⎠⎡⎢⎣⎤⎥⎦⎧⎨⎩⎪⎫⎬⎭⎮⎯⎰⎱⎲⎳⎴⎵⎶⎷⎸⎹⎺⎻⎼⎽⎾⎿⏀⏁⏂⏃⏄⏅⏆⏇⏈⏉⏊⏋⏌⏍⏎⏏⏐⏑⏒⏓⏔⏕⏖⏗⏘⏙⏚⏛⏜⏝⏞⏟⏠⏡⏢⏣⏤⏥⏦⏧⏨␀␁␂␃␄␅␆␇␈␉␊␋␌␍␎␏␐␑␒␓␔␕␖␗␘␙␚␛␜␝␞␟␠␡␢␣␥␦⑀⑁⑂⑃⑄⑅⑆⑇⑈⑉⑊
①②③④⑤⑥⑦⑧⑨⑩⑪⑫⑬⑭⑮⑯⑰⑱⑲⑳⑴⑵⑶⑷⑸⑹⑺⑻⑼⑽⑾⑿⒀⒁⒂⒃⒄⒅⒆⒇⒈⒉⒊⒋⒌⒍⒎⒏⒐⒑⒒⒓⒔⒕⒖⒗⒘⒙⒚⒛
⒜⒝⒞⒟⒠⒡⒢⒣⒤⒥⒦⒧⒨⒩⒪⒫⒬⒭⒮⒯⒰⒱⒲⒳⒴⒵ⒶⒷⒸⒹⒺⒻⒼⒽⒾⒿⓀⓁⓂⓃⓄⓅⓆⓇⓈⓉⓊⓋⓌⓍⓎⓏⓐⓑⓒⓓⓔⓕⓖⓗⓘⓙⓚⓛⓜⓝⓞⓟⓠⓡⓢⓣⓤⓥⓦⓧⓨⓩ
⓪⓫⓬⓭⓮⓯⓰⓱⓲⓳⓴⓵⓶⓷⓸⓹⓺⓻⓼⓽⓾⓿
─━│┃┄┅┆┇┈┉┊┋┌┍┎┏┐┑┒┓└┕┖┗┘┙┚┛├┝┞┟┠┡┢┣┤┥┦┧┨┩┪┫┬┭┮┯┰┱┲┳┴┵┶┷┸┹┺┻┼┽┾┿╀╁╂╃╄╅╆╇╈╉╊╋╌╍╎╏═║╒╓╔╕╖╗╘╙╚╛╜╝╞╟╠╡╢╣╤╥╦╧╨╩╪╫╬╭╮╯╰╱╲╳╴╵╶╷╸╹╺╻╼╽╾╿▀▁▂▃▄▅▆▇█▉▊▋▌▍▎▏▐░▒▓▔▕▖▗▘▙▚▛▜▝▞▟■□▢▣▤▥▦▧▨▩▪▫▬▭▮▯▰▱▲△▴▵▶▷▸▹►▻▼▽▾▿◀◁◂◃◄◅◆◇◈◉◊○◌◍◎●◐◑◒◓◔◕◖◗◘◙◚◛◜◝◞◟◠◡◢◣◤◥◦◧◨◩◪◫◬◭◮◯◰◱◲◳◴◵◶◷◸◹◺◻◼◽◾◿☀☁☂☃☄★☆☇☈☉☊☋☌☍☎☏☐☑☒☓☔☕☖☗☘☙☚☛☜☝☞☟☠☡☢☣☤☥☦☧☨☩☪☫☬☭☮☯☰☱☲☳☴☵☶☷☸☹☺☻☼☽☾☿♀♁♂♃♄♅♆♇♈♉♊♋♌♍♎♏♐♑♒♓♔♕♖♗♘♙♚♛♜♝♞♟♠♡♢♣♤♥♦♧♨♩♪♫♬♭♮♯♰♱♲♳♴♵♶♷♸♹♺♻♼♽♾♿⚀⚁⚂⚃⚄⚅⚆⚇⚈⚉⚊⚋⚌⚍⚎⚏⚐⚑⚒⚓⚔⚕⚖⚗⚘⚙⚚⚛⚜⚝⚞⚟⚠⚡⚢⚣⚤⚥⚦⚧⚨⚩⚪⚫⚬⚭⚮⚯⚰⚱⚲⚳⚴⚵⚶⚷⚸⚹⚺⚻⚼⚽⚾⚿⛀⛁⛂⛃⛄⛅⛆⛇⛈⛉⛊⛋⛌⛍⛏⛐⛑⛒⛓⛔⛕⛖⛗⛘⛙⛚⛛⛜⛝⛞⛟⛠⛡⛣⛨⛩⛪⛫⛬⛭⛮⛯⛰⛱⛲⛳⛴⛵⛶⛷⛸⛹⛺⛻⛼⛽⛾⛿✁✂✃✄✆✇✈✉✌✍✎✏✐✑✒✓✔✕✖✗✘✙✚✛✜✝✞✟✠✡✢✣✤✥✦✧✩✪✫✬✭✮✯✰✱✲✳✴✵✶✷✸✹✺✻✼✽✾✿❀❁❂❃❄❅❆❇❈❉❊❋❍❏❐❑❒❖❗❘❙❚❛❜❝❞❡❢❣❤❥❦❧❨❩❪❫❬❭❮❯❰❱❲❳❴❵
❶❷❸❹❺❻❼❽❾❿➀➁➂➃➄➅➆➇➈➉➊➋➌➍➎➏➐➑➒➓
➔➘➙➚➛➜➝➞➟➠➡➢➣➤➥➦➧➨➩➪➫➬➭➮➯➱➲➳➴➵➶➷➸➹➺➻➼➽➾⟀⟁⟂⟃⟄⟅⟆⟇⟈⟉⟊⟌⟐⟑⟒⟓⟔⟕⟖⟗⟘⟙⟚⟛⟜⟝⟞⟟⟠⟡⟢⟣⟤⟥⟦⟧⟨⟩⟪⟫⟬⟭⟮⟯⟰⟱⟲⟳⟴⟵⟶⟷⟸⟹⟺⟻⟼⟽⟾⟿⠀⠁⠂⠃⠄⠅⠆⠇⠈⠉⠊⠋⠌⠍⠎⠏⠐⠑⠒⠓⠔⠕⠖⠗⠘⠙⠚⠛⠜⠝⠞⠟⠠⠡⠢⠣⠤⠥⠦⠧⠨⠩⠪⠫⠬⠭⠮⠯⠰⠱⠲⠳⠴⠵⠶⠷⠸⠹⠺⠻⠼⠽⠾⠿⡀⡁⡂⡃⡄⡅⡆⡇⡈⡉⡊⡋⡌⡍⡎⡏⡐⡑⡒⡓⡔⡕⡖⡗⡘⡙⡚⡛⡜⡝⡞⡟⡠⡡⡢⡣⡤⡥⡦⡧⡨⡩⡪⡫⡬⡭⡮⡯⡰⡱⡲⡳⡴⡵⡶⡷⡸⡹⡺⡻⡼⡽⡾⡿⢀⢁⢂⢃⢄⢅⢆⢇⢈⢉⢊⢋⢌⢍⢎⢏⢐⢑⢒⢓⢔⢕⢖⢗⢘⢙⢚⢛⢜⢝⢞⢟⢠⢡⢢⢣⢤⢥⢦⢧⢨⢩⢪⢫⢬⢭⢮⢯⢰⢱⢲⢳⢴⢵⢶⢷⢸⢹⢺⢻⢼⢽⢾⢿⣀⣁⣂⣃⣄⣅⣆⣇⣈⣉⣊⣋⣌⣍⣎⣏⣐⣑⣒⣓⣔⣕⣖⣗⣘⣙⣚⣛⣜⣝⣞⣟⣠⣡⣢⣣⣤⣥⣦⣧⣨⣩⣪⣫⣬⣭⣮⣯⣰⣱⣲⣳⣴⣵⣶⣷⣸⣹⣺⣻⣼⣽⣾⣿⤀⤁⤂⤃⤄⤅⤆⤇⤈⤉⤊⤋⤌⤍⤎⤏⤐⤑⤒⤓⤔⤕⤖⤗⤘⤙⤚⤛⤜⤝⤞⤟⤠⤡⤢⤣⤤⤥⤦⤧⤨⤩⤪⤫⤬⤭⤮⤯⤰⤱⤲⤳⤴⤵⤶⤷⤸⤹⤺⤻⤼⤽⤾⤿⥀⥁⥂⥃⥄⥅⥆⥇⥈⥉⥊⥋⥌⥍⥎⥏⥐⥑⥒⥓⥔⥕⥖⥗⥘⥙⥚⥛⥜⥝⥞⥟⥠⥡⥢⥣⥤⥥⥦⥧⥨⥩⥪⥫⥬⥭⥮⥯⥰⥱⥲⥳⥴⥵⥶⥷⥸⥹⥺⥻⥼⥽⥾⥿⦀⦁⦂⦃⦄⦅⦆⦇⦈⦉⦊⦋⦌⦍⦎⦏⦐⦑⦒⦓⦔⦕⦖⦗⦘⦙⦚⦛⦜⦝⦞⦟⦠⦡⦢⦣⦤⦥⦦⦧⦨⦩⦪⦫⦬⦭⦮⦯⦰⦱⦲⦳⦴⦵⦶⦷⦸⦹⦺⦻⦼⦽⦾⦿⧀⧁⧂⧃⧄⧅⧆⧇⧈⧉⧊⧋⧌⧍⧎⧏⧐⧑⧒⧓⧔⧕⧖⧗⧘⧙⧚⧛⧜⧝⧞⧟⧠⧡⧢⧣⧤⧥⧦⧧⧨⧩⧪⧫⧬⧭⧮⧯⧰⧱⧲⧳⧴⧵⧶⧷⧸⧹⧺⧻⧼⧽⧾⧿⨀⨁⨂⨃⨄⨅⨆⨇⨈⨉⨊⨋⨌⨍⨎⨏⨐⨑⨒⨓⨔⨕⨖⨗⨘⨙⨚⨛⨜⨝⨞⨟⨠⨡⨢⨣⨤⨥⨦⨧⨨⨩⨪⨫⨬⨭⨮⨯⨰⨱⨲⨳⨴⨵⨶⨷⨸⨹⨺⨻⨼⨽⨾⨿⩀⩁⩂⩃⩄⩅⩆⩇⩈⩉⩊⩋⩌⩍⩎⩏⩐⩑⩒⩓⩔⩕⩖⩗⩘⩙⩚⩛⩜⩝⩞⩟⩠⩡⩢⩣⩤⩥⩦⩧⩨⩩⩪⩫⩬⩭⩮⩯⩰⩱⩲⩳⩴⩵⩶⩷⩸⩹⩺⩻⩼⩽⩾⩿⪀⪁⪂⪃⪄⪅⪆⪇⪈⪉⪊⪋⪌⪍⪎⪏⪐⪑⪒⪓⪔⪕⪖⪗⪘⪙⪚⪛⪜⪝⪞⪟⪠⪡⪢⪣⪤⪥⪦⪧⪨⪩⪪⪫⪬⪭⪮⪯⪰⪱⪲⪳⪴⪵⪶⪷⪸⪹⪺⪻⪼⪽⪾⪿⫀⫁⫂⫃⫄⫅⫆⫇⫈⫉⫊⫋⫌⫍⫎⫏⫐⫑⫒⫓⫔⫕⫖⫗⫘⫙⫚⫛⫝̸⫝⫞⫟⫠⫡⫢⫣⫤⫥⫦⫧⫨⫩⫪⫫⫬⫭⫮⫯⫰⫱⫲⫳⫴⫵⫶⫷⫸⫹⫺⫻⫼⫽⫾⫿⬀⬁⬂⬃⬄⬅⬆⬇⬈⬉⬊⬋⬌⬍⬎⬏⬐⬑⬒⬓⬔⬕⬖⬗⬘⬙⬚⬛⬜⬝⬞⬟⬠⬡⬢⬣⬤⬥⬦⬧⬨⬩⬪⬫⬬⬭⬮⬯⬰⬱⬲⬳⬴⬵⬶⬷⬸⬹⬺⬻⬼⬽⬾⬿⭀⭁⭂⭃⭄⭅⭆⭇⭈⭉⭊⭋⭌⭐⭑⭒⭓⭔⭕⭖⭗⭘⭙
ⰀⰁⰂⰃⰄⰅⰆⰇⰈⰉⰊⰋⰌⰍⰎⰏⰐⰑⰒⰓⰔⰕⰖⰗⰘⰙⰚⰛⰜⰝⰞⰟⰠⰡⰢⰣⰤⰥⰦⰧⰨⰩⰪⰫⰬⰭⰮⰰⰱⰲⰳⰴⰵⰶⰷⰸⰹⰺⰻⰼⰽⰾⰿⱀⱁⱂⱃⱄⱅⱆⱇⱈⱉⱊⱋⱌⱍⱎⱏⱐⱑⱒⱓⱔⱕⱖⱗⱘⱙⱚⱛⱜⱝⱞⱠⱡⱢⱣⱤⱥⱦⱧⱨⱩⱪⱫⱬⱭⱮⱯⱰⱱⱲⱳⱴⱵⱶⱷⱸⱹⱺⱻⱼⱽⱾⱿⲀⲁⲂⲃⲄⲅⲆⲇⲈⲉⲊⲋⲌⲍⲎⲏⲐⲑⲒⲓⲔⲕⲖⲗⲘⲙⲚⲛⲜⲝⲞⲟⲠⲡⲢⲣⲤⲥⲦⲧⲨⲩⲪⲫⲬⲭⲮⲯⲰⲱⲲⲳⲴⲵⲶⲷⲸⲹⲺⲻⲼⲽⲾⲿⳀⳁⳂⳃⳄⳅⳆⳇⳈⳉⳊⳋⳌⳍⳎⳏⳐⳑⳒⳓⳔⳕⳖⳗⳘⳙⳚⳛⳜⳝⳞⳟⳠⳡⳢⳣⳤ
⳥⳦⳧⳨⳩⳪
ⳫⳬⳭⳮ⳯⳰⳱
⳹⳺⳻⳼
⳽
⳾⳿
ⴀⴁⴂⴃⴄⴅⴆⴇⴈⴉⴊⴋⴌⴍⴎⴏⴐⴑⴒⴓⴔⴕⴖⴗⴘⴙⴚⴛⴜⴝⴞⴟⴠⴡⴢⴣⴤⴥⴰⴱⴲⴳⴴⴵⴶⴷⴸⴹⴺⴻⴼⴽⴾⴿⵀⵁⵂⵃⵄⵅⵆⵇⵈⵉⵊⵋⵌⵍⵎⵏⵐⵑⵒⵓⵔⵕⵖⵗⵘⵙⵚⵛⵜⵝⵞⵟⵠⵡⵢⵣⵤⵥⵯⶀⶁⶂⶃⶄⶅⶆⶇⶈⶉⶊⶋⶌⶍⶎⶏⶐⶑⶒⶓⶔⶕⶖⶠⶡⶢⶣⶤⶥⶦⶨⶩⶪⶫⶬⶭⶮⶰⶱⶲⶳⶴⶵⶶⶸⶹⶺⶻⶼⶽⶾⷀⷁⷂⷃⷄⷅⷆⷈⷉⷊⷋⷌⷍⷎⷐⷑⷒⷓⷔⷕⷖⷘⷙⷚⷛⷜⷝⷞⷠⷡⷢⷣⷤⷥⷦⷧⷨⷩⷪⷫⷬⷭⷮⷯⷰⷱⷲⷳⷴⷵⷶⷷⷸⷹⷺⷻⷼⷽⷾⷿ
⸀⸁⸂⸃⸄⸅⸆⸇⸈⸉⸊⸋⸌⸍⸎⸏⸐⸑⸒⸓⸔⸕⸖⸗⸘⸙⸚⸛⸜⸝⸞⸟⸠⸡⸢⸣⸤⸥⸦⸧⸨⸩⸪⸫⸬⸭⸮
ⸯ
⸰⸱⺀⺁⺂⺃⺄⺅⺆⺇⺈⺉⺊⺋⺌⺍⺎⺏⺐⺑⺒⺓⺔⺕⺖⺗⺘⺙⺛⺜⺝⺞⺟⺠⺡⺢⺣⺤⺥⺦⺧⺨⺩⺪⺫⺬⺭⺮⺯⺰⺱⺲⺳⺴⺵⺶⺷⺸⺹⺺⺻⺼⺽⺾⺿⻀⻁⻂⻃⻄⻅⻆⻇⻈⻉⻊⻋⻌⻍⻎⻏⻐⻑⻒⻓⻔⻕⻖⻗⻘⻙⻚⻛⻜⻝⻞⻟⻠⻡⻢⻣⻤⻥⻦⻧⻨⻩⻪⻫⻬⻭⻮⻯⻰⻱⻲⻳⼀⼁⼂⼃⼄⼅⼆⼇⼈⼉⼊⼋⼌⼍⼎⼏⼐⼑⼒⼓⼔⼕⼖⼗⼘⼙⼚⼛⼜⼝⼞⼟⼠⼡⼢⼣⼤⼥⼦⼧⼨⼩⼪⼫⼬⼭⼮⼯⼰⼱⼲⼳⼴⼵⼶⼷⼸⼹⼺⼻⼼⼽⼾⼿⽀⽁⽂⽃⽄⽅⽆⽇⽈⽉⽊⽋⽌⽍⽎⽏⽐⽑⽒⽓⽔⽕⽖⽗⽘⽙⽚⽛⽜⽝⽞⽟⽠⽡⽢⽣⽤⽥⽦⽧⽨⽩⽪⽫⽬⽭⽮⽯⽰⽱⽲⽳⽴⽵⽶⽷⽸⽹⽺⽻⽼⽽⽾⽿⾀⾁⾂⾃⾄⾅⾆⾇⾈⾉⾊⾋⾌⾍⾎⾏⾐⾑⾒⾓⾔⾕⾖⾗⾘⾙⾚⾛⾜⾝⾞⾟⾠⾡⾢⾣⾤⾥⾦⾧⾨⾩⾪⾫⾬⾭⾮⾯⾰⾱⾲⾳⾴⾵⾶⾷⾸⾹⾺⾻⾼⾽⾾⾿⿀⿁⿂⿃⿄⿅⿆⿇⿈⿉⿊⿋⿌⿍⿎⿏⿐⿑⿒⿓⿔⿕⿰⿱⿲⿳⿴⿵⿶⿷⿸⿹⿺⿻ 、。〃〄
々〆〇
〈〉《》「」『』【】〒〓〔〕〖〗〘〙〚〛〜〝〞〟〠
〡〢〣〤〥〦〧〨〩〪〭〮〯〫〬
〰
〱〲〳〴〵
〶〷
〸〹〺〻〼
〽〾〿
ぁあぃいぅうぇえぉおかがきぎくぐけげこごさざしじすずせぜそぞただちぢっつづてでとどなにぬねのはばぱひびぴふぶぷへべぺほぼぽまみむめもゃやゅゆょよらりるれろゎわゐゑをんゔゕゖ゙゚
゛゜
ゝゞゟ
゠
ァアィイゥウェエォオカガキギクグケゲコゴサザシジスズセゼソゾタダチヂッツヅテデトドナニヌネノハバパヒビピフブプヘベペホボポマミムメモャヤュユョヨラリルレロヮワヰヱヲンヴヵヶヷヸヹヺ
・
ーヽヾヿㄅㄆㄇㄈㄉㄊㄋㄌㄍㄎㄏㄐㄑㄒㄓㄔㄕㄖㄗㄘㄙㄚㄛㄜㄝㄞㄟㄠㄡㄢㄣㄤㄥㄦㄧㄨㄩㄪㄫㄬㄭㄱㄲㄳㄴㄵㄶㄷㄸㄹㄺㄻㄼㄽㄾㄿㅀㅁㅂㅃㅄㅅㅆㅇㅈㅉㅊㅋㅌㅍㅎㅏㅐㅑㅒㅓㅔㅕㅖㅗㅘㅙㅚㅛㅜㅝㅞㅟㅠㅡㅢㅣㅤㅥㅦㅧㅨㅩㅪㅫㅬㅭㅮㅯㅰㅱㅲㅳㅴㅵㅶㅷㅸㅹㅺㅻㅼㅽㅾㅿㆀㆁㆂㆃㆄㆅㆆㆇㆈㆉㆊㆋㆌㆍㆎ
㆐㆑
㆒㆓㆔㆕
㆖㆗㆘㆙㆚㆛㆜㆝㆞㆟
ㆠㆡㆢㆣㆤㆥㆦㆧㆨㆩㆪㆫㆬㆭㆮㆯㆰㆱㆲㆳㆴㆵㆶㆷ
㇀㇁㇂㇃㇄㇅㇆㇇㇈㇉㇊㇋㇌㇍㇎㇏㇐㇑㇒㇓㇔㇕㇖㇗㇘㇙㇚㇛㇜㇝㇞㇟㇠㇡㇢㇣
ㇰㇱㇲㇳㇴㇵㇶㇷㇸㇹㇺㇻㇼㇽㇾㇿ
㈀㈁㈂㈃㈄㈅㈆㈇㈈㈉㈊㈋㈌㈍㈎㈏㈐㈑㈒㈓㈔㈕㈖㈗㈘㈙㈚㈛㈜㈝㈞
㈠㈡㈢㈣㈤㈥㈦㈧㈨㈩
㈪㈫㈬㈭㈮㈯㈰㈱㈲㈳㈴㈵㈶㈷㈸㈹㈺㈻㈼㈽㈾㈿㉀㉁㉂㉃㉄㉅㉆㉇㉈㉉㉊㉋㉌㉍㉎㉏㉐
㉑㉒㉓㉔㉕㉖㉗㉘㉙㉚㉛㉜㉝㉞㉟
㉠㉡㉢㉣㉤㉥㉦㉧㉨㉩㉪㉫㉬㉭㉮㉯㉰㉱㉲㉳㉴㉵㉶㉷㉸㉹㉺㉻㉼㉽㉾㉿
㊀㊁㊂㊃㊄㊅㊆㊇㊈㊉
㊊㊋㊌㊍㊎㊏㊐㊑㊒㊓㊔㊕㊖㊗㊘㊙㊚㊛㊜㊝㊞㊟㊠㊡㊢㊣㊤㊥㊦㊧㊨㊩㊪㊫㊬㊭㊮㊯㊰
㊱㊲㊳㊴㊵㊶㊷㊸㊹㊺㊻㊼㊽㊾㊿
㋀㋁㋂㋃㋄㋅㋆㋇㋈㋉㋊㋋㋌㋍㋎㋏㋐㋑㋒㋓㋔㋕㋖㋗㋘㋙㋚㋛㋜㋝㋞㋟㋠㋡㋢㋣㋤㋥㋦㋧㋨㋩㋪㋫㋬㋭㋮㋯㋰㋱㋲㋳㋴㋵㋶㋷㋸㋹㋺㋻㋼㋽㋾㌀㌁㌂㌃㌄㌅㌆㌇㌈㌉㌊㌋㌌㌍㌎㌏㌐㌑㌒㌓㌔㌕㌖㌗㌘㌙㌚㌛㌜㌝㌞㌟㌠㌡㌢㌣㌤㌥㌦㌧㌨㌩㌪㌫㌬㌭㌮㌯㌰㌱㌲㌳㌴㌵㌶㌷㌸㌹㌺㌻㌼㌽㌾㌿㍀㍁㍂㍃㍄㍅㍆㍇㍈㍉㍊㍋㍌㍍㍎㍏㍐㍑㍒㍓㍔㍕㍖㍗㍘㍙㍚㍛㍜㍝㍞㍟㍠㍡㍢㍣㍤㍥㍦㍧㍨㍩㍪㍫㍬㍭㍮㍯㍰㍱㍲㍳㍴㍵㍶㍷㍸㍹㍺㍻㍼㍽㍾㍿㎀㎁㎂㎃㎄㎅㎆㎇㎈㎉㎊㎋㎌㎍㎎㎏㎐㎑㎒㎓㎔㎕㎖㎗㎘㎙㎚㎛㎜㎝㎞㎟㎠㎡㎢㎣㎤㎥㎦㎧㎨㎩㎪㎫㎬㎭㎮㎯㎰㎱㎲㎳㎴㎵㎶㎷㎸㎹㎺㎻㎼㎽㎾㎿㏀㏁㏂㏃㏄㏅㏆㏇㏈㏉㏊㏋㏌㏍㏎㏏㏐㏑㏒㏓㏔㏕㏖㏗㏘㏙㏚㏛㏜㏝㏞㏟㏠㏡㏢㏣㏤㏥㏦㏧㏨㏩㏪㏫㏬㏭㏮㏯㏰㏱㏲㏳㏴㏵㏶㏷㏸㏹㏺㏻㏼㏽㏾㏿
㐀䶵
䷀䷁䷂䷃䷄䷅䷆䷇䷈䷉䷊䷋䷌䷍䷎䷏䷐䷑䷒䷓䷔䷕䷖䷗䷘䷙䷚䷛䷜䷝䷞䷟䷠䷡䷢䷣䷤䷥䷦䷧䷨䷩䷪䷫䷬䷭䷮䷯䷰䷱䷲䷳䷴䷵䷶䷷䷸䷹䷺䷻䷼䷽䷾䷿
一鿋ꀀꀁꀂꀃꀄꀅꀆꀇꀈꀉꀊꀋꀌꀍꀎꀏꀐꀑꀒꀓꀔꀕꀖꀗꀘꀙꀚꀛꀜꀝꀞꀟꀠꀡꀢꀣꀤꀥꀦꀧꀨꀩꀪꀫꀬꀭꀮꀯꀰꀱꀲꀳꀴꀵꀶꀷꀸꀹꀺꀻꀼꀽꀾꀿꁀꁁꁂꁃꁄꁅꁆꁇꁈꁉꁊꁋꁌꁍꁎꁏꁐꁑꁒꁓꁔꁕꁖꁗꁘꁙꁚꁛꁜꁝꁞꁟꁠꁡꁢꁣꁤꁥꁦꁧꁨꁩꁪꁫꁬꁭꁮꁯꁰꁱꁲꁳꁴꁵꁶꁷꁸꁹꁺꁻꁼꁽꁾꁿꂀꂁꂂꂃꂄꂅꂆꂇꂈꂉꂊꂋꂌꂍꂎꂏꂐꂑꂒꂓꂔꂕꂖꂗꂘꂙꂚꂛꂜꂝꂞꂟꂠꂡꂢꂣꂤꂥꂦꂧꂨꂩꂪꂫꂬꂭꂮꂯꂰꂱꂲꂳꂴꂵꂶꂷꂸꂹꂺꂻꂼꂽꂾꂿꃀꃁꃂꃃꃄꃅꃆꃇꃈꃉꃊꃋꃌꃍꃎꃏꃐꃑꃒꃓꃔꃕꃖꃗꃘꃙꃚꃛꃜꃝꃞꃟꃠꃡꃢꃣꃤꃥꃦꃧꃨꃩꃪꃫꃬꃭꃮꃯꃰꃱꃲꃳꃴꃵꃶꃷꃸꃹꃺꃻꃼꃽꃾꃿꄀꄁꄂꄃꄄꄅꄆꄇꄈꄉꄊꄋꄌꄍꄎꄏꄐꄑꄒꄓꄔꄕꄖꄗꄘꄙꄚꄛꄜꄝꄞꄟꄠꄡꄢꄣꄤꄥꄦꄧꄨꄩꄪꄫꄬꄭꄮꄯꄰꄱꄲꄳꄴꄵꄶꄷꄸꄹꄺꄻꄼꄽꄾꄿꅀꅁꅂꅃꅄꅅꅆꅇꅈꅉꅊꅋꅌꅍꅎꅏꅐꅑꅒꅓꅔꅕꅖꅗꅘꅙꅚꅛꅜꅝꅞꅟꅠꅡꅢꅣꅤꅥꅦꅧꅨꅩꅪꅫꅬꅭꅮꅯꅰꅱꅲꅳꅴꅵꅶꅷꅸꅹꅺꅻꅼꅽꅾꅿꆀꆁꆂꆃꆄꆅꆆꆇꆈꆉꆊꆋꆌꆍꆎꆏꆐꆑꆒꆓꆔꆕꆖꆗꆘꆙꆚꆛꆜꆝꆞꆟꆠꆡꆢꆣꆤꆥꆦꆧꆨꆩꆪꆫꆬꆭꆮꆯꆰꆱꆲꆳꆴꆵꆶꆷꆸꆹꆺꆻꆼꆽꆾꆿꇀꇁꇂꇃꇄꇅꇆꇇꇈꇉꇊꇋꇌꇍꇎꇏꇐꇑꇒꇓꇔꇕꇖꇗꇘꇙꇚꇛꇜꇝꇞꇟꇠꇡꇢꇣꇤꇥꇦꇧꇨꇩꇪꇫꇬꇭꇮꇯꇰꇱꇲꇳꇴꇵꇶꇷꇸꇹꇺꇻꇼꇽꇾꇿꈀꈁꈂꈃꈄꈅꈆꈇꈈꈉꈊꈋꈌꈍꈎꈏꈐꈑꈒꈓꈔꈕꈖꈗꈘꈙꈚꈛꈜꈝꈞꈟꈠꈡꈢꈣꈤꈥꈦꈧꈨꈩꈪꈫꈬꈭꈮꈯꈰꈱꈲꈳꈴꈵꈶꈷꈸꈹꈺꈻꈼꈽꈾꈿꉀꉁꉂꉃꉄꉅꉆꉇꉈꉉꉊꉋꉌꉍꉎꉏꉐꉑꉒꉓꉔꉕꉖꉗꉘꉙꉚꉛꉜꉝꉞꉟꉠꉡꉢꉣꉤꉥꉦꉧꉨꉩꉪꉫꉬꉭꉮꉯꉰꉱꉲꉳꉴꉵꉶꉷꉸꉹꉺꉻꉼꉽꉾꉿꊀꊁꊂꊃꊄꊅꊆꊇꊈꊉꊊꊋꊌꊍꊎꊏꊐꊑꊒꊓꊔꊕꊖꊗꊘꊙꊚꊛꊜꊝꊞꊟꊠꊡꊢꊣꊤꊥꊦꊧꊨꊩꊪꊫꊬꊭꊮꊯꊰꊱꊲꊳꊴꊵꊶꊷꊸꊹꊺꊻꊼꊽꊾꊿꋀꋁꋂꋃꋄꋅꋆꋇꋈꋉꋊꋋꋌꋍꋎꋏꋐꋑꋒꋓꋔꋕꋖꋗꋘꋙꋚꋛꋜꋝꋞꋟꋠꋡꋢꋣꋤꋥꋦꋧꋨꋩꋪꋫꋬꋭꋮꋯꋰꋱꋲꋳꋴꋵꋶꋷꋸꋹꋺꋻꋼꋽꋾꋿꌀꌁꌂꌃꌄꌅꌆꌇꌈꌉꌊꌋꌌꌍꌎꌏꌐꌑꌒꌓꌔꌕꌖꌗꌘꌙꌚꌛꌜꌝꌞꌟꌠꌡꌢꌣꌤꌥꌦꌧꌨꌩꌪꌫꌬꌭꌮꌯꌰꌱꌲꌳꌴꌵꌶꌷꌸꌹꌺꌻꌼꌽꌾꌿꍀꍁꍂꍃꍄꍅꍆꍇꍈꍉꍊꍋꍌꍍꍎꍏꍐꍑꍒꍓꍔꍕꍖꍗꍘꍙꍚꍛꍜꍝꍞꍟꍠꍡꍢꍣꍤꍥꍦꍧꍨꍩꍪꍫꍬꍭꍮꍯꍰꍱꍲꍳꍴꍵꍶꍷꍸꍹꍺꍻꍼꍽꍾꍿꎀꎁꎂꎃꎄꎅꎆꎇꎈꎉꎊꎋꎌꎍꎎꎏꎐꎑꎒꎓꎔꎕꎖꎗꎘꎙꎚꎛꎜꎝꎞꎟꎠꎡꎢꎣꎤꎥꎦꎧꎨꎩꎪꎫꎬꎭꎮꎯꎰꎱꎲꎳꎴꎵꎶꎷꎸꎹꎺꎻꎼꎽꎾꎿꏀꏁꏂꏃꏄꏅꏆꏇꏈꏉꏊꏋꏌꏍꏎꏏꏐꏑꏒꏓꏔꏕꏖꏗꏘꏙꏚꏛꏜꏝꏞꏟꏠꏡꏢꏣꏤꏥꏦꏧꏨꏩꏪꏫꏬꏭꏮꏯꏰꏱꏲꏳꏴꏵꏶꏷꏸꏹꏺꏻꏼꏽꏾꏿꐀꐁꐂꐃꐄꐅꐆꐇꐈꐉꐊꐋꐌꐍꐎꐏꐐꐑꐒꐓꐔꐕꐖꐗꐘꐙꐚꐛꐜꐝꐞꐟꐠꐡꐢꐣꐤꐥꐦꐧꐨꐩꐪꐫꐬꐭꐮꐯꐰꐱꐲꐳꐴꐵꐶꐷꐸꐹꐺꐻꐼꐽꐾꐿꑀꑁꑂꑃꑄꑅꑆꑇꑈꑉꑊꑋꑌꑍꑎꑏꑐꑑꑒꑓꑔꑕꑖꑗꑘꑙꑚꑛꑜꑝꑞꑟꑠꑡꑢꑣꑤꑥꑦꑧꑨꑩꑪꑫꑬꑭꑮꑯꑰꑱꑲꑳꑴꑵꑶꑷꑸꑹꑺꑻꑼꑽꑾꑿꒀꒁꒂꒃꒄꒅꒆꒇꒈꒉꒊꒋꒌ
꒐꒑꒒꒓꒔꒕꒖꒗꒘꒙꒚꒛꒜꒝꒞꒟꒠꒡꒢꒣꒤꒥꒦꒧꒨꒩꒪꒫꒬꒭꒮꒯꒰꒱꒲꒳꒴꒵꒶꒷꒸꒹꒺꒻꒼꒽꒾꒿꓀꓁꓂꓃꓄꓅꓆
ꓐꓑꓒꓓꓔꓕꓖꓗꓘꓙꓚꓛꓜꓝꓞꓟꓠꓡꓢꓣꓤꓥꓦꓧꓨꓩꓪꓫꓬꓭꓮꓯꓰꓱꓲꓳꓴꓵꓶꓷꓸꓹꓺꓻꓼꓽ
꓾꓿
ꔀꔁꔂꔃꔄꔅꔆꔇꔈꔉꔊꔋꔌꔍꔎꔏꔐꔑꔒꔓꔔꔕꔖꔗꔘꔙꔚꔛꔜꔝꔞꔟꔠꔡꔢꔣꔤꔥꔦꔧꔨꔩꔪꔫꔬꔭꔮꔯꔰꔱꔲꔳꔴꔵꔶꔷꔸꔹꔺꔻꔼꔽꔾꔿꕀꕁꕂꕃꕄꕅꕆꕇꕈꕉꕊꕋꕌꕍꕎꕏꕐꕑꕒꕓꕔꕕꕖꕗꕘꕙꕚꕛꕜꕝꕞꕟꕠꕡꕢꕣꕤꕥꕦꕧꕨꕩꕪꕫꕬꕭꕮꕯꕰꕱꕲꕳꕴꕵꕶꕷꕸꕹꕺꕻꕼꕽꕾꕿꖀꖁꖂꖃꖄꖅꖆꖇꖈꖉꖊꖋꖌꖍꖎꖏꖐꖑꖒꖓꖔꖕꖖꖗꖘꖙꖚꖛꖜꖝꖞꖟꖠꖡꖢꖣꖤꖥꖦꖧꖨꖩꖪꖫꖬꖭꖮꖯꖰꖱꖲꖳꖴꖵꖶꖷꖸꖹꖺꖻꖼꖽꖾꖿꗀꗁꗂꗃꗄꗅꗆꗇꗈꗉꗊꗋꗌꗍꗎꗏꗐꗑꗒꗓꗔꗕꗖꗗꗘꗙꗚꗛꗜꗝꗞꗟꗠꗡꗢꗣꗤꗥꗦꗧꗨꗩꗪꗫꗬꗭꗮꗯꗰꗱꗲꗳꗴꗵꗶꗷꗸꗹꗺꗻꗼꗽꗾꗿꘀꘁꘂꘃꘄꘅꘆꘇꘈꘉꘊꘋꘌ
꘍꘎꘏
ꘐꘑꘒꘓꘔꘕꘖꘗꘘꘙꘚꘛꘜꘝꘞꘟ꘠꘡꘢꘣꘤꘥꘦꘧꘨꘩ꘪꘫꙀꙁꙂꙃꙄꙅꙆꙇꙈꙉꙊꙋꙌꙍꙎꙏꙐꙑꙒꙓꙔꙕꙖꙗꙘꙙꙚꙛꙜꙝꙞꙟꙢꙣꙤꙥꙦꙧꙨꙩꙪꙫꙬꙭꙮ꙯꙰꙱꙲
꙳
꙼꙽
꙾
ꙿꚀꚁꚂꚃꚄꚅꚆꚇꚈꚉꚊꚋꚌꚍꚎꚏꚐꚑꚒꚓꚔꚕꚖꚗꚠꚡꚢꚣꚤꚥꚦꚧꚨꚩꚪꚫꚬꚭꚮꚯꚰꚱꚲꚳꚴꚵꚶꚷꚸꚹꚺꚻꚼꚽꚾꚿꛀꛁꛂꛃꛄꛅꛆꛇꛈꛉꛊꛋꛌꛍꛎꛏꛐꛑꛒꛓꛔꛕꛖꛗꛘꛙꛚꛛꛜꛝꛞꛟꛠꛡꛢꛣꛤꛥꛦꛧꛨꛩꛪꛫꛬꛭꛮꛯ꛰꛱
꛲꛳꛴꛵꛶꛷꜀꜁꜂꜃꜄꜅꜆꜇꜈꜉꜊꜋꜌꜍꜎꜏꜐꜑꜒꜓꜔꜕꜖
ꜗꜘꜙꜚꜛꜜꜝꜞꜟ
꜠꜡
ꜢꜣꜤꜥꜦꜧꜨꜩꜪꜫꜬꜭꜮꜯꜰꜱꜲꜳꜴꜵꜶꜷꜸꜹꜺꜻꜼꜽꜾꜿꝀꝁꝂꝃꝄꝅꝆꝇꝈꝉꝊꝋꝌꝍꝎꝏꝐꝑꝒꝓꝔꝕꝖꝗꝘꝙꝚꝛꝜꝝꝞꝟꝠꝡꝢꝣꝤꝥꝦꝧꝨꝩꝪꝫꝬꝭꝮꝯꝰꝱꝲꝳꝴꝵꝶꝷꝸꝹꝺꝻꝼꝽꝾꝿꞀꞁꞂꞃꞄꞅꞆꞇꞈ
꞉꞊
Ꞌꞌꟻꟼꟽꟾꟿꠀꠁꠂꠃꠄꠅ꠆ꠇꠈꠉꠊꠋꠌꠍꠎꠏꠐꠑꠒꠓꠔꠕꠖꠗꠘꠙꠚꠛꠜꠝꠞꠟꠠꠡꠢꠣꠤꠥꠦꠧ
꠨꠩꠪꠫
꠰꠱꠲꠳꠴꠵
꠶꠷꠸꠹
ꡀꡁꡂꡃꡄꡅꡆꡇꡈꡉꡊꡋꡌꡍꡎꡏꡐꡑꡒꡓꡔꡕꡖꡗꡘꡙꡚꡛꡜꡝꡞꡟꡠꡡꡢꡣꡤꡥꡦꡧꡨꡩꡪꡫꡬꡭꡮꡯꡰꡱꡲꡳ
꡴꡵꡶꡷
ꢀꢁꢂꢃꢄꢅꢆꢇꢈꢉꢊꢋꢌꢍꢎꢏꢐꢑꢒꢓꢔꢕꢖꢗꢘꢙꢚꢛꢜꢝꢞꢟꢠꢡꢢꢣꢤꢥꢦꢧꢨꢩꢪꢫꢬꢭꢮꢯꢰꢱꢲꢳꢴꢵꢶꢷꢸꢹꢺꢻꢼꢽꢾꢿꣀꣁꣂꣃ꣄
꣎꣏
꣐꣑꣒꣓꣔꣕꣖꣗꣘꣙꣠꣡꣢꣣꣤꣥꣦꣧꣨꣩꣪꣫꣬꣭꣮꣯꣰꣱ꣲꣳꣴꣵꣶꣷ
꣸꣹꣺
ꣻ꤀꤁꤂꤃꤄꤅꤆꤇꤈꤉ꤊꤋꤌꤍꤎꤏꤐꤑꤒꤓꤔꤕꤖꤗꤘꤙꤚꤛꤜꤝꤞꤟꤠꤡꤢꤣꤤꤥꤦꤧꤨꤩꤪ꤫꤬꤭
꤮꤯
ꤰꤱꤲꤳꤴꤵꤶꤷꤸꤹꤺꤻꤼꤽꤾꤿꥀꥁꥂꥃꥄꥅꥆꥇꥈꥉꥊꥋꥌꥍꥎꥏꥐꥑꥒ꥓
꥟
ꥠꥡꥢꥣꥤꥥꥦꥧꥨꥩꥪꥫꥬꥭꥮꥯꥰꥱꥲꥳꥴꥵꥶꥷꥸꥹꥺꥻꥼꦀꦁꦂꦃꦄꦅꦆꦇꦈꦉꦊꦋꦌꦍꦎꦏꦐꦑꦒꦓꦔꦕꦖꦗꦘꦙꦚꦛꦜꦝꦞꦟꦠꦡꦢꦣꦤꦥꦦꦧꦨꦩꦪꦫꦬꦭꦮꦯꦰꦱꦲ꦳ꦴꦵꦶꦷꦸꦹꦺꦻꦼꦽꦾꦿ꧀
꧁꧂꧃꧄꧅꧆꧇꧈꧉꧊꧋꧌꧍
ꧏ꧐꧑꧒꧓꧔꧕꧖꧗꧘꧙
꧞꧟
ꨀꨁꨂꨃꨄꨅꨆꨇꨈꨉꨊꨋꨌꨍꨎꨏꨐꨑꨒꨓꨔꨕꨖꨗꨘꨙꨚꨛꨜꨝꨞꨟꨠꨡꨢꨣꨤꨥꨦꨧꨨꨩꨪꨫꨬꨭꨮꨯꨰꨱꨲꨳꨴꨵꨶꩀꩁꩂꩃꩄꩅꩆꩇꩈꩉꩊꩋꩌꩍ꩐꩑꩒꩓꩔꩕꩖꩗꩘꩙
꩜꩝꩞꩟
ꩠꩡꩢꩣꩤꩥꩦꩧꩨꩩꩪꩫꩬꩭꩮꩯꩰꩱꩲꩳꩴꩵꩶ
꩷꩸꩹
ꩺꩻꪀꪁꪂꪃꪄꪅꪆꪇꪈꪉꪊꪋꪌꪍꪎꪏꪐꪑꪒꪓꪔꪕꪖꪗꪘꪙꪚꪛꪜꪝꪞꪟꪠꪡꪢꪣꪤꪥꪦꪧꪨꪩꪪꪫꪬꪭꪮꪯꪰꪱꪴꪲꪳꪵꪶꪷꪸꪹꪺꪻꪼꪽꪾ꪿ꫀ꫁ꫂꫛꫜꫝ
꫞꫟
ꯀꯁꯂꯃꯄꯅꯆꯇꯈꯉꯊꯋꯌꯍꯎꯏꯐꯑꯒꯓꯔꯕꯖꯗꯘꯙꯚꯛꯜꯝꯞꯟꯠꯡꯢꯣꯤꯥꯦꯧꯨꯩꯪ
꯫
꯬꯭꯰꯱꯲꯳꯴꯵꯶꯷꯸꯹가힣ힰힱힲힳힴힵힶힷힸힹힺힻힼힽힾힿퟀퟁퟂퟃퟄퟅퟆퟋퟌퟍퟎퟏퟐퟑퟒퟓퟔퟕퟖퟗퟘퟙퟚퟛퟜퟝퟞퟟퟠퟡퟢퟣퟤퟥퟦퟧퟨퟩퟪퟫퟬퟭퟮퟯퟰퟱퟲퟳퟴퟵퟶퟷퟸퟹퟺퟻ
豈更車賈滑串句龜龜契金喇奈懶癩羅蘿螺裸邏樂洛烙珞落酪駱亂卵欄爛蘭鸞嵐濫藍襤拉臘蠟廊朗浪狼郎來冷勞擄櫓爐盧老蘆虜路露魯鷺碌祿綠菉錄鹿論壟弄籠聾牢磊賂雷壘屢樓淚漏累縷陋勒肋凜凌稜綾菱陵讀拏樂諾丹寧怒率異北磻便復不泌數索參塞省葉說殺辰沈拾若掠略亮兩凉梁糧良諒量勵呂女廬旅濾礪閭驪麗黎力曆歷轢年憐戀撚漣煉璉秊練聯輦蓮連鍊列劣咽烈裂說廉念捻殮簾獵令囹寧嶺怜玲瑩羚聆鈴零靈領例禮醴隸惡了僚寮尿料樂燎療蓼遼龍暈阮劉杻柳流溜琉留硫紐類六戮陸倫崙淪輪律慄栗率隆利吏履易李梨泥理痢罹裏裡里離匿溺吝燐璘藺隣鱗麟林淋臨立笠粒狀炙識什茶刺切度拓糖宅洞暴輻行降見廓兀嗀﨎﨏塚﨑晴﨓﨔凞猪益礼神祥福靖精羽﨟蘒﨡諸﨣﨤逸都﨧﨨﨩飯飼館鶴侮僧免勉勤卑喝嘆器塀墨層屮悔慨憎懲敏既暑梅海渚漢煮爫琢碑社祉祈祐祖祝禍禎穀突節練縉繁署者臭艹艹著褐視謁謹賓贈辶逸難響頻恵𤋮舘並况全侀充冀勇勺喝啕喙嗢塚墳奄奔婢嬨廒廙彩徭惘慎愈憎慠懲戴揄搜摒敖晴朗望杖歹殺流滛滋漢瀞煮瞧爵犯猪瑱甆画瘝瘟益盛直睊着磌窱節类絛練缾者荒華蝹襁覆視調諸請謁諾諭謹變贈輸遲醙鉶陼難靖韛響頋頻鬒龜𢡊𢡄𣏕㮝䀘䀹𥉉𥳐𧻓齃龎fffiflffifflſtstﬓﬔﬕﬖﬗיִﬞײַﬠﬡﬢﬣﬤﬥﬦﬧﬨ
﬩
שׁשׂשּׁשּׂאַאָאּבּגּדּהּוּזּטּיּךּכּלּמּנּסּףּפּצּקּרּשּתּוֹבֿכֿפֿﭏﭐﭑﭒﭓﭔﭕﭖﭗﭘﭙﭚﭛﭜﭝﭞﭟﭠﭡﭢﭣﭤﭥﭦﭧﭨﭩﭪﭫﭬﭭﭮﭯﭰﭱﭲﭳﭴﭵﭶﭷﭸﭹﭺﭻﭼﭽﭾﭿﮀﮁﮂﮃﮄﮅﮆﮇﮈﮉﮊﮋﮌﮍﮎﮏﮐﮑﮒﮓﮔﮕﮖﮗﮘﮙﮚﮛﮜﮝﮞﮟﮠﮡﮢﮣﮤﮥﮦﮧﮨﮩﮪﮫﮬﮭﮮﮯﮰﮱﯓﯔﯕﯖﯗﯘﯙﯚﯛﯜﯝﯞﯟﯠﯡﯢﯣﯤﯥﯦﯧﯨﯩﯪﯫﯬﯭﯮﯯﯰﯱﯲﯳﯴﯵﯶﯷﯸﯹﯺﯻﯼﯽﯾﯿﰀﰁﰂﰃﰄﰅﰆﰇﰈﰉﰊﰋﰌﰍﰎﰏﰐﰑﰒﰓﰔﰕﰖﰗﰘﰙﰚﰛﰜﰝﰞﰟﰠﰡﰢﰣﰤﰥﰦﰧﰨﰩﰪﰫﰬﰭﰮﰯﰰﰱﰲﰳﰴﰵﰶﰷﰸﰹﰺﰻﰼﰽﰾﰿﱀﱁﱂﱃﱄﱅﱆﱇﱈﱉﱊﱋﱌﱍﱎﱏﱐﱑﱒﱓﱔﱕﱖﱗﱘﱙﱚﱛﱜﱝﱞﱟﱠﱡﱢﱣﱤﱥﱦﱧﱨﱩﱪﱫﱬﱭﱮﱯﱰﱱﱲﱳﱴﱵﱶﱷﱸﱹﱺﱻﱼﱽﱾﱿﲀﲁﲂﲃﲄﲅﲆﲇﲈﲉﲊﲋﲌﲍﲎﲏﲐﲑﲒﲓﲔﲕﲖﲗﲘﲙﲚﲛﲜﲝﲞﲟﲠﲡﲢﲣﲤﲥﲦﲧﲨﲩﲪﲫﲬﲭﲮﲯﲰﲱﲲﲳﲴﲵﲶﲷﲸﲹﲺﲻﲼﲽﲾﲿﳀﳁﳂﳃﳄﳅﳆﳇﳈﳉﳊﳋﳌﳍﳎﳏﳐﳑﳒﳓﳔﳕﳖﳗﳘﳙﳚﳛﳜﳝﳞﳟﳠﳡﳢﳣﳤﳥﳦﳧﳨﳩﳪﳫﳬﳭﳮﳯﳰﳱﳲﳳﳴﳵﳶﳷﳸﳹﳺﳻﳼﳽﳾﳿﴀﴁﴂﴃﴄﴅﴆﴇﴈﴉﴊﴋﴌﴍﴎﴏﴐﴑﴒﴓﴔﴕﴖﴗﴘﴙﴚﴛﴜﴝﴞﴟﴠﴡﴢﴣﴤﴥﴦﴧﴨﴩﴪﴫﴬﴭﴮﴯﴰﴱﴲﴳﴴﴵﴶﴷﴸﴹﴺﴻﴼﴽ
﴾﴿
ﵐﵑﵒﵓﵔﵕﵖﵗﵘﵙﵚﵛﵜﵝﵞﵟﵠﵡﵢﵣﵤﵥﵦﵧﵨﵩﵪﵫﵬﵭﵮﵯﵰﵱﵲﵳﵴﵵﵶﵷﵸﵹﵺﵻﵼﵽﵾﵿﶀﶁﶂﶃﶄﶅﶆﶇﶈﶉﶊﶋﶌﶍﶎﶏﶒﶓﶔﶕﶖﶗﶘﶙﶚﶛﶜﶝﶞﶟﶠﶡﶢﶣﶤﶥﶦﶧﶨﶩﶪﶫﶬﶭﶮﶯﶰﶱﶲﶳﶴﶵﶶﶷﶸﶹﶺﶻﶼﶽﶾﶿﷀﷁﷂﷃﷄﷅﷆﷇﷰﷱﷲﷳﷴﷵﷶﷷﷸﷹﷺﷻ
﷼﷽
︀︁︂︃︄︅︆︇︈︉︊︋︌︍︎️
︐︑︒︓︔︕︖︗︘︙
︠︡︢︣︤︥︦
︰︱︲︳︴︵︶︷︸︹︺︻︼︽︾︿﹀﹁﹂﹃﹄﹅﹆﹇﹈﹉﹊﹋﹌﹍﹎﹏﹐﹑﹒﹔﹕﹖﹗﹘﹙﹚﹛﹜﹝﹞﹟﹠﹡﹢﹣﹤﹥﹦﹨﹩﹪﹫
ﹰﹱﹲﹳﹴﹶﹷﹸﹹﹺﹻﹼﹽﹾﹿﺀﺁﺂﺃﺄﺅﺆﺇﺈﺉﺊﺋﺌﺍﺎﺏﺐﺑﺒﺓﺔﺕﺖﺗﺘﺙﺚﺛﺜﺝﺞﺟﺠﺡﺢﺣﺤﺥﺦﺧﺨﺩﺪﺫﺬﺭﺮﺯﺰﺱﺲﺳﺴﺵﺶﺷﺸﺹﺺﺻﺼﺽﺾﺿﻀﻁﻂﻃﻄﻅﻆﻇﻈﻉﻊﻋﻌﻍﻎﻏﻐﻑﻒﻓﻔﻕﻖﻗﻘﻙﻚﻛﻜﻝﻞﻟﻠﻡﻢﻣﻤﻥﻦﻧﻨﻩﻪﻫﻬﻭﻮﻯﻰﻱﻲﻳﻴﻵﻶﻷﻸﻹﻺﻻﻼ
！＂＃＄％＆＇（）＊＋，－．／
０１２３４５６７８９
：；＜＝＞？＠
ＡＢＣＤＥＦＧＨＩＪＫＬＭＮＯＰＱＲＳＴＵＶＷＸＹＺ
［＼］＾＿｀
ａｂｃｄｅｆｇｈｉｊｋｌｍｎｏｐｑｒｓｔｕｖｗｘｙｚ
｛｜｝～｟｠｡｢｣､･
ｦｧｨｩｪｫｬｭｮｯｰｱｲｳｴｵｶｷｸｹｺｻｼｽｾｿﾀﾁﾂﾃﾄﾅﾆﾇﾈﾉﾊﾋﾌﾍﾎﾏﾐﾑﾒﾓﾔﾕﾖﾗﾘﾙﾚﾛﾜﾝﾞﾟﾠﾡﾢﾣﾤﾥﾦﾧﾨﾩﾪﾫﾬﾭﾮﾯﾰﾱﾲﾳﾴﾵﾶﾷﾸﾹﾺﾻﾼﾽﾾￂￃￄￅￆￇￊￋￌￍￎￏￒￓￔￕￖￗￚￛￜ
￠￡￢￣￤￥￦￨￩￪￫￬￭￮�
𐀀name = "Search embedded form"
description = "Support module for search module testing of embedded forms."
package = Testing
version = VERSION
core = 7.x
hidden = TRUE
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
'Search_Embed_Form',
'page callback' => 'drupal_get_form',
'page arguments' => array('search_embedded_form_form'),
'access arguments' => array('search content'),
'type' => MENU_CALLBACK,
);
return $items;
}
/**
* Builds a form for embedding in search results for testing.
*
* @see search_embedded_form_form_submit().
*/
function search_embedded_form_form($form, &$form_state) {
$count = variable_get('search_embedded_form_submitted', 0);
$form['name'] = array(
'#type' => 'textfield',
'#title' => t('Your name'),
'#maxlength' => 255,
'#default_value' => '',
'#required' => TRUE,
'#description' => t('Times form has been submitted: %count', array('%count' => $count)),
);
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Send away'),
);
$form['#submit'][] = 'search_embedded_form_form_submit';
return $form;
}
/**
* Submit handler for search_embedded_form_form().
*/
function search_embedded_form_form_submit($form, &$form_state) {
$count = variable_get('search_embedded_form_submitted', 0) + 1;
variable_set('search_embedded_form_submitted', $count);
drupal_set_message(t('Test form was submitted'));
}
/**
* Adds the test form to search results.
*/
function search_embedded_form_preprocess_search_result(&$variables) {
$form = drupal_get_form('search_embedded_form_form');
$variables['snippet'] .= drupal_render($form);
}
name = "Test search type"
description = "Support module for search module testing."
package = Testing
version = VERSION
core = 7.x
hidden = TRUE
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
'Dummy search type',
'path' => 'dummy_path',
'conditions_callback' => 'search_extra_type_conditions',
);
}
/**
* Test conditions callback for hook_search_info().
*/
function search_extra_type_conditions() {
$conditions = array();
if (!empty($_REQUEST['search_conditions'])) {
$conditions['search_conditions'] = $_REQUEST['search_conditions'];
}
return $conditions;
}
/**
* Implements hook_search_execute().
*
* This is a dummy search, so when search "executes", we just return a dummy
* result containing the keywords and a list of conditions.
*/
function search_extra_type_search_execute($keys = NULL, $conditions = NULL) {
if (!$keys) {
$keys = '';
}
return array(
array(
'link' => url('node'),
'type' => 'Dummy result type',
'title' => 'Dummy title',
'snippet' => "Dummy search snippet to display. Keywords: {$keys}\n\nConditions: " . print_r($conditions, TRUE),
),
);
}
/**
* Implements hook_search_page().
*
* Adds some text to the search page so we can verify that it runs.
*/
function search_extra_type_search_page($results) {
$output['prefix']['#markup'] = 'Test page text is here ';
foreach ($results as $entry) {
$output[] = array(
'#theme' => 'search_result',
'#result' => $entry,
'#module' => 'search_extra_type',
);
}
$output['suffix']['#markup'] = ' ' . theme('pager');
return $output;
}
name = "Test search node tags"
description = "Support module for Node search tags testing."
package = Testing
version = VERSION
core = 7.x
hidden = TRUE
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
hasTag('search_node')) {
variable_set('search_node_tags_test_query_tag', TRUE);
}
}
/**
* Implements hook_query_TAG_alter().
*/
function search_node_tags_query_search_node_alter(QueryAlterableInterface $query) {
variable_set('search_node_tags_test_query_tag_hook', TRUE);
}
div#toolbar a#edit-shortcuts {
position: absolute;
left: 0;
top: 0;
padding: 5px 5px 5px 10px;
}
div#toolbar div.toolbar-shortcuts ul {
float: none;
margin-right: 5px;
margin-left: 10em;
}
div#toolbar div.toolbar-shortcuts ul li a {
margin-left: 5px;
margin-right: 0;
padding: 0 5px;
}
div#toolbar div.toolbar-shortcuts span.icon {
float: right;
}
div.add-or-remove-shortcuts a span.icon {
float: right;
margin-right: 8px;
margin-left: 0;
}
div.add-or-remove-shortcuts a span.text {
float: right;
padding-right: 10px;
padding-left: 0;
}
div.add-or-remove-shortcuts a:focus span.text,
div.add-or-remove-shortcuts a:hover span.text {
-moz-border-radius: 5px 0 0 5px;
-webkit-border-top-left-radius: 5px;
-webkit-border-bottom-left-radius: 5px;
border-radius: 5px 0 0 5px;
padding-left: 6px;
}
#shortcut-set-switch .form-item-new {
padding-right: 17px;
padding-left: 0;
}
div.add-shortcut a:hover span.icon {
background-position: 0 -24px;
}
div.remove-shortcut a:hover span.icon {
background-position: -12px -24px;
}
.shortcut-slot-hidden {
display: none;
}
div.form-item-set div.form-item-new {
display: inline;
}
$set) {
$options[$name] = check_plain($set->title);
}
// Only administrators can add shortcut sets.
$add_access = user_access('administer shortcuts');
if ($add_access) {
$options['new'] = t('New set');
}
if (count($options) > 1) {
$form['account'] = array(
'#type' => 'value',
'#value' => $account,
);
$form['set'] = array(
'#type' => 'radios',
'#title' => $user->uid == $account->uid ? t('Choose a set of shortcuts to use') : t('Choose a set of shortcuts for this user'),
'#options' => $options,
'#default_value' => $current_set->set_name,
);
$form['new'] = array(
'#type' => 'textfield',
'#title' => t('Name'),
'#title_display' => 'invisible',
'#description' => t('The new set is created by copying items from your default shortcut set.'),
'#access' => $add_access,
);
if ($user->uid != $account->uid) {
$default_set = shortcut_default_set($account);
$form['new']['#description'] = t('The new set is created by copying items from the %default set.', array('%default' => $default_set->title));
}
$form['#attached'] = array(
'css' => array(drupal_get_path('module', 'shortcut') . '/shortcut.admin.css'),
'js' => array(drupal_get_path('module', 'shortcut') . '/shortcut.admin.js'),
);
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Change set'),
);
}
else {
// There is only 1 option, so output a message in the $form array.
$form['info'] = array(
'#markup' => '' . t('You are currently using the %set-name shortcut set.', array('%set-name' => $current_set->title)) . '
',
);
}
return $form;
}
/**
* Validation handler for shortcut_set_switch().
*/
function shortcut_set_switch_validate($form, &$form_state) {
if ($form_state['values']['set'] == 'new') {
// Check to prevent creating a shortcut set with an empty title.
if (trim($form_state['values']['new']) == '') {
form_set_error('new', t('The new set name is required.'));
}
// Check to prevent a duplicate title.
if (shortcut_set_title_exists($form_state['values']['new'])) {
form_set_error('new', t('The shortcut set %name already exists. Choose another name.', array('%name' => $form_state['values']['new'])));
}
}
}
/**
* Submit handler for shortcut_set_switch().
*/
function shortcut_set_switch_submit($form, &$form_state) {
global $user;
$account = $form_state['values']['account'];
if ($form_state['values']['set'] == 'new') {
// Save a new shortcut set with links copied from the user's default set.
$default_set = shortcut_default_set($account);
$set = (object) array(
'title' => $form_state['values']['new'],
'links' => menu_links_clone($default_set->links),
);
shortcut_set_save($set);
$replacements = array(
'%user' => $account->name,
'%set_name' => $set->title,
'@switch-url' => url(current_path()),
);
if ($account->uid == $user->uid) {
// Only administrators can create new shortcut sets, so we know they have
// access to switch back.
drupal_set_message(t('You are now using the new %set_name shortcut set. You can edit it from this page or switch back to a different one. ', $replacements));
}
else {
drupal_set_message(t('%user is now using a new shortcut set called %set_name. You can edit it from this page.', $replacements));
}
$form_state['redirect'] = 'admin/config/user-interface/shortcut/' . $set->set_name;
}
else {
// Switch to a different shortcut set.
$set = shortcut_set_load($form_state['values']['set']);
$replacements = array(
'%user' => $account->name,
'%set_name' => $set->title,
);
drupal_set_message($account->uid == $user->uid ? t('You are now using the %set_name shortcut set.', $replacements) : t('%user is now using the %set_name shortcut set.', $replacements));
}
// Assign the shortcut set to the provided user account.
shortcut_set_assign_user($set, $account);
}
/**
* Menu page callback: builds the page for administering shortcut sets.
*/
function shortcut_set_admin() {
$shortcut_sets = shortcut_sets();
$header = array(t('Name'), array('data' => t('Operations'), 'colspan' => 4));
$rows = array();
foreach ($shortcut_sets as $set) {
$row = array(
check_plain($set->title),
l(t('list links'), "admin/config/user-interface/shortcut/$set->set_name"),
l(t('edit set name'), "admin/config/user-interface/shortcut/$set->set_name/edit"),
);
if (shortcut_set_delete_access($set)) {
$row[] = l(t('delete set'), "admin/config/user-interface/shortcut/$set->set_name/delete");
}
else {
$row[] = '';
}
$rows[] = $row;
}
return theme('table', array('header' => $header, 'rows' => $rows));
}
/**
* Form callback: builds the form for adding a shortcut set.
*
* @param $form
* An associative array containing the structure of the form.
* @param $form_state
* An associative array containing the current state of the form.
*
* @return
* An array representing the form definition.
*
* @ingroup forms
* @see shortcut_set_add_form_validate()
* @see shortcut_set_add_form_submit()
*/
function shortcut_set_add_form($form, &$form_state) {
$form['new'] = array(
'#type' => 'textfield',
'#title' => t('Set name'),
'#description' => t('The new set is created by copying items from your default shortcut set.'),
'#required' => TRUE,
);
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Create new set'),
);
return $form;
}
/**
* Validation handler for shortcut_set_add_form().
*/
function shortcut_set_add_form_validate($form, &$form_state) {
// Check to prevent a duplicate title.
if (shortcut_set_title_exists($form_state['values']['new'])) {
form_set_error('new', t('The shortcut set %name already exists. Choose another name.', array('%name' => $form_state['values']['new'])));
}
}
/**
* Submit handler for shortcut_set_add_form().
*/
function shortcut_set_add_form_submit($form, &$form_state) {
// Save a new shortcut set with links copied from the user's default set.
$default_set = shortcut_default_set();
$set = (object) array(
'title' => $form_state['values']['new'],
'links' => menu_links_clone($default_set->links),
);
shortcut_set_save($set);
drupal_set_message(t('The %set_name shortcut set has been created. You can edit it from this page.', array('%set_name' => $set->title)));
$form_state['redirect'] = 'admin/config/user-interface/shortcut/' . $set->set_name;
}
/**
* Form callback: builds the form for customizing shortcut sets.
*
* @param $form
* An associative array containing the structure of the form.
* @param $form_state
* An associative array containing the current state of the form.
* @param $shortcut_set
* An object representing the shortcut set which is being edited.
*
* @return
* An array representing the form definition.
*
* @ingroup forms
* @see shortcut_set_customize_submit()
*/
function shortcut_set_customize($form, &$form_state, $shortcut_set) {
$form['#shortcut_set_name'] = $shortcut_set->set_name;
$form['shortcuts'] = array(
'#tree' => TRUE,
'#weight' => -20,
'enabled' => array(),
'disabled' => array(),
);
foreach ($shortcut_set->links as $link) {
$mlid = $link['mlid'];
$status = $link['hidden'] ? 'disabled' : 'enabled';
$form['shortcuts'][$status][$mlid]['name']['#markup'] = l($link['link_title'], $link['link_path']);
$form['shortcuts'][$status][$mlid]['weight'] = array(
'#type' => 'weight',
'#title' => t('Weight'),
'#delta' => 50,
'#default_value' => $link['weight'],
'#attributes' => array('class' => array('shortcut-weight')),
);
$form['shortcuts'][$status][$mlid]['status'] = array(
'#type' => 'select',
'#title' => t('Status'),
'#options' => array('disabled' => t('Disabled'), 'enabled' => t('Enabled')),
'#default_value' => $status,
'#attributes' => array('class' => array('shortcut-status-select')),
);
$form['shortcuts'][$status][$mlid]['edit']['#markup'] = l(t('edit'), 'admin/config/user-interface/shortcut/link/' . $mlid);
$form['shortcuts'][$status][$mlid]['delete']['#markup'] = l(t('delete'), 'admin/config/user-interface/shortcut/link/' . $mlid . '/delete');
}
$form['#attached'] = array(
'css' => array(drupal_get_path('module', 'shortcut') . '/shortcut.admin.css'),
'js' => array(drupal_get_path('module', 'shortcut') . '/shortcut.admin.js'),
);
$form['actions'] = array(
'#type' => 'actions',
'#access' => !empty($shortcut_set->links),
);
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Save changes'),
);
return $form;
}
/**
* Submit handler for shortcut_set_customize().
*/
function shortcut_set_customize_submit($form, &$form_state) {
foreach ($form_state['values']['shortcuts'] as $group => $links) {
foreach ($links as $mlid => $data) {
$link = menu_link_load($mlid);
$link['hidden'] = $data['status'] == 'enabled' ? 0 : 1;
$link['weight'] = $data['weight'];
menu_link_save($link);
}
}
drupal_set_message(t('The shortcut set has been updated.'));
}
/**
* Returns HTML for a shortcut set customization form.
*
* @param $variables
* An associative array containing:
* - form: A render element representing the form.
*
* @see shortcut_set_customize()
* @ingroup themeable
*/
function theme_shortcut_set_customize($variables) {
$form = $variables['form'];
$map = array('disabled' => t('Disabled'), 'enabled' => t('Enabled'));
$shortcuts_by_status = array(
'enabled' => element_children($form['shortcuts']['enabled']),
'disabled' => element_children($form['shortcuts']['disabled']),
);
// Do not add any rows to the table if there are no shortcuts to display.
$statuses = empty($shortcuts_by_status['enabled']) && empty($shortcuts_by_status['disabled']) ? array() : array_keys($shortcuts_by_status);
$rows = array();
foreach ($statuses as $status) {
drupal_add_tabledrag('shortcuts', 'match', 'sibling', 'shortcut-status-select');
drupal_add_tabledrag('shortcuts', 'order', 'sibling', 'shortcut-weight');
$rows[] = array(
'data' => array(array(
'colspan' => 5,
'data' => '' . $map[$status] . ' ',
)),
'class' => array('shortcut-status', 'shortcut-status-' . $status),
);
foreach ($shortcuts_by_status[$status] as $key) {
$shortcut = &$form['shortcuts'][$status][$key];
$row = array();
$row[] = drupal_render($shortcut['name']);
$row[] = drupal_render($shortcut['weight']);
$row[] = drupal_render($shortcut['status']);
$row[] = drupal_render($shortcut['edit']);
$row[] = drupal_render($shortcut['delete']);
$rows[] = array(
'data' => $row,
'class' => array('draggable'),
);
}
if ($status == 'enabled') {
for ($i = 0; $i < shortcut_max_slots(); $i++) {
$rows['empty-' . $i] = array(
'data' => array(array(
'colspan' => 5,
'data' => '' . t('Empty') . ' ',
)),
'class' => array('shortcut-slot-empty'),
);
}
$count_shortcuts = count($shortcuts_by_status[$status]);
if (!empty($count_shortcuts)) {
for ($i = 0; $i < min($count_shortcuts, shortcut_max_slots()); $i++) {
$rows['empty-' . $i]['class'][] = 'shortcut-slot-hidden';
}
}
}
}
$header = array(t('Name'), t('Weight'), t('Status'), array('data' => t('Operations'), 'colspan' => 2));
$output = theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('id' => 'shortcuts'), 'empty' => t('No shortcuts available. Add a shortcut .', array('@link' => url('admin/config/user-interface/shortcut/' . $form['#shortcut_set_name'] . '/add-link')))));
$output .= drupal_render($form['actions']);
$output = drupal_render_children($form) . $output;
return $output;
}
/**
* Form callback: builds the form for adding a new shortcut link.
*
* @param $form
* An associative array containing the structure of the form.
* @param $form_state
* An associative array containing the current state of the form.
* @param $shortcut_set
* An object representing the shortcut set to which the link will be added.
*
* @return
* An array representing the form definition.
*
* @ingroup forms
* @see shortcut_link_edit_validate()
* @see shortcut_link_add_submit()
*/
function shortcut_link_add($form, &$form_state, $shortcut_set) {
drupal_set_title(t('Add new shortcut'));
$form['shortcut_set'] = array(
'#type' => 'value',
'#value' => $shortcut_set,
);
$form += _shortcut_link_form_elements();
return $form;
}
/**
* Form callback: builds the form for editing a shortcut link.
*
* @param $form
* An associative array containing the structure of the form.
* @param $form_state
* An associative array containing the current state of the form.
* @param $shortcut_link
* An array representing the link that is being edited.
*
* @return
* An array representing the form definition.
*
* @ingroup forms
* @see shortcut_link_edit_validate()
* @see shortcut_link_edit_submit()
*/
function shortcut_link_edit($form, &$form_state, $shortcut_link) {
drupal_set_title(t('Editing @shortcut', array('@shortcut' => $shortcut_link['link_title'])));
$form['original_shortcut_link'] = array(
'#type' => 'value',
'#value' => $shortcut_link,
);
$form += _shortcut_link_form_elements($shortcut_link);
return $form;
}
/**
* Helper function for building a form for adding or editing shortcut links.
*
* @param $shortcut_link
* (optional) An array representing the shortcut link that will be edited. If
* not provided, a new link will be created.
*
* @return
* An array of form elements.
*/
function _shortcut_link_form_elements($shortcut_link = NULL) {
if (!isset($shortcut_link)) {
$shortcut_link = array(
'link_title' => '',
'link_path' => ''
);
}
else {
$shortcut_link['link_path'] = ($shortcut_link['link_path'] == '') ? '' : drupal_get_path_alias($shortcut_link['link_path']);
}
$form['shortcut_link']['#tree'] = TRUE;
$form['shortcut_link']['link_title'] = array(
'#type' => 'textfield',
'#title' => t('Name'),
'#description' => t('The name of the shortcut.'),
'#size' => 40,
'#maxlength' => 255,
'#default_value' => $shortcut_link['link_title'],
'#required' => TRUE,
);
$form['shortcut_link']['link_path'] = array(
'#type' => 'textfield',
'#title' => t('Path'),
'#description' => t('The path to the shortcut.'),
'#size' => 40,
'#maxlength' => 255,
'#field_prefix' => url(NULL, array('absolute' => TRUE)) . (variable_get('clean_url', 0) ? '' : '?q='),
'#default_value' => $shortcut_link['link_path'],
);
$form['#validate'][] = 'shortcut_link_edit_validate';
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Save'),
);
return $form;
}
/**
* Validation handler for the shortcut link add and edit forms.
*/
function shortcut_link_edit_validate($form, &$form_state) {
if (!shortcut_valid_link($form_state['values']['shortcut_link']['link_path'])) {
form_set_error('shortcut_link][link_path', t('The link must correspond to a valid path on the site.'));
}
}
/**
* Submit handler for shortcut_link_edit().
*/
function shortcut_link_edit_submit($form, &$form_state) {
// Normalize the path in case it is an alias.
$shortcut_path = drupal_get_normal_path($form_state['values']['shortcut_link']['link_path']);
if (empty($shortcut_path)) {
$shortcut_path = '';
}
$form_state['values']['shortcut_link']['link_path'] = $shortcut_path;
$shortcut_link = array_merge($form_state['values']['original_shortcut_link'], $form_state['values']['shortcut_link']);
menu_link_save($shortcut_link);
$form_state['redirect'] = 'admin/config/user-interface/shortcut/' . $shortcut_link['menu_name'];
drupal_set_message(t('The shortcut %link has been updated.', array('%link' => $shortcut_link['link_title'])));
}
/**
* Submit handler for shortcut_link_add().
*/
function shortcut_link_add_submit($form, &$form_state) {
// Add the shortcut link to the set.
$shortcut_set = $form_state['values']['shortcut_set'];
$shortcut_link = $form_state['values']['shortcut_link'];
$shortcut_link['menu_name'] = $shortcut_set->set_name;
shortcut_admin_add_link($shortcut_link, $shortcut_set, shortcut_max_slots());
shortcut_set_save($shortcut_set);
$form_state['redirect'] = 'admin/config/user-interface/shortcut/' . $shortcut_link['menu_name'];
drupal_set_message(t('Added a shortcut for %title.', array('%title' => $shortcut_link['link_title'])));
}
/**
* Adds a link to the end of a shortcut set, keeping within a prescribed limit.
*
* @param $link
* An array representing a shortcut link.
* @param $shortcut_set
* An object representing the shortcut set which the link will be added to.
* The links in the shortcut set will be re-weighted so that the new link is
* at the end, and some existing links may be disabled (if the $limit
* parameter is provided).
* @param $limit
* (optional) The maximum number of links that are allowed to be enabled for
* this shortcut set. If provided, existing links at the end of the list that
* exceed the limit will be automatically disabled. If not provided, no limit
* will be enforced.
*/
function shortcut_admin_add_link($shortcut_link, &$shortcut_set, $limit = NULL) {
if (isset($limit)) {
// Disable any existing links at the end of the list that would cause the
// limit to be exceeded. Take into account whether or not the new link will
// be enabled and count towards the total.
$number_enabled = !empty($shortcut_link['hidden']) ? 0 : 1;
foreach ($shortcut_set->links as &$link) {
if (!$link['hidden']) {
$number_enabled++;
if ($number_enabled > $limit) {
$link['hidden'] = 1;
}
}
}
}
// Normalize the path in case it is an alias.
$shortcut_link['link_path'] = drupal_get_normal_path($shortcut_link['link_path']);
if (empty($shortcut_link['link_path'])) {
$shortcut_link['link_path'] = '';
}
// Add the link to the end of the list.
$shortcut_set->links[] = $shortcut_link;
shortcut_set_reset_link_weights($shortcut_set);
}
/**
* Form callback: builds the form for editing the shortcut set name.
*
* @param $form
* An associative array containing the structure of the form.
* @param $form_state
* An associative array containing the current state of the form.
* @param object $shortcut_set
* An object representing the shortcut set, as returned from
* shortcut_set_load().
*
* @return
* An array representing the form definition.
*
* @ingroup forms
* @see shortcut_set_edit_form_validate()
* @see shortcut_set_edit_form_submit()
*/
function shortcut_set_edit_form($form, &$form_state, $shortcut_set) {
$form['shortcut_set'] = array(
'#type' => 'value',
'#value' => $shortcut_set,
);
$form['title'] = array(
'#type' => 'textfield',
'#title' => t('Set name'),
'#default_value' => $shortcut_set->title,
'#maxlength' => 255,
'#required' => TRUE,
'#weight' => -5,
);
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Save'),
'#weight' => 5,
);
return $form;
}
/**
* Validation handler for shortcut_set_edit_form().
*/
function shortcut_set_edit_form_validate($form, &$form_state) {
// Check to prevent a duplicate title, if the title was edited from its
// original value.
if ($form_state['values']['title'] != $form_state['values']['shortcut_set']->title && shortcut_set_title_exists($form_state['values']['title'])) {
form_set_error('title', t('The shortcut set %name already exists. Choose another name.', array('%name' => $form_state['values']['title'])));
}
}
/**
* Submit handler for shortcut_set_edit_form().
*/
function shortcut_set_edit_form_submit($form, &$form_state) {
$shortcut_set = $form_state['values']['shortcut_set'];
$shortcut_set->title = $form_state['values']['title'];
shortcut_set_save($shortcut_set);
drupal_set_message(t('Updated set name to %set-name.', array('%set-name' => $shortcut_set->title)));
$form_state['redirect'] = "admin/config/user-interface/shortcut/$shortcut_set->set_name";
}
/**
* Form callback: builds the confirmation form for deleting a shortcut set.
*
* @param $form
* An associative array containing the structure of the form.
* @param $form_state
* An associative array containing the current state of the form.
* @param object $shortcut_set
* An object representing the shortcut set, as returned from
* shortcut_set_load().
*
* @return
* An array representing the form definition.
*
* @ingroup forms
* @see shortcut_set_delete_form_submit()
*/
function shortcut_set_delete_form($form, &$form_state, $shortcut_set) {
$form['shortcut_set'] = array(
'#type' => 'value',
'#value' => $shortcut_set->set_name,
);
// Find out how many users are directly assigned to this shortcut set, and
// make a message.
$number = db_query('SELECT COUNT(*) FROM {shortcut_set_users} WHERE set_name = :name', array(':name' => $shortcut_set->set_name))->fetchField();
$info = '';
if ($number) {
$info .= '' . format_plural($number,
'1 user has chosen or been assigned to this shortcut set.',
'@count users have chosen or been assigned to this shortcut set.') . '
';
}
// Also, if a module implements hook_shortcut_default_set(), it's possible
// that this set is being used as a default set. Add a message about that too.
if (count(module_implements('shortcut_default_set')) > 0) {
$info .= '' . t('If you have chosen this shortcut set as the default for some or all users, they may also be affected by deleting it.') . '
';
}
$form['info'] = array(
'#markup' => $info,
);
return confirm_form(
$form,
t('Are you sure you want to delete the shortcut set %title?', array('%title' => $shortcut_set->title)),
'admin/config/user-interface/shortcut/' . $shortcut_set->set_name,
t('This action cannot be undone.'),
t('Delete'),
t('Cancel')
);
}
/**
* Submit handler for shortcut_set_delete_form().
*/
function shortcut_set_delete_form_submit($form, &$form_state) {
$shortcut_set = shortcut_set_load($form_state['values']['shortcut_set']);
shortcut_set_delete($shortcut_set);
$form_state['redirect'] = 'admin/config/user-interface/shortcut';
drupal_set_message(t('The shortcut set %title has been deleted.', array('%title' => $shortcut_set->title)));
}
/**
* Form callback: builds the confirmation form for deleting a shortcut link.
*
* @param $form
* An associative array containing the structure of the form.
* @param $form_state
* An associative array containing the current state of the form.
* @param $shortcut_link
* An array representing the link that will be deleted.
*
* @return
* An array representing the form definition.
*
* @ingroup forms
* @see shortcut_link_delete_submit()
*/
function shortcut_link_delete($form, &$form_state, $shortcut_link) {
$form['shortcut_link'] = array(
'#type' => 'value',
'#value' => $shortcut_link,
);
return confirm_form(
$form,
t('Are you sure you want to delete the shortcut %title?', array('%title' => $shortcut_link['link_title'])),
'admin/config/user-interface/shortcut/' . $shortcut_link['menu_name'],
t('This action cannot be undone.'),
t('Delete'),
t('Cancel')
);
}
/**
* Submit handler for shortcut_link_delete_submit().
*/
function shortcut_link_delete_submit($form, &$form_state) {
$shortcut_link = $form_state['values']['shortcut_link'];
menu_link_delete($shortcut_link['mlid']);
$form_state['redirect'] = 'admin/config/user-interface/shortcut/' . $shortcut_link['menu_name'];
drupal_set_message(t('The shortcut %title has been deleted.', array('%title' => $shortcut_link['link_title'])));
}
/**
* Menu page callback: creates a new link in the provided shortcut set.
*
* After completion, redirects the user back to where they came from.
*
* @param $shortcut_set
* Returned from shortcut_set_load().
*/
function shortcut_link_add_inline($shortcut_set) {
if (isset($_REQUEST['token']) && drupal_valid_token($_REQUEST['token'], 'shortcut-add-link') && shortcut_valid_link($_GET['link'])) {
$item = menu_get_item($_GET['link']);
$title = ($item && $item['title']) ? $item['title'] : $_GET['name'];
$link = array(
'link_title' => $title,
'link_path' => $_GET['link'],
);
shortcut_admin_add_link($link, $shortcut_set, shortcut_max_slots());
if (shortcut_set_save($shortcut_set)) {
drupal_set_message(t('Added a shortcut for %title.', array('%title' => $link['link_title'])));
}
else {
drupal_set_message(t('Unable to add a shortcut for %title.', array('%title' => $link['link_title'])));
}
drupal_goto();
}
return MENU_ACCESS_DENIED;
}
(function ($) {
/**
* Handle the concept of a fixed number of slots.
*
* This behavior is dependent on the tableDrag behavior, since it uses the
* objects initialized in that behavior to update the row.
*/
Drupal.behaviors.shortcutDrag = {
attach: function (context, settings) {
if (Drupal.tableDrag) {
var table = $('table#shortcuts'),
visibleLength = 0,
slots = 0,
tableDrag = Drupal.tableDrag.shortcuts;
$('> tbody > tr, > tr', table)
.filter(':visible')
.filter(':odd').filter('.odd')
.removeClass('odd').addClass('even')
.end().end()
.filter(':even').filter('.even')
.removeClass('even').addClass('odd')
.end().end()
.end()
.filter('.shortcut-slot-empty').each(function(index) {
if ($(this).is(':visible')) {
visibleLength++;
}
slots++;
});
// Add a handler for when a row is swapped.
tableDrag.row.prototype.onSwap = function (swappedRow) {
var disabledIndex = $(table).find('tr').index($(table).find('tr.shortcut-status-disabled')) - slots - 2,
count = 0;
$(table).find('tr.shortcut-status-enabled').nextAll(':not(.shortcut-slot-empty)').each(function(index) {
if (index < disabledIndex) {
count++;
}
});
var total = slots - count;
if (total == -1) {
var disabled = $(table).find('tr.shortcut-status-disabled');
// To maintain the shortcut links limit, we need to move the last
// element from the enabled section to the disabled section.
var changedRow = disabled.prevAll(':not(.shortcut-slot-empty)').not($(this.element)).get(0);
disabled.after(changedRow);
if ($(changedRow).hasClass('draggable')) {
// The dropped element will automatically be marked as changed by
// the tableDrag system. However, the row that swapped with it
// has moved to the "disabled" section, so we need to force its
// status to be disabled and mark it also as changed.
var changedRowObject = new tableDrag.row(changedRow, 'mouse', false, 0, true);
changedRowObject.markChanged();
tableDrag.rowStatusChange(changedRowObject);
}
}
else if (total != visibleLength) {
if (total > visibleLength) {
// Less slots on screen than needed.
$('.shortcut-slot-empty:hidden:last').show();
visibleLength++;
}
else {
// More slots on screen than needed.
$('.shortcut-slot-empty:visible:last').hide();
visibleLength--;
}
}
};
// Add a handler so when a row is dropped, update fields dropped into new regions.
tableDrag.onDrop = function () {
tableDrag.rowStatusChange(this.rowObject);
return true;
};
tableDrag.rowStatusChange = function (rowObject) {
// Use "status-message" row instead of "status" row because
// "status-{status_name}-message" is less prone to regexp match errors.
var statusRow = $(rowObject.element).prevAll('tr.shortcut-status').get(0);
var statusName = statusRow.className.replace(/([^ ]+[ ]+)*shortcut-status-([^ ]+)([ ]+[^ ]+)*/, '$2');
var statusField = $('select.shortcut-status-select', rowObject.element);
statusField.val(statusName);
};
tableDrag.restripeTable = function () {
// :even and :odd are reversed because jQuery counts from 0 and
// we count from 1, so we're out of sync.
// Match immediate children of the parent element to allow nesting.
$('> tbody > tr:visible, > tr:visible', this.table)
.filter(':odd').filter('.odd')
.removeClass('odd').addClass('even')
.end().end()
.filter(':even').filter('.even')
.removeClass('even').addClass('odd');
};
}
}
};
/**
* Make it so when you enter text into the "New set" textfield, the
* corresponding radio button gets selected.
*/
Drupal.behaviors.newSet = {
attach: function (context, settings) {
var selectDefault = function() {
$(this).closest('form').find('.form-item-set .form-type-radio:last input').attr('checked', 'checked');
};
$('div.form-item-new input').focus(selectDefault).keyup(selectDefault);
}
};
})(jQuery);
roles)) {
return variable_get('mymodule_shortcut_admin_default_set');
}
}
/**
* @} End of "addtogroup hooks".
*/
div#toolbar a#edit-shortcuts {
float: right;
padding: 5px 10px 5px 5px;
line-height: 24px;
color: #fefefe;
}
div#toolbar a#edit-shortcuts:focus,
div#toolbar a#edit-shortcuts:hover,
div#toolbar a#edit-shortcuts.active {
color: #fff;
text-decoration: underline;
}
div#toolbar div.toolbar-shortcuts ul {
padding: 5px 0 2px 0;
height: 28px;
line-height: 24px;
float: left; /* LTR */
margin-left:5px; /* LTR */
}
div#toolbar div.toolbar-shortcuts ul li a {
padding: 0 5px 0 5px;
margin-right: 5px; /* LTR */
-moz-border-radius: 5px;
-webkit-border-radius: 5px;
border-radius: 5px;
}
div#toolbar div.toolbar-shortcuts ul li a:focus,
div#toolbar div.toolbar-shortcuts ul li a:hover,
div#toolbar div.toolbar-shortcuts ul li a.active:focus {
background: #555;
}
div#toolbar div.toolbar-shortcuts ul li a.active:hover,
div#toolbar div.toolbar-shortcuts ul li a.active {
background: #000;
}
div#toolbar div.toolbar-shortcuts span.icon {
float: left; /* LTR */
background: #444;
width: 30px;
height: 30px;
margin-right: 5px; /* LTR */
-moz-border-radius: 5px;
-webkit-border-radius: 5px;
border-radius: 5px;
}
div.add-or-remove-shortcuts {
padding-top: 5px;
}
div.add-or-remove-shortcuts a span.icon {
display: block;
width: 12px;
background: transparent url(shortcut.png) no-repeat scroll 0 0;
height: 12px;
float: left;
margin-left:8px;
}
div.add-shortcut a:focus span.icon,
div.add-shortcut a:hover span.icon {
background-position: 0 -12px;
}
div.remove-shortcut a span.icon {
background-position: -12px 0;
}
div.remove-shortcut a:focus span.icon,
div.remove-shortcut a:hover span.icon {
background-position: -12px -12px;
}
div.add-or-remove-shortcuts a span.text {
float: left;
padding-left:10px;
display: none;
}
div.add-or-remove-shortcuts a:focus span.text,
div.add-or-remove-shortcuts a:hover span.text {
font-size: 10px;
line-height: 12px;
color: #fff;
background-color: #5f605b;
display: block;
padding-right: 6px; /* LTR */
cursor: pointer;
-moz-border-radius: 0 5px 5px 0; /* LTR */
-webkit-border-top-right-radius: 5px; /* LTR */
-webkit-border-bottom-right-radius: 5px; /* LTR */
border-radius: 0 5px 5px 0; /* LTR */
}
#shortcut-set-switch .form-type-radios {
padding-bottom: 0;
margin-bottom: 0;
}
#shortcut-set-switch .form-item-new {
padding-top: 0;
padding-left: 17px; /* LTR */
}
name = Shortcut
description = Allows users to manage customizable lists of shortcut links.
package = Core
version = VERSION
core = 7.x
files[] = shortcut.test
configure = admin/config/user-interface/shortcut
; Information added by Drupal.org packaging script on 2023-03-15
version = "7.95"
project = "drupal"
datestamp = "1678902530"
title = $t('Default');
$shortcut_set->links = array(
array(
'link_path' => 'node/add',
'link_title' => $t('Add content'),
'weight' => -20,
),
array(
'link_path' => 'admin/content',
'link_title' => $t('Find content'),
'weight' => -19,
),
);
// If Drupal is being installed, rebuild the menu before saving the shortcut
// set, to make sure the links defined above can be correctly saved. (During
// installation, the menu might not have been built at all yet, or it might
// have been built but without the node module's links in it.)
if (drupal_installation_attempted()) {
menu_rebuild();
}
shortcut_set_save($shortcut_set);
}
/**
* Implements hook_uninstall().
*/
function shortcut_uninstall() {
drupal_load('module', 'shortcut');
// Delete the menu links associated with each shortcut set.
foreach (shortcut_sets() as $shortcut_set) {
menu_delete_links($shortcut_set->set_name);
}
}
/**
* Implements hook_schema().
*/
function shortcut_schema() {
$schema['shortcut_set'] = array(
'description' => 'Stores information about sets of shortcuts links.',
'fields' => array(
'set_name' => array(
'type' => 'varchar',
'length' => 32,
'not null' => TRUE,
'default' => '',
'description' => "Primary Key: The {menu_links}.menu_name under which the set's links are stored.",
),
'title' => array(
'type' => 'varchar',
'length' => 255,
'not null' => TRUE,
'default' => '',
'description' => 'The title of the set.',
),
),
'primary key' => array('set_name'),
'foreign keys' => array(
'menu_name' => array(
'table' => 'menu_links',
'columns' => array('set_name' => 'menu_name'),
),
),
);
$schema['shortcut_set_users'] = array(
'description' => 'Maps users to shortcut sets.',
'fields' => array(
'uid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'default' => 0,
'description' => 'The {users}.uid for this set.',
),
'set_name' => array(
'type' => 'varchar',
'length' => 32,
'not null' => TRUE,
'default' => '',
'description' => "The {shortcut_set}.set_name that will be displayed for this user.",
),
),
'primary key' => array('uid'),
'indexes' => array(
'set_name' => array('set_name'),
),
'foreign keys' => array(
'set_user' => array(
'table' => 'users',
'columns' => array('uid' => 'uid'),
),
'set_name' => array(
'table' => 'shortcut_set',
'columns' => array('set_name' => 'set_name'),
),
),
);
return $schema;
}
' . t('About') . '';
$output .= '' . t('The Shortcut module allows users to create sets of shortcut links to commonly-visited pages of the site. Shortcuts are contained within sets . Each user with Select any shortcut set permission can select a shortcut set created by anyone at the site. For more information, see the online handbook entry for Shortcut module .', array('@shortcut' => 'http://drupal.org/documentation/modules/shortcut/')) . '
';
$output .= '' . t('Uses') . ' ';
$output .= '' . t('Administering shortcuts') . ' ';
$output .= '' . t('Users with the Administer shortcuts permission can manage shortcut sets and edit the shortcuts within sets from the Shortcuts administration page .', array('@shortcuts' => url('admin/config/user-interface/shortcut'))) . ' ';
$output .= '' . t('Choosing shortcut sets') . ' ';
$output .= '' . t('Users with permission to switch shortcut sets can choose a shortcut set to use from the Shortcuts tab of their user account page.') . ' ';
$output .= '' . t('Adding and removing shortcuts') . ' ';
$output .= '' . t('The Shortcut module creates an add/remove link for each page on your site; the link lets you add or remove the current page from the currently-enabled set of shortcuts (if your theme displays it and you have permission to edit your shortcut set). The core Seven administration theme displays this link next to the page title, as a small + or - sign. If you click on the + sign, you will add that page to your preferred set of shortcuts. If the page is already part of your shortcut set, the link will be a - sign, and will allow you to remove the current page from your shortcut set.') . ' ';
$output .= '' . t('Displaying shortcuts') . ' ';
$output .= '' . t('You can display your shortcuts by enabling the Shortcuts block on the Blocks administration page . Certain administrative modules also display your shortcuts; for example, the core Toolbar module displays them near the top of the page, along with an Edit shortcuts link.', array('@blocks' => url('admin/structure/block'), '@toolbar-help' => url('admin/help/toolbar'))) . ' ';
$output .= '' . t('Define which shortcut set you are using on the Shortcuts tab of your account page.', array('@shortcut-link' => url("user/{$user->uid}/shortcuts"))) . '
';
return $output;
}
}
}
/**
* Implements hook_permission().
*/
function shortcut_permission() {
return array(
'administer shortcuts' => array(
'title' => t('Administer shortcuts'),
),
'customize shortcut links' => array(
'title' => t('Edit current shortcut set'),
'description' => t('Editing the current shortcut set will affect other users if that set has been assigned to or selected by other users. Granting "Select any shortcut set" permission along with this permission will grant permission to edit any shortcut set.'),
),
'switch shortcut sets' => array(
'title' => t('Select any shortcut set'),
'description' => t('From all shortcut sets, select one to be own active set. Without this permission, an administrator selects shortcut sets for users.'),
),
);
}
/**
* Implements hook_menu().
*/
function shortcut_menu() {
$items['admin/config/user-interface/shortcut'] = array(
'title' => 'Shortcuts',
'description' => 'Add and modify shortcut sets.',
'page callback' => 'shortcut_set_admin',
'access arguments' => array('administer shortcuts'),
'file' => 'shortcut.admin.inc',
);
$items['admin/config/user-interface/shortcut/add-set'] = array(
'title' => 'Add shortcut set',
'page callback' => 'drupal_get_form',
'page arguments' => array('shortcut_set_add_form'),
'access arguments' => array('administer shortcuts'),
'type' => MENU_LOCAL_ACTION,
'file' => 'shortcut.admin.inc',
);
$items['admin/config/user-interface/shortcut/%shortcut_set'] = array(
'title' => 'Edit shortcuts',
'page callback' => 'drupal_get_form',
'page arguments' => array('shortcut_set_customize', 4),
'title callback' => 'shortcut_set_title_callback',
'title arguments' => array(4),
'access callback' => 'shortcut_set_edit_access',
'access arguments' => array(4),
'file' => 'shortcut.admin.inc',
);
$items['admin/config/user-interface/shortcut/%shortcut_set/links'] = array(
'title' => 'List links',
'type' => MENU_DEFAULT_LOCAL_TASK,
);
$items['admin/config/user-interface/shortcut/%shortcut_set/edit'] = array(
'title' => 'Edit set name',
'page callback' => 'drupal_get_form',
'page arguments' => array('shortcut_set_edit_form', 4),
'access callback' => 'shortcut_set_edit_access',
'access arguments' => array(4),
'type' => MENU_LOCAL_TASK,
'file' => 'shortcut.admin.inc',
'weight' => 10,
);
$items['admin/config/user-interface/shortcut/%shortcut_set/delete'] = array(
'title' => 'Delete shortcut set',
'page callback' => 'drupal_get_form',
'page arguments' => array('shortcut_set_delete_form', 4),
'access callback' => 'shortcut_set_delete_access',
'access arguments' => array(4),
'file' => 'shortcut.admin.inc',
);
$items['admin/config/user-interface/shortcut/%shortcut_set/add-link'] = array(
'title' => 'Add shortcut',
'page callback' => 'drupal_get_form',
'page arguments' => array('shortcut_link_add', 4),
'access callback' => 'shortcut_set_edit_access',
'access arguments' => array(4),
'type' => MENU_LOCAL_ACTION,
'file' => 'shortcut.admin.inc',
);
$items['admin/config/user-interface/shortcut/%shortcut_set/add-link-inline'] = array(
'title' => 'Add shortcut',
'page callback' => 'shortcut_link_add_inline',
'page arguments' => array(4),
'access callback' => 'shortcut_set_edit_access',
'access arguments' => array(4),
'type' => MENU_CALLBACK,
'file' => 'shortcut.admin.inc',
);
$items['admin/config/user-interface/shortcut/link/%menu_link'] = array(
'title' => 'Edit shortcut',
'page callback' => 'drupal_get_form',
'page arguments' => array('shortcut_link_edit', 5),
'access callback' => 'shortcut_link_access',
'access arguments' => array(5),
'file' => 'shortcut.admin.inc',
);
$items['admin/config/user-interface/shortcut/link/%menu_link/delete'] = array(
'title' => 'Delete shortcut',
'page callback' => 'drupal_get_form',
'page arguments' => array('shortcut_link_delete', 5),
'access callback' => 'shortcut_link_access',
'access arguments' => array(5),
'file' => 'shortcut.admin.inc',
);
$items['user/%user/shortcuts'] = array(
'title' => 'Shortcuts',
'page callback' => 'drupal_get_form',
'page arguments' => array('shortcut_set_switch', 1),
'access callback' => 'shortcut_set_switch_access',
'access arguments' => array(1),
'type' => MENU_LOCAL_TASK,
'file' => 'shortcut.admin.inc',
);
return $items;
}
/**
* Implements hook_admin_paths().
*/
function shortcut_admin_paths() {
$paths = array(
'user/*/shortcuts' => TRUE,
);
return $paths;
}
/**
* Implements hook_theme().
*/
function shortcut_theme() {
return array(
'shortcut_set_customize' => array(
'render element' => 'form',
'file' => 'shortcut.admin.inc',
),
);
}
/**
* Implements hook_block_info().
*/
function shortcut_block_info() {
$blocks['shortcuts']['info'] = t('Shortcuts');
// Shortcut blocks can't be cached because each menu item can have a custom
// access callback. menu.inc manages its own caching.
$blocks['shortcuts']['cache'] = DRUPAL_NO_CACHE;
return $blocks;
}
/**
* Implements hook_block_view().
*/
function shortcut_block_view($delta = '') {
if ($delta == 'shortcuts') {
$shortcut_set = shortcut_current_displayed_set();
$data['subject'] = t('@shortcut_set shortcuts', array('@shortcut_set' => $shortcut_set->title));
$data['content'] = shortcut_renderable_links($shortcut_set);
return $data;
}
}
/**
* Access callback for editing a shortcut set.
*
* @param object $shortcut_set
* (optional) The shortcut set to be edited. If not set, the current user's
* shortcut set will be used.
*
* @return
* TRUE if the current user has access to edit the shortcut set, FALSE
* otherwise.
*/
function shortcut_set_edit_access($shortcut_set = NULL) {
// Sufficiently-privileged users can edit their currently displayed shortcut
// set, but not other sets. Shortcut administrators can edit any set.
if (user_access('administer shortcuts')) {
return TRUE;
}
if (user_access('customize shortcut links')) {
return !isset($shortcut_set) || $shortcut_set == shortcut_current_displayed_set();
}
return FALSE;
}
/**
* Access callback for deleting a shortcut set.
*
* @param $shortcut_set
* The shortcut set to be deleted.
*
* @return
* TRUE if the current user has access to delete shortcut sets and this is
* not the site-wide default set; FALSE otherwise.
*/
function shortcut_set_delete_access($shortcut_set) {
// Only admins can delete sets.
if (!user_access('administer shortcuts')) {
return FALSE;
}
// Never let the default shortcut set be deleted.
if ($shortcut_set->set_name == SHORTCUT_DEFAULT_SET_NAME) {
return FALSE;
}
return TRUE;
}
/**
* Access callback for switching the shortcut set assigned to a user account.
*
* @param object $account
* (optional) The user account whose shortcuts will be switched. If not set,
* permissions will be checked for switching the logged-in user's own
* shortcut set.
*
* @return
* TRUE if the current user has access to switch the shortcut set of the
* provided account, FALSE otherwise.
*/
function shortcut_set_switch_access($account = NULL) {
global $user;
if (user_access('administer shortcuts')) {
// Administrators can switch anyone's shortcut set.
return TRUE;
}
if (!user_access('switch shortcut sets')) {
// The user has no permission to switch anyone's shortcut set.
return FALSE;
}
if (!isset($account) || $user->uid == $account->uid) {
// Users with the 'switch shortcut sets' permission can switch their own
// shortcuts sets.
return TRUE;
}
return FALSE;
}
/**
* Access callback for editing a link in a shortcut set.
*/
function shortcut_link_access($menu_link) {
// The link must belong to a shortcut set that the current user has access
// to edit.
if ($shortcut_set = shortcut_set_load($menu_link['menu_name'])) {
return shortcut_set_edit_access($shortcut_set);
}
return FALSE;
}
/**
* Loads the data for a shortcut set.
*
* @param $set_name
* The name of the shortcut set to load.
*
* @return object
* If the shortcut set exists, an object containing the following properties:
* - 'set_name': The internal name of the shortcut set.
* - 'title': The title of the shortcut set.
* - 'links': An array of links associated with this shortcut set.
* If the shortcut set does not exist, the function returns FALSE.
*/
function shortcut_set_load($set_name) {
$set = db_select('shortcut_set', 'ss')
->fields('ss')
->condition('set_name', $set_name)
->execute()
->fetchObject();
if (!$set) {
return FALSE;
}
$set->links = menu_load_links($set_name);
return $set;
}
/**
* Saves a shortcut set.
*
* @param $shortcut_set
* An object containing the following properties:
* - 'title': The title of the shortcut set.
* - 'set_name': (optional) The internal name of the shortcut set. If
* omitted, a new shortcut set will be created, and the 'set_name' property
* will be added to the passed-in object.
* - 'links': (optional) An array of menu links to save for the shortcut set.
* Each link is an array containing at least the following keys (which will
* be expanded to fill in other default values after the shortcut set is
* saved):
* - 'link_path': The Drupal path or external path that the link points to.
* - 'link_title': The title of the link.
* Any other keys accepted by menu_link_save() may also be provided.
*
* @return
* A constant which is either SAVED_NEW or SAVED_UPDATED depending on whether
* a new set was created or an existing one was updated.
*
* @see menu_link_save()
*/
function shortcut_set_save(&$shortcut_set) {
// First save the shortcut set itself.
if (isset($shortcut_set->set_name)) {
$return = drupal_write_record('shortcut_set', $shortcut_set, 'set_name');
}
else {
$shortcut_set->set_name = shortcut_set_get_unique_name();
$return = drupal_write_record('shortcut_set', $shortcut_set);
}
// If links were provided for the set, save them.
if (isset($shortcut_set->links)) {
foreach ($shortcut_set->links as &$link) {
// Do not specifically associate these links with the shortcut module,
// since other modules may make them editable via the menu system.
// However, we do need to specify the correct menu name.
$link['menu_name'] = $shortcut_set->set_name;
$link['plid'] = 0;
menu_link_save($link);
}
// Make sure that we have a return value, since if the links were updated
// but the shortcut set was not, the call to drupal_write_record() above
// would not return an indication that anything had changed.
if (empty($return)) {
$return = SAVED_UPDATED;
}
}
return $return;
}
/**
* Deletes a shortcut set.
*
* Note that the default set cannot be deleted.
*
* @param $shortcut_set
* An object representing the shortcut set to delete.
*
* @return
* TRUE if the set was deleted, FALSE otherwise.
*/
function shortcut_set_delete($shortcut_set) {
// Don't allow deletion of the system default shortcut set.
if ($shortcut_set->set_name == SHORTCUT_DEFAULT_SET_NAME) {
return FALSE;
}
// First, delete any user assignments for this set, so that each of these
// users will go back to using whatever default set applies.
db_delete('shortcut_set_users')
->condition('set_name', $shortcut_set->set_name)
->execute();
// Next, delete the menu links for this set.
menu_delete_links($shortcut_set->set_name);
// Finally, delete the set itself.
$deleted = db_delete('shortcut_set')
->condition('set_name', $shortcut_set->set_name)
->execute();
return (bool) $deleted;
}
/**
* Resets the link weights in a shortcut set to match their current order.
*
* This function can be used, for example, when a new shortcut link is added to
* the set. If the link is added to the end of the array and this function is
* called, it will force that link to display at the end of the list.
*
* @param object $shortcut_set
* An object representing a shortcut set. The link weights of the passed-in
* object will be reset as described above.
*/
function shortcut_set_reset_link_weights(&$shortcut_set) {
$weight = -50;
foreach ($shortcut_set->links as &$link) {
$link['weight'] = $weight;
$weight++;
}
}
/**
* Assigns a user to a particular shortcut set.
*
* @param $shortcut_set
* An object representing the shortcut set.
* @param $account
* A user account that will be assigned to use the set.
*/
function shortcut_set_assign_user($shortcut_set, $account) {
db_merge('shortcut_set_users')
->key(array('uid' => $account->uid))
->fields(array('set_name' => $shortcut_set->set_name))
->execute();
drupal_static_reset('shortcut_current_displayed_set');
}
/**
* Unassigns a user from any shortcut set they may have been assigned to.
*
* The user will go back to using whatever default set applies.
*
* @param $account
* A user account that will be removed from the shortcut set assignment.
*
* @return
* TRUE if the user was previously assigned to a shortcut set and has been
* successfully removed from it. FALSE if the user was already not assigned
* to any set.
*/
function shortcut_set_unassign_user($account) {
$deleted = db_delete('shortcut_set_users')
->condition('uid', $account->uid)
->execute();
return (bool) $deleted;
}
/**
* Returns the current displayed shortcut set for the provided user account.
*
* @param $account
* (optional) The user account whose shortcuts will be returned. Defaults to
* the currently logged-in user.
*
* @return
* An object representing the shortcut set that should be displayed to the
* current user. If the user does not have an explicit shortcut set defined,
* the default set is returned.
*/
function shortcut_current_displayed_set($account = NULL) {
$shortcut_sets = &drupal_static(__FUNCTION__, array());
global $user;
if (!isset($account)) {
$account = $user;
}
// Try to return a shortcut set from the static cache.
if (isset($shortcut_sets[$account->uid])) {
return $shortcut_sets[$account->uid];
}
// If none was found, try to find a shortcut set that is explicitly assigned
// to this user.
$query = db_select('shortcut_set', 's');
$query->addField('s', 'set_name');
$query->join('shortcut_set_users', 'u', 's.set_name = u.set_name');
$query->condition('u.uid', $account->uid);
$shortcut_set_name = $query->execute()->fetchField();
if ($shortcut_set_name) {
$shortcut_set = shortcut_set_load($shortcut_set_name);
}
// Otherwise, use the default set.
else {
$shortcut_set = shortcut_default_set($account);
}
$shortcut_sets[$account->uid] = $shortcut_set;
return $shortcut_set;
}
/**
* Returns the default shortcut set for a given user account.
*
* @param object $account
* (optional) The user account whose default shortcut set will be returned.
* If not provided, the function will return the currently logged-in user's
* default shortcut set.
*
* @return
* An object representing the default shortcut set.
*/
function shortcut_default_set($account = NULL) {
global $user;
if (!isset($account)) {
$account = $user;
}
// Allow modules to return a default shortcut set name. Since we can only
// have one, we allow the last module which returns a valid result to take
// precedence. If no module returns a valid set, fall back on the site-wide
// default, which is the lowest-numbered shortcut set.
$suggestions = array_reverse(module_invoke_all('shortcut_default_set', $account));
$suggestions[] = SHORTCUT_DEFAULT_SET_NAME;
foreach ($suggestions as $name) {
if ($shortcut_set = shortcut_set_load($name)) {
break;
}
}
return $shortcut_set;
}
/**
* Returns a unique, machine-readable shortcut set name.
*/
function shortcut_set_get_unique_name() {
// Shortcut sets are numbered sequentially, so we keep trying until we find
// one that is available. For better performance, we start with a number
// equal to one more than the current number of shortcut sets, so that if
// no shortcut sets have been deleted from the database, this will
// automatically give us the correct one.
$number = db_query("SELECT COUNT(*) FROM {shortcut_set}")->fetchField() + 1;
do {
$name = shortcut_set_name($number);
$number++;
} while ($shortcut_set = shortcut_set_load($name));
return $name;
}
/**
* Returns the name of a shortcut set, based on a provided number.
*
* All shortcut sets have names like "shortcut-set-N" so that they can be
* matched with a properly-namespaced entry in the {menu_links} table.
*
* @param $number
* A number representing the shortcut set whose name should be retrieved.
*
* @return
* A string representing the expected shortcut name.
*/
function shortcut_set_name($number) {
return "shortcut-set-$number";
}
/**
* Returns an array of all shortcut sets, keyed by the set name.
*
* @return
* An array of shortcut sets. Note that only the basic shortcut set
* properties (name and title) are returned by this function, not the list
* of menu links that belong to the set.
*/
function shortcut_sets() {
return db_select('shortcut_set', 'ss')
->fields('ss')
->execute()
->fetchAllAssoc('set_name');
}
/**
* Check to see if a shortcut set with the given title already exists.
*
* @param $title
* Human-readable name of the shortcut set to check.
*
* @return
* TRUE if a shortcut set with that title exists; FALSE otherwise.
*/
function shortcut_set_title_exists($title) {
return (bool) db_query_range('SELECT 1 FROM {shortcut_set} WHERE title = :title', 0, 1, array(':title' => $title))->fetchField();
}
/**
* Determines if a path corresponds to a valid shortcut link.
*
* @param $path
* The path to the link.
* @return
* TRUE if the shortcut link is valid, FALSE otherwise. Valid links are ones
* that correspond to actual paths on the site.
*
* @see menu_edit_item_validate()
*/
function shortcut_valid_link($path) {
// Do not use URL aliases.
$normal_path = drupal_get_normal_path($path);
if ($path != $normal_path) {
$path = $normal_path;
}
// An empty path is valid too and will be converted to .
return (!url_is_external($path) && menu_get_item($path)) || empty($path) || $path == '';
}
/**
* Returns an array of shortcut links, suitable for rendering.
*
* @param $shortcut_set
* (optional) An object representing the set whose links will be displayed.
* If not provided, the user's current set will be displayed.
* @return
* An array of shortcut links, in the format returned by the menu system.
*
* @see menu_tree()
*/
function shortcut_renderable_links($shortcut_set = NULL) {
if (!isset($shortcut_set)) {
$shortcut_set = shortcut_current_displayed_set();
}
return menu_tree($shortcut_set->set_name);
}
/**
* Implements hook_preprocess_page().
*/
function shortcut_preprocess_page(&$variables) {
// Only display the shortcut link if the user has the ability to edit
// shortcuts and if the page's actual content is being shown (for example,
// we do not want to display it on "access denied" or "page not found"
// pages).
if (shortcut_set_edit_access() && ($item = menu_get_item()) && $item['access']) {
$link = $_GET['q'];
$query_parameters = drupal_get_query_parameters();
if (!empty($query_parameters)) {
$link .= '?' . drupal_http_build_query($query_parameters);
}
$query = array(
'link' => $link,
'name' => drupal_get_title(),
);
$query += drupal_get_destination();
$shortcut_set = shortcut_current_displayed_set();
// Check if $link is already a shortcut and set $link_mode accordingly.
foreach ($shortcut_set->links as $shortcut) {
if ($link == $shortcut['link_path']) {
$mlid = $shortcut['mlid'];
break;
}
}
$link_mode = isset($mlid) ? "remove" : "add";
if ($link_mode == "add") {
$query['token'] = drupal_get_token('shortcut-add-link');
$link_text = shortcut_set_switch_access() ? t('Add to %shortcut_set shortcuts', array('%shortcut_set' => $shortcut_set->title)) : t('Add to shortcuts');
$link_path = 'admin/config/user-interface/shortcut/' . $shortcut_set->set_name . '/add-link-inline';
}
else {
$query['mlid'] = $mlid;
$link_text = shortcut_set_switch_access() ? t('Remove from %shortcut_set shortcuts', array('%shortcut_set' => $shortcut_set->title)) : t('Remove from shortcuts');
$link_path = 'admin/config/user-interface/shortcut/link/' . $mlid . '/delete';
}
if (theme_get_setting('shortcut_module_link')) {
$variables['title_suffix']['add_or_remove_shortcut'] = array(
'#attached' => array('css' => array(drupal_get_path('module', 'shortcut') . '/shortcut.css')),
'#prefix' => '',
'#type' => 'link',
'#title' => '' . $link_text . ' ',
'#href' => $link_path,
'#options' => array('query' => $query, 'html' => TRUE),
'#suffix' => '
',
);
}
}
}
/**
* Implements hook_page_alter().
*/
function shortcut_page_alter(&$page) {
if (isset($page['page_top']['toolbar'])) {
// If the toolbar is available, add a pre-render function to display the
// current shortcuts in the toolbar drawer.
$page['page_top']['toolbar']['#pre_render'][] = 'shortcut_toolbar_pre_render';
}
}
/**
* Pre-render function for adding shortcuts to the toolbar drawer.
*/
function shortcut_toolbar_pre_render($toolbar) {
$links = shortcut_renderable_links();
$links['#attached'] = array('css' => array(drupal_get_path('module', 'shortcut') . '/shortcut.css'));
$links['#prefix'] = '';
$links['#suffix'] = '
';
$shortcut_set = shortcut_current_displayed_set();
$configure_link = NULL;
if (shortcut_set_edit_access($shortcut_set)) {
$configure_link = array(
'#type' => 'link',
'#title' => t('Edit shortcuts'),
'#href' => 'admin/config/user-interface/shortcut/' . $shortcut_set->set_name,
'#options' => array('attributes' => array('id' => 'edit-shortcuts')),
);
}
$drawer = array(
'shortcuts' => $links,
'configure' => $configure_link,
);
$toolbar['toolbar_drawer'][] = $drawer;
return $toolbar;
}
/**
* Returns the sanitized title of a shortcut set.
*
* Deprecated. This function was previously used as a menu item title callback
* but has been replaced by shortcut_set_title_callback() (which does not
* sanitize the title, since the menu system does that automatically). In
* Drupal 7, use that function for title callbacks, and call check_plain()
* directly if you need a sanitized title. In Drupal 8, this function will be
* restored as a title callback and therefore will no longer sanitize its
* output.
*
* @param $shortcut_set
* An object representing the shortcut set, as returned by
* shortcut_set_load().
*/
function shortcut_set_title($shortcut_set) {
return check_plain($shortcut_set->title);
}
/**
* Returns the title of a shortcut set.
*
* Title callback for the editing pages for shortcut sets.
*
* @param $shortcut_set
* An object representing the shortcut set, as returned by
* shortcut_set_load().
*/
function shortcut_set_title_callback($shortcut_set) {
return $shortcut_set->title;
}
PNG
IHDR $
gAMA |Q PLTE إ~~~NNNlllHHHEEExxxɥpql---cd_KKK_`[ |
tRNS lo6e -IDAT(]Y0DB&vO7vg,>ЃZOdIAs8~/ͱ>`lL0 KfN.)~A3sژFli&8AĭJ*!ub朔{e춦c}T >U4 )EV{T52UfjJJd ,U
RtWkpe:v~*s q٢,_B5/2[d dr[̜BҬwyT6VC7B% SV%[d7̹)]w1_M];<<=6a8mڴ[ IENDB`admin_user = $this->drupalCreateUser(array('access toolbar', 'administer shortcuts', 'view the administration theme', 'create article content', 'create page content', 'access content overview'));
$this->shortcut_user = $this->drupalCreateUser(array('customize shortcut links', 'switch shortcut sets'));
// Create a node.
$this->node = $this->drupalCreateNode(array('type' => 'article'));
// Log in as admin and grab the default shortcut set.
$this->drupalLogin($this->admin_user);
$this->set = shortcut_set_load(SHORTCUT_DEFAULT_SET_NAME);
shortcut_set_assign_user($this->set, $this->admin_user);
}
/**
* Creates a generic shortcut set.
*/
function generateShortcutSet($title = '', $default_links = TRUE) {
$set = new stdClass();
$set->title = empty($title) ? $this->randomName(10) : $title;
if ($default_links) {
$set->links = array();
$set->links[] = $this->generateShortcutLink('node/add');
$set->links[] = $this->generateShortcutLink('admin/content');
}
shortcut_set_save($set);
return $set;
}
/**
* Creates a generic shortcut link.
*/
function generateShortcutLink($path, $title = '') {
$link = array(
'link_path' => $path,
'link_title' => !empty($title) ? $title : $this->randomName(10),
);
return $link;
}
/**
* Extracts information from shortcut set links.
*
* @param object $set
* The shortcut set object to extract information from.
* @param string $key
* The array key indicating what information to extract from each link:
* - 'link_path': Extract link paths.
* - 'link_title': Extract link titles.
* - 'mlid': Extract the menu link item ID numbers.
*
* @return array
* Array of the requested information from each link.
*/
function getShortcutInformation($set, $key) {
$info = array();
foreach ($set->links as $link) {
$info[] = $link[$key];
}
return $info;
}
}
/**
* Defines shortcut links test cases.
*/
class ShortcutLinksTestCase extends ShortcutTestCase {
public static function getInfo() {
return array(
'name' => 'Shortcut link functionality',
'description' => 'Create, view, edit, delete, and change shortcut links.',
'group' => 'Shortcut',
);
}
/**
* Tests that creating a shortcut works properly.
*/
function testShortcutLinkAdd() {
$set = $this->set;
// Create an alias for the node so we can test aliases.
$path = array(
'source' => 'node/' . $this->node->nid,
'alias' => $this->randomName(8),
);
path_save($path);
// Create some paths to test.
$test_cases = array(
array('path' => ''),
array('path' => 'admin'),
array('path' => 'admin/config/system/site-information'),
array('path' => "node/{$this->node->nid}/edit"),
array('path' => $path['alias']),
);
// Check that each new shortcut links where it should.
foreach ($test_cases as $test) {
$title = $this->randomName(10);
$form_data = array(
'shortcut_link[link_title]' => $title,
'shortcut_link[link_path]' => $test['path'],
);
$this->drupalPost('admin/config/user-interface/shortcut/' . $set->set_name . '/add-link', $form_data, t('Save'));
$this->assertResponse(200);
$saved_set = shortcut_set_load($set->set_name);
$paths = $this->getShortcutInformation($saved_set, 'link_path');
$test_path = empty($test['path']) ? '' : $test['path'];
$this->assertTrue(in_array(drupal_get_normal_path($test_path), $paths), 'Shortcut created: '. $test['path']);
$this->assertLink($title, 0, 'Shortcut link found on the page.');
}
}
/**
* Tests that the "add to shortcut" link changes to "remove shortcut".
*/
function testShortcutQuickLink() {
$this->drupalGet($this->set->links[0]['link_path']);
$this->assertRaw(t('Remove from %title shortcuts', array('%title' => $this->set->title)), '"Add to shortcuts" link properly switched to "Remove from shortcuts".');
}
/**
* Tests that shortcut links can be renamed.
*/
function testShortcutLinkRename() {
$set = $this->set;
// Attempt to rename shortcut link.
$new_link_name = $this->randomName(10);
$this->drupalPost('admin/config/user-interface/shortcut/link/' . $set->links[0]['mlid'], array('shortcut_link[link_title]' => $new_link_name, 'shortcut_link[link_path]' => $set->links[0]['link_path']), t('Save'));
$saved_set = shortcut_set_load($set->set_name);
$titles = $this->getShortcutInformation($saved_set, 'link_title');
$this->assertTrue(in_array($new_link_name, $titles), 'Shortcut renamed: ' . $new_link_name);
$this->assertLink($new_link_name, 0, 'Renamed shortcut link appears on the page.');
}
/**
* Tests that changing the path of a shortcut link works.
*/
function testShortcutLinkChangePath() {
$set = $this->set;
// Tests changing a shortcut path.
$new_link_path = 'admin/config';
$this->drupalPost('admin/config/user-interface/shortcut/link/' . $set->links[0]['mlid'], array('shortcut_link[link_title]' => $set->links[0]['link_title'], 'shortcut_link[link_path]' => $new_link_path), t('Save'));
$saved_set = shortcut_set_load($set->set_name);
$paths = $this->getShortcutInformation($saved_set, 'link_path');
$this->assertTrue(in_array($new_link_path, $paths), 'Shortcut path changed: ' . $new_link_path);
$this->assertLinkByHref($new_link_path, 0, 'Shortcut with new path appears on the page.');
}
/**
* Tests deleting a shortcut link.
*/
function testShortcutLinkDelete() {
$set = $this->set;
$this->drupalPost('admin/config/user-interface/shortcut/link/' . $set->links[0]['mlid'] . '/delete', array(), 'Delete');
$saved_set = shortcut_set_load($set->set_name);
$mlids = $this->getShortcutInformation($saved_set, 'mlid');
$this->assertFalse(in_array($set->links[0]['mlid'], $mlids), 'Successfully deleted a shortcut.');
}
/**
* Tests that the add shortcut link is not displayed for 404/403 errors.
*
* Tests that the "Add to shortcuts" link is not displayed on a page not
* found or a page the user does not have access to.
*/
function testNoShortcutLink() {
// Change to a theme that displays shortcuts.
variable_set('theme_default', 'seven');
$this->drupalGet('page-that-does-not-exist');
$this->assertNoRaw('add-shortcut', 'Add to shortcuts link was not shown on a page not found.');
// The user does not have access to this path.
$this->drupalGet('admin/modules');
$this->assertNoRaw('add-shortcut', 'Add to shortcuts link was not shown on a page the user does not have access to.');
// Verify that the testing mechanism works by verifying the shortcut
// link appears on admin/content/node.
$this->drupalGet('admin/content/node');
$this->assertRaw('add-shortcut', 'Add to shortcuts link was shown on a page the user does have access to.');
}
}
/**
* Defines shortcut set test cases.
*/
class ShortcutSetsTestCase extends ShortcutTestCase {
public static function getInfo() {
return array(
'name' => 'Shortcut set functionality',
'description' => 'Create, view, edit, delete, and change shortcut sets.',
'group' => 'Shortcut',
);
}
/**
* Tests creating a shortcut set.
*/
function testShortcutSetAdd() {
$new_set = $this->generateShortcutSet($this->randomName(10));
$sets = shortcut_sets();
$this->assertTrue(isset($sets[$new_set->set_name]), 'Successfully created a shortcut set.');
$this->drupalGet('user/' . $this->admin_user->uid . '/shortcuts');
$this->assertText($new_set->title, 'Generated shortcut set was listed as a choice on the user account page.');
}
/**
* Tests switching a user's own shortcut set.
*/
function testShortcutSetSwitchOwn() {
$new_set = $this->generateShortcutSet($this->randomName(10));
// Attempt to switch the default shortcut set to the newly created shortcut
// set.
$this->drupalPost('user/' . $this->admin_user->uid . '/shortcuts', array('set' => $new_set->set_name), t('Change set'));
$this->assertResponse(200);
$current_set = shortcut_current_displayed_set($this->admin_user);
$this->assertTrue($new_set->set_name == $current_set->set_name, 'Successfully switched own shortcut set.');
}
/**
* Tests switching another user's shortcut set.
*/
function testShortcutSetAssign() {
$new_set = $this->generateShortcutSet($this->randomName(10));
shortcut_set_assign_user($new_set, $this->shortcut_user);
$current_set = shortcut_current_displayed_set($this->shortcut_user);
$this->assertTrue($new_set->set_name == $current_set->set_name, "Successfully switched another user's shortcut set.");
}
/**
* Tests switching a user's shortcut set and creating one at the same time.
*/
function testShortcutSetSwitchCreate() {
$edit = array(
'set' => 'new',
'new' => $this->randomName(10),
);
$this->drupalPost('user/' . $this->admin_user->uid . '/shortcuts', $edit, t('Change set'));
$current_set = shortcut_current_displayed_set($this->admin_user);
$this->assertNotEqual($current_set->set_name, $this->set->set_name, 'A shortcut set can be switched to at the same time as it is created.');
$this->assertEqual($current_set->title, $edit['new'], 'The new set is correctly assigned to the user.');
}
/**
* Tests switching a user's shortcut set without providing a new set name.
*/
function testShortcutSetSwitchNoSetName() {
$edit = array('set' => 'new');
$this->drupalPost('user/' . $this->admin_user->uid . '/shortcuts', $edit, t('Change set'));
$this->assertText(t('The new set name is required.'));
$current_set = shortcut_current_displayed_set($this->admin_user);
$this->assertEqual($current_set->set_name, $this->set->set_name, 'Attempting to switch to a new shortcut set without providing a set name does not succeed.');
}
/**
* Tests that shortcut_set_save() correctly updates existing links.
*/
function testShortcutSetSave() {
$set = $this->set;
$old_mlids = $this->getShortcutInformation($set, 'mlid');
$set->links[] = $this->generateShortcutLink('admin', $this->randomName(10));
shortcut_set_save($set);
$saved_set = shortcut_set_load($set->set_name);
$new_mlids = $this->getShortcutInformation($saved_set, 'mlid');
$this->assertTrue(count(array_intersect($old_mlids, $new_mlids)) == count($old_mlids), 'shortcut_set_save() did not inadvertently change existing mlids.');
}
/**
* Tests renaming a shortcut set.
*/
function testShortcutSetRename() {
$set = $this->set;
$new_title = $this->randomName(10);
$this->drupalPost('admin/config/user-interface/shortcut/' . $set->set_name . '/edit', array('title' => $new_title), t('Save'));
$set = shortcut_set_load($set->set_name);
$this->assertTrue($set->title == $new_title, 'Shortcut set has been successfully renamed.');
}
/**
* Tests renaming a shortcut set to the same name as another set.
*/
function testShortcutSetRenameAlreadyExists() {
$set = $this->generateShortcutSet($this->randomName(10));
$existing_title = $this->set->title;
$this->drupalPost('admin/config/user-interface/shortcut/' . $set->set_name . '/edit', array('title' => $existing_title), t('Save'));
$this->assertRaw(t('The shortcut set %name already exists. Choose another name.', array('%name' => $existing_title)));
$set = shortcut_set_load($set->set_name);
$this->assertNotEqual($set->title, $existing_title, format_string('The shortcut set %title cannot be renamed to %new-title because a shortcut set with that title already exists.', array('%title' => $set->title, '%new-title' => $existing_title)));
}
/**
* Tests unassigning a shortcut set.
*/
function testShortcutSetUnassign() {
$new_set = $this->generateShortcutSet($this->randomName(10));
shortcut_set_assign_user($new_set, $this->shortcut_user);
shortcut_set_unassign_user($this->shortcut_user);
$current_set = shortcut_current_displayed_set($this->shortcut_user);
$default_set = shortcut_default_set($this->shortcut_user);
$this->assertTrue($current_set->set_name == $default_set->set_name, "Successfully unassigned another user's shortcut set.");
}
/**
* Tests deleting a shortcut set.
*/
function testShortcutSetDelete() {
$new_set = $this->generateShortcutSet($this->randomName(10));
$this->drupalPost('admin/config/user-interface/shortcut/' . $new_set->set_name . '/delete', array(), t('Delete'));
$sets = shortcut_sets();
$this->assertFalse(isset($sets[$new_set->set_name]), 'Successfully deleted a shortcut set.');
}
/**
* Tests deleting the default shortcut set.
*/
function testShortcutSetDeleteDefault() {
$this->drupalGet('admin/config/user-interface/shortcut/' . SHORTCUT_DEFAULT_SET_NAME . '/delete');
$this->assertResponse(403);
}
}
0,
'#fail' => 0,
'#exception' => 0,
'#debug' => 0,
);
/**
* Assertions thrown in that test case.
*
* @var Array
*/
protected $assertions = array();
/**
* This class is skipped when looking for the source of an assertion.
*
* When displaying which function an assert comes from, it's not too useful
* to see "drupalWebTestCase->drupalLogin()', we would like to see the test
* that called it. So we need to skip the classes defining these helper
* methods.
*/
protected $skipClasses = array(__CLASS__ => TRUE);
/**
* Flag to indicate whether the test has been set up.
*
* The setUp() method isolates the test from the parent Drupal site by
* creating a random prefix for the database and setting up a clean file
* storage directory. The tearDown() method then cleans up this test
* environment. We must ensure that setUp() has been run. Otherwise,
* tearDown() will act on the parent Drupal site rather than the test
* environment, destroying live data.
*/
protected $setup = FALSE;
protected $setupDatabasePrefix = FALSE;
protected $setupEnvironment = FALSE;
/**
* Constructor for DrupalTestCase.
*
* @param $test_id
* Tests with the same id are reported together.
*/
public function __construct($test_id = NULL) {
$this->testId = $test_id;
}
/**
* Internal helper: stores the assert.
*
* @param $status
* Can be 'pass', 'fail', 'exception'.
* TRUE is a synonym for 'pass', FALSE for 'fail'.
* @param $message
* The message string.
* @param $group
* Which group this assert belongs to.
* @param $caller
* By default, the assert comes from a function whose name starts with
* 'test'. Instead, you can specify where this assert originates from
* by passing in an associative array as $caller. Key 'file' is
* the name of the source file, 'line' is the line number and 'function'
* is the caller function itself.
*/
protected function assert($status, $message = '', $group = 'Other', array $caller = NULL) {
// Convert boolean status to string status.
if (is_bool($status)) {
$status = $status ? 'pass' : 'fail';
}
// Increment summary result counter.
$this->results['#' . $status]++;
// Get the function information about the call to the assertion method.
if (!$caller) {
$caller = $this->getAssertionCall();
}
// Creation assertion array that can be displayed while tests are running.
$this->assertions[] = $assertion = array(
'test_id' => $this->testId,
'test_class' => get_class($this),
'status' => $status,
'message' => $message,
'message_group' => $group,
'function' => $caller['function'],
'line' => $caller['line'],
'file' => $caller['file'],
);
// Store assertion for display after the test has completed.
self::getDatabaseConnection()
->insert('simpletest')
->fields($assertion)
->execute();
// We do not use a ternary operator here to allow a breakpoint on
// test failure.
if ($status == 'pass') {
return TRUE;
}
else {
return FALSE;
}
}
/**
* Returns the database connection to the site running Simpletest.
*
* @return DatabaseConnection
* The database connection to use for inserting assertions.
*/
public static function getDatabaseConnection() {
try {
$connection = Database::getConnection('default', 'simpletest_original_default');
}
catch (DatabaseConnectionNotDefinedException $e) {
// If the test was not set up, the simpletest_original_default
// connection does not exist.
$connection = Database::getConnection('default', 'default');
}
return $connection;
}
/**
* Store an assertion from outside the testing context.
*
* This is useful for inserting assertions that can only be recorded after
* the test case has been destroyed, such as PHP fatal errors. The caller
* information is not automatically gathered since the caller is most likely
* inserting the assertion on behalf of other code. In all other respects
* the method behaves just like DrupalTestCase::assert() in terms of storing
* the assertion.
*
* @return
* Message ID of the stored assertion.
*
* @see DrupalTestCase::assert()
* @see DrupalTestCase::deleteAssert()
*/
public static function insertAssert($test_id, $test_class, $status, $message = '', $group = 'Other', array $caller = array()) {
// Convert boolean status to string status.
if (is_bool($status)) {
$status = $status ? 'pass' : 'fail';
}
$caller += array(
'function' => t('Unknown'),
'line' => 0,
'file' => t('Unknown'),
);
$assertion = array(
'test_id' => $test_id,
'test_class' => $test_class,
'status' => $status,
'message' => $message,
'message_group' => $group,
'function' => $caller['function'],
'line' => $caller['line'],
'file' => $caller['file'],
);
return self::getDatabaseConnection()
->insert('simpletest')
->fields($assertion)
->execute();
}
/**
* Delete an assertion record by message ID.
*
* @param $message_id
* Message ID of the assertion to delete.
* @return
* TRUE if the assertion was deleted, FALSE otherwise.
*
* @see DrupalTestCase::insertAssert()
*/
public static function deleteAssert($message_id) {
return (bool) self::getDatabaseConnection()
->delete('simpletest')
->condition('message_id', $message_id)
->execute();
}
/**
* Cycles through backtrace until the first non-assertion method is found.
*
* @return
* Array representing the true caller.
*/
protected function getAssertionCall() {
$backtrace = debug_backtrace();
// The first element is the call. The second element is the caller.
// We skip calls that occurred in one of the methods of our base classes
// or in an assertion function.
while (($caller = $backtrace[1]) &&
((isset($caller['class']) && isset($this->skipClasses[$caller['class']])) ||
substr($caller['function'], 0, 6) == 'assert')) {
// We remove that call.
array_shift($backtrace);
}
return _drupal_get_last_caller($backtrace);
}
/**
* Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
*
* @param $value
* The value on which the assertion is to be done.
* @param $message
* The message to display along with the assertion.
* @param $group
* The type of assertion - examples are "Browser", "PHP".
* @return
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertTrue($value, $message = '', $group = 'Other') {
return $this->assert((bool) $value, $message ? $message : t('Value @value is TRUE.', array('@value' => var_export($value, TRUE))), $group);
}
/**
* Check to see if a value is false (an empty string, 0, NULL, or FALSE).
*
* @param $value
* The value on which the assertion is to be done.
* @param $message
* The message to display along with the assertion.
* @param $group
* The type of assertion - examples are "Browser", "PHP".
* @return
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertFalse($value, $message = '', $group = 'Other') {
return $this->assert(!$value, $message ? $message : t('Value @value is FALSE.', array('@value' => var_export($value, TRUE))), $group);
}
/**
* Check to see if a value is NULL.
*
* @param $value
* The value on which the assertion is to be done.
* @param $message
* The message to display along with the assertion.
* @param $group
* The type of assertion - examples are "Browser", "PHP".
* @return
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertNull($value, $message = '', $group = 'Other') {
return $this->assert(!isset($value), $message ? $message : t('Value @value is NULL.', array('@value' => var_export($value, TRUE))), $group);
}
/**
* Check to see if a value is not NULL.
*
* @param $value
* The value on which the assertion is to be done.
* @param $message
* The message to display along with the assertion.
* @param $group
* The type of assertion - examples are "Browser", "PHP".
* @return
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertNotNull($value, $message = '', $group = 'Other') {
return $this->assert(isset($value), $message ? $message : t('Value @value is not NULL.', array('@value' => var_export($value, TRUE))), $group);
}
/**
* Check to see if two values are equal.
*
* @param $first
* The first value to check.
* @param $second
* The second value to check.
* @param $message
* The message to display along with the assertion.
* @param $group
* The type of assertion - examples are "Browser", "PHP".
* @return
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertEqual($first, $second, $message = '', $group = 'Other') {
return $this->assert($first == $second, $message ? $message : t('Value @first is equal to value @second.', array('@first' => var_export($first, TRUE), '@second' => var_export($second, TRUE))), $group);
}
/**
* Check to see if two values are not equal.
*
* @param $first
* The first value to check.
* @param $second
* The second value to check.
* @param $message
* The message to display along with the assertion.
* @param $group
* The type of assertion - examples are "Browser", "PHP".
* @return
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertNotEqual($first, $second, $message = '', $group = 'Other') {
return $this->assert($first != $second, $message ? $message : t('Value @first is not equal to value @second.', array('@first' => var_export($first, TRUE), '@second' => var_export($second, TRUE))), $group);
}
/**
* Check to see if two values are identical.
*
* @param $first
* The first value to check.
* @param $second
* The second value to check.
* @param $message
* The message to display along with the assertion.
* @param $group
* The type of assertion - examples are "Browser", "PHP".
* @return
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertIdentical($first, $second, $message = '', $group = 'Other') {
return $this->assert($first === $second, $message ? $message : t('Value @first is identical to value @second.', array('@first' => var_export($first, TRUE), '@second' => var_export($second, TRUE))), $group);
}
/**
* Check to see if two values are not identical.
*
* @param $first
* The first value to check.
* @param $second
* The second value to check.
* @param $message
* The message to display along with the assertion.
* @param $group
* The type of assertion - examples are "Browser", "PHP".
* @return
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertNotIdentical($first, $second, $message = '', $group = 'Other') {
return $this->assert($first !== $second, $message ? $message : t('Value @first is not identical to value @second.', array('@first' => var_export($first, TRUE), '@second' => var_export($second, TRUE))), $group);
}
/**
* Fire an assertion that is always positive.
*
* @param $message
* The message to display along with the assertion.
* @param $group
* The type of assertion - examples are "Browser", "PHP".
* @return
* TRUE.
*/
protected function pass($message = NULL, $group = 'Other') {
return $this->assert(TRUE, $message, $group);
}
/**
* Fire an assertion that is always negative.
*
* @param $message
* The message to display along with the assertion.
* @param $group
* The type of assertion - examples are "Browser", "PHP".
* @return
* FALSE.
*/
protected function fail($message = NULL, $group = 'Other') {
return $this->assert(FALSE, $message, $group);
}
/**
* Fire an error assertion.
*
* @param $message
* The message to display along with the assertion.
* @param $group
* The type of assertion - examples are "Browser", "PHP".
* @param $caller
* The caller of the error.
* @return
* FALSE.
*/
protected function error($message = '', $group = 'Other', array $caller = NULL) {
if ($group == 'User notice') {
// Since 'User notice' is set by trigger_error() which is used for debug
// set the message to a status of 'debug'.
return $this->assert('debug', $message, 'Debug', $caller);
}
return $this->assert('exception', $message, $group, $caller);
}
/**
* Logs a verbose message in a text file.
*
* The link to the verbose message will be placed in the test results as a
* passing assertion with the text '[verbose message]'.
*
* @param $message
* The verbose message to be stored.
*
* @see simpletest_verbose()
*/
protected function verbose($message) {
if ($id = simpletest_verbose($message)) {
$class_safe = str_replace('\\', '_', get_class($this));
$url = $this->verboseDirectoryUrl . '/' . $class_safe . '-' . $id . '.html';
// Not using l() to avoid invoking the theme system, so that unit tests
// can use verbose() as well.
$link = '' . t('Verbose message') . ' ';
$this->error($link, 'User notice');
}
}
/**
* Run all tests in this class.
*
* Regardless of whether $methods are passed or not, only method names
* starting with "test" are executed.
*
* @param $methods
* (optional) A list of method names in the test case class to run; e.g.,
* array('testFoo', 'testBar'). By default, all methods of the class are
* taken into account, but it can be useful to only run a few selected test
* methods during debugging.
*/
public function run(array $methods = array()) {
// Initialize verbose debugging.
$class = get_class($this);
simpletest_verbose(NULL, variable_get('file_public_path', conf_path() . '/files'), str_replace('\\', '_', $class));
// HTTP auth settings (:) for the simpletest browser
// when sending requests to the test site.
$this->httpauth_method = variable_get('simpletest_httpauth_method', CURLAUTH_BASIC);
$username = variable_get('simpletest_httpauth_username', NULL);
$password = variable_get('simpletest_httpauth_password', NULL);
if ($username && $password) {
$this->httpauth_credentials = $username . ':' . $password;
}
set_error_handler(array($this, 'errorHandler'));
// Iterate through all the methods in this class, unless a specific list of
// methods to run was passed.
$class_methods = get_class_methods($class);
if ($methods) {
$class_methods = array_intersect($class_methods, $methods);
}
foreach ($class_methods as $method) {
// If the current method starts with "test", run it - it's a test.
if (strtolower(substr($method, 0, 4)) == 'test') {
// Insert a fail record. This will be deleted on completion to ensure
// that testing completed.
$method_info = new ReflectionMethod($class, $method);
$caller = array(
'file' => $method_info->getFileName(),
'line' => $method_info->getStartLine(),
'function' => $class . '->' . $method . '()',
);
$completion_check_id = DrupalTestCase::insertAssert($this->testId, $class, FALSE, t('The test did not complete due to a fatal error.'), 'Completion check', $caller);
$this->setUp();
if ($this->setup) {
try {
$this->$method();
// Finish up.
}
catch (Exception $e) {
$this->exceptionHandler($e);
}
$this->tearDown();
}
else {
$this->fail(t("The test cannot be executed because it has not been set up properly."));
}
// Remove the completion check record.
DrupalTestCase::deleteAssert($completion_check_id);
}
}
// Clear out the error messages and restore error handler.
drupal_get_messages();
restore_error_handler();
}
/**
* Handle errors during test runs.
*
* Because this is registered in set_error_handler(), it has to be public.
* @see set_error_handler
*/
public function errorHandler($severity, $message, $file = NULL, $line = NULL) {
if ($severity & error_reporting()) {
$error_map = array(
E_STRICT => 'Run-time notice',
E_WARNING => 'Warning',
E_NOTICE => 'Notice',
E_CORE_ERROR => 'Core error',
E_CORE_WARNING => 'Core warning',
E_USER_ERROR => 'User error',
E_USER_WARNING => 'User warning',
E_USER_NOTICE => 'User notice',
E_RECOVERABLE_ERROR => 'Recoverable error',
);
// PHP 5.3 adds new error logging constants. Add these conditionally for
// backwards compatibility with PHP 5.2.
if (defined('E_DEPRECATED')) {
$error_map += array(
E_DEPRECATED => 'Deprecated',
E_USER_DEPRECATED => 'User deprecated',
);
}
$backtrace = debug_backtrace();
$this->error($message, $error_map[$severity], _drupal_get_last_caller($backtrace));
}
return TRUE;
}
/**
* Handle exceptions.
*
* @see set_exception_handler
*/
protected function exceptionHandler($exception) {
$backtrace = $exception->getTrace();
// Push on top of the backtrace the call that generated the exception.
array_unshift($backtrace, array(
'line' => $exception->getLine(),
'file' => $exception->getFile(),
));
require_once DRUPAL_ROOT . '/includes/errors.inc';
// The exception message is run through check_plain() by _drupal_decode_exception().
$this->error(t('%type: !message in %function (line %line of %file).', _drupal_decode_exception($exception)), 'Uncaught exception', _drupal_get_last_caller($backtrace));
}
/**
* Generates a random string of ASCII characters of codes 32 to 126.
*
* The generated string includes alpha-numeric characters and common
* miscellaneous characters. Use this method when testing general input
* where the content is not restricted.
*
* Do not use this method when special characters are not possible (e.g., in
* machine or file names that have already been validated); instead,
* use DrupalWebTestCase::randomName().
*
* @param $length
* Length of random string to generate.
*
* @return
* Randomly generated string.
*
* @see DrupalWebTestCase::randomName()
*/
public static function randomString($length = 8) {
$str = '';
for ($i = 0; $i < $length; $i++) {
$str .= chr(mt_rand(32, 126));
}
return $str;
}
/**
* Generates a random string containing letters and numbers.
*
* The string will always start with a letter. The letters may be upper or
* lower case. This method is better for restricted inputs that do not
* accept certain characters. For example, when testing input fields that
* require machine readable values (i.e. without spaces and non-standard
* characters) this method is best.
*
* Do not use this method when testing unvalidated user input. Instead, use
* DrupalWebTestCase::randomString().
*
* @param $length
* Length of random string to generate.
*
* @return
* Randomly generated string.
*
* @see DrupalWebTestCase::randomString()
*/
public static function randomName($length = 8) {
$values = array_merge(range(65, 90), range(97, 122), range(48, 57));
$max = count($values) - 1;
$str = chr(mt_rand(97, 122));
for ($i = 1; $i < $length; $i++) {
$str .= chr($values[mt_rand(0, $max)]);
}
return $str;
}
/**
* Converts a list of possible parameters into a stack of permutations.
*
* Takes a list of parameters containing possible values, and converts all of
* them into a list of items containing every possible permutation.
*
* Example:
* @code
* $parameters = array(
* 'one' => array(0, 1),
* 'two' => array(2, 3),
* );
* $permutations = DrupalTestCase::generatePermutations($parameters)
* // Result:
* $permutations == array(
* array('one' => 0, 'two' => 2),
* array('one' => 1, 'two' => 2),
* array('one' => 0, 'two' => 3),
* array('one' => 1, 'two' => 3),
* )
* @endcode
*
* @param $parameters
* An associative array of parameters, keyed by parameter name, and whose
* values are arrays of parameter values.
*
* @return
* A list of permutations, which is an array of arrays. Each inner array
* contains the full list of parameters that have been passed, but with a
* single value only.
*/
public static function generatePermutations($parameters) {
$all_permutations = array(array());
foreach ($parameters as $parameter => $values) {
$new_permutations = array();
// Iterate over all values of the parameter.
foreach ($values as $value) {
// Iterate over all existing permutations.
foreach ($all_permutations as $permutation) {
// Add the new parameter value to existing permutations.
$new_permutations[] = $permutation + array($parameter => $value);
}
}
// Replace the old permutations with the new permutations.
$all_permutations = $new_permutations;
}
return $all_permutations;
}
}
/**
* Test case for Drupal unit tests.
*
* These tests can not access the database nor files. Calling any Drupal
* function that needs the database will throw exceptions. These include
* watchdog(), module_implements(), module_invoke_all() etc.
*/
class DrupalUnitTestCase extends DrupalTestCase {
/**
* Constructor for DrupalUnitTestCase.
*/
function __construct($test_id = NULL) {
parent::__construct($test_id);
$this->skipClasses[__CLASS__] = TRUE;
}
/**
* Sets up unit test environment.
*
* Unlike DrupalWebTestCase::setUp(), DrupalUnitTestCase::setUp() does not
* install modules because tests are performed without accessing the database.
* Any required files must be explicitly included by the child class setUp()
* method.
*/
protected function setUp() {
global $conf, $language;
// Store necessary current values before switching to the test environment.
$this->originalFileDirectory = variable_get('file_public_path', conf_path() . '/files');
$this->verboseDirectoryUrl = file_create_url($this->originalFileDirectory . '/simpletest/verbose');
// Set up English language.
$this->originalLanguage = $language;
$this->originalLanguageDefault = variable_get('language_default');
unset($conf['language_default']);
$language = language_default();
// Reset all statics so that test is performed with a clean environment.
drupal_static_reset();
// Generate temporary prefixed database to ensure that tests have a clean starting point.
$this->databasePrefix = Database::getConnection()->prefixTables('{simpletest' . mt_rand(1000, 1000000) . '}');
// Create test directory.
$public_files_directory = $this->originalFileDirectory . '/simpletest/' . substr($this->databasePrefix, 10);
file_prepare_directory($public_files_directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
$conf['file_public_path'] = $public_files_directory;
// Clone the current connection and replace the current prefix.
$connection_info = Database::getConnectionInfo('default');
Database::renameConnection('default', 'simpletest_original_default');
foreach ($connection_info as $target => $value) {
$connection_info[$target]['prefix'] = array(
'default' => $value['prefix']['default'] . $this->databasePrefix,
);
}
Database::addConnectionInfo('default', 'default', $connection_info['default']);
// Set user agent to be consistent with web test case.
$_SERVER['HTTP_USER_AGENT'] = $this->databasePrefix;
// If locale is enabled then t() will try to access the database and
// subsequently will fail as the database is not accessible.
$module_list = module_list();
if (isset($module_list['locale'])) {
// Transform the list into the format expected as input to module_list().
foreach ($module_list as &$module) {
$module = array('filename' => drupal_get_filename('module', $module));
}
$this->originalModuleList = $module_list;
unset($module_list['locale']);
module_list(TRUE, FALSE, FALSE, $module_list);
}
$this->setup = TRUE;
}
protected function tearDown() {
global $conf, $language;
// Get back to the original connection.
Database::removeConnection('default');
Database::renameConnection('simpletest_original_default', 'default');
$conf['file_public_path'] = $this->originalFileDirectory;
// Restore modules if necessary.
if (isset($this->originalModuleList)) {
module_list(TRUE, FALSE, FALSE, $this->originalModuleList);
}
// Reset language.
$language = $this->originalLanguage;
if ($this->originalLanguageDefault) {
$GLOBALS['conf']['language_default'] = $this->originalLanguageDefault;
}
}
}
/**
* Test case for typical Drupal tests.
*/
class DrupalWebTestCase extends DrupalTestCase {
/**
* The profile to install as a basis for testing.
*
* @var string
*/
protected $profile = 'standard';
/**
* The URL currently loaded in the internal browser.
*
* @var string
*/
protected $url;
/**
* The handle of the current cURL connection.
*
* @var resource
*/
protected $curlHandle;
/**
* The headers of the page currently loaded in the internal browser.
*
* @var Array
*/
protected $headers;
/**
* The content of the page currently loaded in the internal browser.
*
* @var string
*/
protected $content;
/**
* The content of the page currently loaded in the internal browser (plain text version).
*
* @var string
*/
protected $plainTextContent;
/**
* The value of the Drupal.settings JavaScript variable for the page currently loaded in the internal browser.
*
* @var Array
*/
protected $drupalSettings;
/**
* The parsed version of the page.
*
* @var SimpleXMLElement
*/
protected $elements = NULL;
/**
* The current user logged in using the internal browser.
*
* @var bool
*/
protected $loggedInUser = FALSE;
/**
* The current cookie file used by cURL.
*
* We do not reuse the cookies in further runs, so we do not need a file
* but we still need cookie handling, so we set the jar to NULL.
*/
protected $cookieFile = NULL;
/**
* The cookies of the page currently loaded in the internal browser.
*
* @var array
*/
protected $cookies = array();
/**
* Additional cURL options.
*
* DrupalWebTestCase itself never sets this but always obeys what is set.
*/
protected $additionalCurlOptions = array();
/**
* The original user, before it was changed to a clean uid = 1 for testing purposes.
*
* @var object
*/
protected $originalUser = NULL;
/**
* The original shutdown handlers array, before it was cleaned for testing purposes.
*
* @var array
*/
protected $originalShutdownCallbacks = array();
/**
* HTTP authentication method
*/
protected $httpauth_method = CURLAUTH_BASIC;
/**
* HTTP authentication credentials (:).
*/
protected $httpauth_credentials = NULL;
/**
* The current session name, if available.
*/
protected $session_name = NULL;
/**
* The current session ID, if available.
*/
protected $session_id = NULL;
/**
* Whether the files were copied to the test files directory.
*/
protected $generatedTestFiles = FALSE;
/**
* The number of redirects followed during the handling of a request.
*/
protected $redirect_count;
/**
* The original language URL.
*/
protected $originalLanguageUrl;
/**
* The original active installation profile.
*/
protected $originalProfile;
/**
* The original clean_url variable value.
*/
protected $originalCleanUrl;
/**
* The public files directory created for testing purposes.
*/
protected $public_files_directory;
/**
* The private files directory created for testing purposes.
*/
protected $private_files_directory;
/**
* The temporary files directory created for testing purposes.
*/
protected $temp_files_directory;
/**
* Constructor for DrupalWebTestCase.
*/
function __construct($test_id = NULL) {
parent::__construct($test_id);
$this->skipClasses[__CLASS__] = TRUE;
}
/**
* Get a node from the database based on its title.
*
* @param $title
* A node title, usually generated by $this->randomName().
* @param $reset
* (optional) Whether to reset the internal node_load() cache.
*
* @return
* A node object matching $title.
*/
function drupalGetNodeByTitle($title, $reset = FALSE) {
$nodes = node_load_multiple(array(), array('title' => $title), $reset);
// Load the first node returned from the database.
$returned_node = reset($nodes);
return $returned_node;
}
/**
* Creates a node based on default settings.
*
* @param $settings
* An associative array of settings to change from the defaults, keys are
* node properties, for example 'title' => 'Hello, world!'.
* @return
* Created node object.
*/
protected function drupalCreateNode($settings = array()) {
// Populate defaults array.
$settings += array(
'title' => $this->randomName(8),
'comment' => 2,
'changed' => REQUEST_TIME,
'moderate' => 0,
'promote' => 0,
'revision' => 1,
'log' => '',
'status' => 1,
'sticky' => 0,
'type' => 'page',
'revisions' => NULL,
'language' => LANGUAGE_NONE,
);
// Add the body after the language is defined so that it may be set
// properly.
$settings += array(
'body' => array($settings['language'] => array(array())),
);
// Use the original node's created time for existing nodes.
if (isset($settings['created']) && !isset($settings['date'])) {
$settings['date'] = format_date($settings['created'], 'custom', 'Y-m-d H:i:s O');
}
// If the node's user uid is not specified manually, use the currently
// logged in user if available, or else the user running the test.
if (!isset($settings['uid'])) {
if ($this->loggedInUser) {
$settings['uid'] = $this->loggedInUser->uid;
}
else {
global $user;
$settings['uid'] = $user->uid;
}
}
// Merge body field value and format separately.
$body = array(
'value' => $this->randomName(32),
'format' => filter_default_format(),
);
$settings['body'][$settings['language']][0] += $body;
$node = (object) $settings;
node_save($node);
// Small hack to link revisions to our test user.
db_update('node_revision')
->fields(array('uid' => $node->uid))
->condition('vid', $node->vid)
->execute();
return $node;
}
/**
* Creates a custom content type based on default settings.
*
* @param $settings
* An array of settings to change from the defaults.
* Example: 'type' => 'foo'.
* @return
* Created content type.
*/
protected function drupalCreateContentType($settings = array()) {
// Find a non-existent random type name.
do {
$name = strtolower($this->randomName(8));
} while (node_type_get_type($name));
// Populate defaults array.
$defaults = array(
'type' => $name,
'name' => $name,
'base' => 'node_content',
'description' => '',
'help' => '',
'title_label' => 'Title',
'has_title' => 1,
);
// Imposed values for a custom type.
$forced = array(
'orig_type' => '',
'old_type' => '',
'module' => 'node',
'custom' => 1,
'modified' => 1,
'locked' => 0,
);
$type = $forced + $settings + $defaults;
$type = (object) $type;
$saved_type = node_type_save($type);
node_types_rebuild();
menu_rebuild();
node_add_body_field($type);
$this->assertEqual($saved_type, SAVED_NEW, t('Created content type %type.', array('%type' => $type->type)));
// Reset permissions so that permissions for this content type are available.
$this->checkPermissions(array(), TRUE);
return $type;
}
/**
* Get a list files that can be used in tests.
*
* @param $type
* File type, possible values: 'binary', 'html', 'image', 'javascript', 'php', 'sql', 'text'.
* @param $size
* File size in bytes to match. Please check the tests/files folder.
* @return
* List of files that match filter.
*/
protected function drupalGetTestFiles($type, $size = NULL) {
if (empty($this->generatedTestFiles)) {
// Generate binary test files.
$lines = array(64, 1024);
$count = 0;
foreach ($lines as $line) {
simpletest_generate_file('binary-' . $count++, 64, $line, 'binary');
}
// Generate text test files.
$lines = array(16, 256, 1024, 2048, 20480);
$count = 0;
foreach ($lines as $line) {
simpletest_generate_file('text-' . $count++, 64, $line, 'text');
}
// Copy other test files from simpletest.
$original = drupal_get_path('module', 'simpletest') . '/files';
$files = file_scan_directory($original, '/(html|image|javascript|php|sql)-.*/');
foreach ($files as $file) {
file_unmanaged_copy($file->uri, variable_get('file_public_path', conf_path() . '/files'));
}
$this->generatedTestFiles = TRUE;
}
$files = array();
// Make sure type is valid.
if (in_array($type, array('binary', 'html', 'image', 'javascript', 'php', 'sql', 'text'))) {
$files = file_scan_directory('public://', '/' . $type . '\-.*/');
// If size is set then remove any files that are not of that size.
if ($size !== NULL) {
foreach ($files as $file) {
$stats = stat($file->uri);
if ($stats['size'] != $size) {
unset($files[$file->uri]);
}
}
}
}
usort($files, array($this, 'drupalCompareFiles'));
return $files;
}
/**
* Compare two files based on size and file name.
*/
protected function drupalCompareFiles($file1, $file2) {
$compare_size = filesize($file1->uri) - filesize($file2->uri);
if ($compare_size) {
// Sort by file size.
return $compare_size;
}
else {
// The files were the same size, so sort alphabetically.
return strnatcmp($file1->name, $file2->name);
}
}
/**
* Create a user with a given set of permissions.
*
* @param array $permissions
* Array of permission names to assign to user. Note that the user always
* has the default permissions derived from the "authenticated users" role.
*
* @return object|false
* A fully loaded user object with pass_raw property, or FALSE if account
* creation fails.
*/
protected function drupalCreateUser(array $permissions = array()) {
// Create a role with the given permission set, if any.
$rid = FALSE;
if ($permissions) {
$rid = $this->drupalCreateRole($permissions);
if (!$rid) {
return FALSE;
}
}
// Create a user assigned to that role.
$edit = array();
$edit['name'] = $this->randomName();
$edit['mail'] = $edit['name'] . '@example.com';
$edit['pass'] = user_password();
$edit['status'] = 1;
if ($rid) {
$edit['roles'] = array($rid => $rid);
}
$account = user_save(drupal_anonymous_user(), $edit);
$this->assertTrue(!empty($account->uid), t('User created with name %name and pass %pass', array('%name' => $edit['name'], '%pass' => $edit['pass'])), t('User login'));
if (empty($account->uid)) {
return FALSE;
}
// Add the raw password so that we can log in as this user.
$account->pass_raw = $edit['pass'];
return $account;
}
/**
* Creates a role with specified permissions.
*
* @param $permissions
* Array of permission names to assign to role.
* @param $name
* (optional) String for the name of the role. Defaults to a random string.
* @return
* Role ID of newly created role, or FALSE if role creation failed.
*/
protected function drupalCreateRole(array $permissions, $name = NULL) {
// Generate random name if it was not passed.
if (!$name) {
$name = $this->randomName();
}
// Check the all the permissions strings are valid.
if (!$this->checkPermissions($permissions)) {
return FALSE;
}
// Create new role.
$role = new stdClass();
$role->name = $name;
user_role_save($role);
user_role_grant_permissions($role->rid, $permissions);
$this->assertTrue(isset($role->rid), t('Created role of name: @name, id: @rid', array('@name' => $name, '@rid' => (isset($role->rid) ? $role->rid : t('-n/a-')))), t('Role'));
if ($role && !empty($role->rid)) {
$count = db_query('SELECT COUNT(*) FROM {role_permission} WHERE rid = :rid', array(':rid' => $role->rid))->fetchField();
$this->assertTrue($count == count($permissions), t('Created permissions: @perms', array('@perms' => implode(', ', $permissions))), t('Role'));
return $role->rid;
}
else {
return FALSE;
}
}
/**
* Check to make sure that the array of permissions are valid.
*
* @param $permissions
* Permissions to check.
* @param $reset
* Reset cached available permissions.
* @return
* TRUE or FALSE depending on whether the permissions are valid.
*/
protected function checkPermissions(array $permissions, $reset = FALSE) {
$available = &drupal_static(__FUNCTION__);
if (!isset($available) || $reset) {
$available = array_keys(module_invoke_all('permission'));
}
$valid = TRUE;
foreach ($permissions as $permission) {
if (!in_array($permission, $available)) {
$this->fail(t('Invalid permission %permission.', array('%permission' => $permission)), t('Role'));
$valid = FALSE;
}
}
return $valid;
}
/**
* Log in a user with the internal browser.
*
* If a user is already logged in, then the current user is logged out before
* logging in the specified user.
*
* Please note that neither the global $user nor the passed-in user object is
* populated with data of the logged in user. If you need full access to the
* user object after logging in, it must be updated manually. If you also need
* access to the plain-text password of the user (set by drupalCreateUser()),
* e.g. to log in the same user again, then it must be re-assigned manually.
* For example:
* @code
* // Create a user.
* $account = $this->drupalCreateUser(array());
* $this->drupalLogin($account);
* // Load real user object.
* $pass_raw = $account->pass_raw;
* $account = user_load($account->uid);
* $account->pass_raw = $pass_raw;
* @endcode
*
* @param $account
* User object representing the user to log in.
*
* @see drupalCreateUser()
*/
protected function drupalLogin(stdClass $account) {
if ($this->loggedInUser) {
$this->drupalLogout();
}
$edit = array(
'name' => $account->name,
'pass' => $account->pass_raw
);
$this->drupalPost('user', $edit, t('Log in'));
// If a "log out" link appears on the page, it is almost certainly because
// the login was successful.
$pass = $this->assertLink(t('Log out'), 0, t('User %name successfully logged in.', array('%name' => $account->name)), t('User login'));
if ($pass) {
$this->loggedInUser = $account;
}
}
/**
* Generate a token for the currently logged in user.
*/
protected function drupalGetToken($value = '') {
$private_key = drupal_get_private_key();
return drupal_hmac_base64($value, $this->session_id . $private_key);
}
/*
* Logs a user out of the internal browser, then check the login page to confirm logout.
*/
protected function drupalLogout() {
// Make a request to the logout page, and redirect to the user page, the
// idea being if you were properly logged out you should be seeing a login
// screen.
$this->drupalGet('user/logout');
$this->drupalGet('user');
$pass = $this->assertField('name', t('Username field found.'), t('Logout'));
$pass = $pass && $this->assertField('pass', t('Password field found.'), t('Logout'));
if ($pass) {
$this->loggedInUser = FALSE;
}
}
/**
* Generates a database prefix for running tests.
*
* The generated database table prefix is used for the Drupal installation
* being performed for the test. It is also used as user agent HTTP header
* value by the cURL-based browser of DrupalWebTestCase, which is sent
* to the Drupal installation of the test. During early Drupal bootstrap, the
* user agent HTTP header is parsed, and if it matches, all database queries
* use the database table prefix that has been generated here.
*
* @see DrupalWebTestCase::curlInitialize()
* @see drupal_valid_test_ua()
* @see DrupalWebTestCase::setUp()
*/
protected function prepareDatabasePrefix() {
$this->databasePrefix = 'simpletest' . mt_rand(1000, 1000000);
// As soon as the database prefix is set, the test might start to execute.
// All assertions as well as the SimpleTest batch operations are associated
// with the testId, so the database prefix has to be associated with it.
db_update('simpletest_test_id')
->fields(array('last_prefix' => $this->databasePrefix))
->condition('test_id', $this->testId)
->execute();
}
/**
* Changes the database connection to the prefixed one.
*
* @see DrupalWebTestCase::setUp()
*/
protected function changeDatabasePrefix() {
if (empty($this->databasePrefix)) {
$this->prepareDatabasePrefix();
// If $this->prepareDatabasePrefix() failed to work, return without
// setting $this->setupDatabasePrefix to TRUE, so setUp() methods will
// know to bail out.
if (empty($this->databasePrefix)) {
return;
}
}
// Clone the current connection and replace the current prefix.
$connection_info = Database::getConnectionInfo('default');
Database::renameConnection('default', 'simpletest_original_default');
foreach ($connection_info as $target => $value) {
$connection_info[$target]['prefix'] = array(
'default' => $value['prefix']['default'] . $this->databasePrefix,
);
}
Database::addConnectionInfo('default', 'default', $connection_info['default']);
// Indicate the database prefix was set up correctly.
$this->setupDatabasePrefix = TRUE;
}
/**
* Prepares the current environment for running the test.
*
* Backups various current environment variables and resets them, so they do
* not interfere with the Drupal site installation in which tests are executed
* and can be restored in tearDown().
*
* Also sets up new resources for the testing environment, such as the public
* filesystem and configuration directories.
*
* @see DrupalWebTestCase::setUp()
* @see DrupalWebTestCase::tearDown()
*/
protected function prepareEnvironment() {
global $user, $language, $language_url, $conf, $theme, $theme_key, $theme_path;
// Store necessary current values before switching to prefixed database.
$this->originalLanguage = $language;
$this->originalLanguageUrl = $language_url;
$this->originalLanguageDefault = variable_get('language_default');
$this->originalFileDirectory = variable_get('file_public_path', conf_path() . '/files');
$this->verboseDirectoryUrl = file_create_url($this->originalFileDirectory . '/simpletest/verbose');
$this->originalProfile = drupal_get_profile();
$this->originalCleanUrl = variable_get('clean_url', 0);
$this->originalUser = $user;
// Set to English to prevent exceptions from utf8_truncate() from t()
// during install if the current language is not 'en'.
// The following array/object conversion is copied from language_default().
$language_url = $language = (object) array('language' => 'en', 'name' => 'English', 'native' => 'English', 'direction' => 0, 'enabled' => 1, 'plurals' => 0, 'formula' => '', 'domain' => '', 'prefix' => '', 'weight' => 0, 'javascript' => '');
// Reset the theme globals.
$this->originalTheme = $theme;
$this->originalThemeKey = $theme_key;
$this->originalThemePath = $theme_path;
$theme = $theme_key = $theme_path = NULL;
// Save and clean the shutdown callbacks array because it is static cached
// and will be changed by the test run. Otherwise it will contain callbacks
// from both environments and the testing environment will try to call the
// handlers defined by the original one.
$callbacks = &drupal_register_shutdown_function();
$this->originalShutdownCallbacks = $callbacks;
$callbacks = array();
// Create test directory ahead of installation so fatal errors and debug
// information can be logged during installation process.
// Use temporary files directory with the same prefix as the database.
$this->public_files_directory = $this->originalFileDirectory . '/simpletest/' . substr($this->databasePrefix, 10);
$this->private_files_directory = $this->public_files_directory . '/private';
$this->temp_files_directory = $this->private_files_directory . '/temp';
// Create the directories
file_prepare_directory($this->public_files_directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
file_prepare_directory($this->private_files_directory, FILE_CREATE_DIRECTORY);
file_prepare_directory($this->temp_files_directory, FILE_CREATE_DIRECTORY);
$this->generatedTestFiles = FALSE;
// Log fatal errors.
ini_set('log_errors', 1);
ini_set('error_log', $this->public_files_directory . '/error.log');
// Set the test information for use in other parts of Drupal.
$test_info = &$GLOBALS['drupal_test_info'];
$test_info['test_run_id'] = $this->databasePrefix;
$test_info['in_child_site'] = FALSE;
// Indicate the environment was set up correctly.
$this->setupEnvironment = TRUE;
}
/**
* Copies the cached tables and files for a cached installation setup.
*
* @param string $cache_key_prefix
* (optional) Additional prefix for the cache key.
*
* @return bool
* TRUE when the cache was usable and loaded, FALSE when cache was not
* available.
*
* @see DrupalWebTestCase::setUp()
*/
protected function loadSetupCache($cache_key_prefix = '') {
$cache_key = $this->getSetupCacheKey($cache_key_prefix);
$cache_file = $this->originalFileDirectory . '/simpletest/' . $cache_key . '/simpletest-cache-setup';
if (file_exists($cache_file)) {
return $this->copySetupCache($cache_key, substr($this->databasePrefix, 10));
}
return FALSE;
}
/**
* Returns the cache key used for the setup caching.
*
* @param string $cache_key_prefix
* (optional) Additional prefix for the cache key.
*
* @return string
* The cache key to use, by default only based on the profile used by the
* test.
*/
protected function getSetupCacheKey($cache_key_prefix = '') {
// The cache key needs to start with a numeric character, so that the cached
// installation gets cleaned up properly.
$cache_key_prefix = hash('crc32b', $cache_key_prefix . $this->profile);
return '1c' . $cache_key_prefix;
}
/**
* Store the installation setup to a cache.
*
* @param string $cache_key_prefix
* (optional) Additional prefix for the cache key.
*
* @return bool
* TRUE if the installation was stored in the cache, FALSE otherwise.
*/
protected function storeSetupCache($cache_key_prefix = '') {
$cache_key = $this->getSetupCacheKey($cache_key_prefix);
$lock_key = 'simpletest_store_cache_' . $cache_key . '_' . $this->testId;
// All concurrent tests share the same test id. Therefore it is possible to
// use the lock to ensure that only one process will store the cache. This
// is important as else DB tables created by one process could be deleted
// by another as the cache copying is idempotent.
if (! lock_acquire($lock_key)) {
return FALSE;
}
// Try to copy the installation to the setup cache - now that we have a
// lock to do so.
if (!$this->copySetupCache(substr($this->databasePrefix, 10), $cache_key)) {
// It is non-fatal if the cache cannot be copied as the next test run
// will try it again.
$this->assert('debug', t('Storing cache with key @key failed', array('@key' => $cache_key)), 'storeSetupCache');
lock_release($lock_key);
return FALSE;
}
// Inform others that this cache is usable now.
$cache_file = $this->originalFileDirectory . '/simpletest/' . $cache_key . '/simpletest-cache-setup';
file_put_contents($cache_file, time());
lock_release($lock_key);
return TRUE;
}
/**
* Copy the setup cache from/to another table and files directory.
*
* @param string $from
* The prefix_id / cache_key from where to copy.
* @param string $to
* The prefix_id / cache_key to where to copy.
*
* @return bool
* TRUE if the setup cache was copied to the current installation, FALSE
* otherwise.
*/
protected function copySetupCache($from, $to) {
$from_prefix = 'simpletest' . $from;
$to_prefix = 'simpletest' . $to;
try {
$tables = db_query("SHOW TABLES LIKE :prefix", array(':prefix' => db_like($from_prefix) . '%' ))->fetchCol();
if (count($tables) == 0) {
return FALSE;
}
foreach ($tables as $from_table) {
$table = substr($from_table, strlen($from_prefix));
$to_table = $to_prefix . $table;
// Remove the table in case the copying process was interrupted.
db_query('DROP TABLE IF EXISTS ' . $to_table);
db_query('CREATE TABLE ' . $to_table . ' LIKE ' . $from_table);
db_query('ALTER TABLE ' . $to_table . ' DISABLE KEYS');
db_query('INSERT ' . $to_table . ' SELECT * FROM ' . $from_table);
db_query('ALTER TABLE ' . $to_table . ' ENABLE KEYS');
}
}
catch (Exception $e) {
return FALSE;
}
$from_dir = $this->originalFileDirectory . '/simpletest/' . $from;
$to_dir = $this->originalFileDirectory . '/simpletest/' . $to;
$this->recursiveDirectoryCopy($from_dir, $to_dir);
return TRUE;
}
/**
* Recursively copy one directory to another.
*
* @param $src
* The source directory.
* @param $dest
* The destination directory.
*/
protected function recursiveDirectoryCopy($src, $dst) {
$dir = opendir($src);
if (!file_exists($dst)){
mkdir($dst);
}
while (($file = readdir($dir)) !== FALSE) {
if ($file != '.' && $file != '..') {
if (is_dir($src . '/' . $file)) {
$this->recursiveDirectoryCopy($src . '/' . $file, $dst . '/' . $file);
}
else {
copy($src . '/' . $file, $dst . '/' . $file);
}
}
}
closedir($dir);
}
/**
* Sets up a Drupal site for running functional and integration tests.
*
* Generates a random database prefix and installs Drupal with the specified
* installation profile in DrupalWebTestCase::$profile into the
* prefixed database. Afterwards, installs any additional modules specified by
* the test.
*
* After installation all caches are flushed and several configuration values
* are reset to the values of the parent site executing the test, since the
* default values may be incompatible with the environment in which tests are
* being executed.
*
* @param ...
* List of modules to enable for the duration of the test. This can be
* either a single array or a variable number of string arguments.
*
* @see DrupalWebTestCase::prepareDatabasePrefix()
* @see DrupalWebTestCase::changeDatabasePrefix()
* @see DrupalWebTestCase::prepareEnvironment()
*/
protected function setUp() {
global $user, $language, $language_url, $conf;
// Create the database prefix for this test.
$this->prepareDatabasePrefix();
// Prepare the environment for running tests.
$this->prepareEnvironment();
if (!$this->setupEnvironment) {
return FALSE;
}
// Reset all statics and variables to perform tests in a clean environment.
$conf = array();
drupal_static_reset();
// Change the database prefix.
// All static variables need to be reset before the database prefix is
// changed, since DrupalCacheArray implementations attempt to
// write back to persistent caches when they are destructed.
$this->changeDatabasePrefix();
if (!$this->setupDatabasePrefix) {
return FALSE;
}
// Preset the 'install_profile' system variable, so the first call into
// system_rebuild_module_data() (in drupal_install_system()) will register
// the test's profile as a module. Without this, the installation profile of
// the parent site (executing the test) is registered, and the test
// profile's hook_install() and other hook implementations are never invoked.
$conf['install_profile'] = $this->profile;
$has_installation_cache = FALSE;
$has_modules_cache = FALSE;
if ($this->useSetupModulesCache) {
$modules = func_get_args();
// Modules can be either one parameter or multiple.
if (isset($modules[0]) && is_array($modules[0])) {
$modules = $modules[0];
}
$modules = array_unique($modules);
sort($modules);
$modules_cache_key_prefix = hash('crc32b', serialize($modules)) . '_';
$has_modules_cache = $this->loadSetupCache($modules_cache_key_prefix);
}
if (!$has_modules_cache && $this->useSetupInstallationCache) {
$has_installation_cache = $this->loadSetupCache();
}
if ($has_modules_cache || $has_installation_cache) {
// Reset path variables.
variable_set('file_public_path', $this->public_files_directory);
variable_set('file_private_path', $this->private_files_directory);
variable_set('file_temporary_path', $this->temp_files_directory);
$this->refreshVariables();
// Load all enabled modules
module_load_all();
$this->pass(t('Using cache: @cache (@key)', array(
'@cache' => $has_modules_cache ? t('Modules Cache') : t('Installation Cache'),
'@key' => $this->getSetupCacheKey($has_modules_cache ? $modules_cache_key_prefix : ''),
)));
}
else {
// Perform the actual Drupal installation.
include_once DRUPAL_ROOT . '/includes/install.inc';
drupal_install_system();
$this->preloadRegistry();
// Set path variables.
variable_set('file_public_path', $this->public_files_directory);
variable_set('file_private_path', $this->private_files_directory);
variable_set('file_temporary_path', $this->temp_files_directory);
// Set the 'simpletest_parent_profile' variable to add the parent profile's
// search path to the child site's search paths.
// @see drupal_system_listing()
// @todo This may need to be primed like 'install_profile' above.
variable_set('simpletest_parent_profile', $this->originalProfile);
// Include the testing profile.
variable_set('install_profile', $this->profile);
$profile_details = install_profile_info($this->profile, 'en');
// Install the modules specified by the testing profile.
module_enable($profile_details['dependencies'], FALSE);
if ($this->useSetupInstallationCache) {
$this->storeSetupCache();
}
}
if (!$has_modules_cache) {
// Install modules needed for this test. This could have been passed in as
// either a single array argument or a variable number of string arguments.
// @todo Remove this compatibility layer in Drupal 8, and only accept
// $modules as a single array argument.
$modules = func_get_args();
if (isset($modules[0]) && is_array($modules[0])) {
$modules = $modules[0];
}
if ($modules) {
$success = module_enable($modules, TRUE);
$this->assertTrue($success, t('Enabled modules: %modules', array('%modules' => implode(', ', $modules))));
}
// Run the profile tasks.
$install_profile_module_exists = db_query("SELECT 1 FROM {system} WHERE type = 'module' AND name = :name", array(
':name' => $this->profile,
))->fetchField();
if ($install_profile_module_exists) {
module_enable(array($this->profile), FALSE);
}
// Reset/rebuild all data structures after enabling the modules.
$this->resetAll();
// Run cron once in that environment, as install.php does at the end of
// the installation process.
drupal_cron_run();
if ($this->useSetupModulesCache) {
$this->storeSetupCache($modules_cache_key_prefix);
}
}
else {
// Reset/rebuild all data structures after enabling the modules.
$this->resetAll();
}
// Ensure that the session is not written to the new environment and replace
// the global $user session with uid 1 from the new test site.
drupal_save_session(FALSE);
// Login as uid 1.
$user = user_load(1);
// Restore necessary variables.
variable_set('install_task', 'done');
variable_set('clean_url', $this->originalCleanUrl);
variable_set('site_mail', 'simpletest@example.com');
variable_set('date_default_timezone', date_default_timezone_get());
// Set up English language.
unset($conf['language_default']);
$language_url = $language = language_default();
// Use the test mail class instead of the default mail handler class.
variable_set('mail_system', array('default-system' => 'TestingMailSystem'));
drupal_set_time_limit($this->timeLimit);
$this->setup = TRUE;
}
/**
* Preload the registry from the testing site.
*
* This method is called by DrupalWebTestCase::setUp(), and preloads the
* registry from the testing site to cut down on the time it takes to
* set up a clean environment for the current test run.
*/
protected function preloadRegistry() {
// Use two separate queries, each with their own connections: copy the
// {registry} and {registry_file} tables over from the parent installation
// to the child installation.
$original_connection = Database::getConnection('default', 'simpletest_original_default');
$test_connection = Database::getConnection();
foreach (array('registry', 'registry_file') as $table) {
// Find the records from the parent database.
$source_query = $original_connection
->select($table, array(), array('fetch' => PDO::FETCH_ASSOC))
->fields($table);
$dest_query = $test_connection->insert($table);
$first = TRUE;
foreach ($source_query->execute() as $row) {
if ($first) {
$dest_query->fields(array_keys($row));
$first = FALSE;
}
// Insert the records into the child database.
$dest_query->values($row);
}
$dest_query->execute();
}
}
/**
* Reset all data structures after having enabled new modules.
*
* This method is called by DrupalWebTestCase::setUp() after enabling
* the requested modules. It must be called again when additional modules
* are enabled later.
*/
protected function resetAll() {
// Reset all static variables.
drupal_static_reset();
// Reset the list of enabled modules.
module_list(TRUE);
// Reset cached schema for new database prefix. This must be done before
// drupal_flush_all_caches() so rebuilds can make use of the schema of
// modules enabled on the cURL side.
drupal_get_schema(NULL, TRUE);
// Perform rebuilds and flush remaining caches.
drupal_flush_all_caches();
// Reload global $conf array and permissions.
$this->refreshVariables();
$this->checkPermissions(array(), TRUE);
}
/**
* Refresh the in-memory set of variables. Useful after a page request is made
* that changes a variable in a different thread.
*
* In other words calling a settings page with $this->drupalPost() with a changed
* value would update a variable to reflect that change, but in the thread that
* made the call (thread running the test) the changed variable would not be
* picked up.
*
* This method clears the variables cache and loads a fresh copy from the database
* to ensure that the most up-to-date set of variables is loaded.
*/
protected function refreshVariables() {
global $conf;
cache_clear_all('variables', 'cache_bootstrap');
$conf = variable_initialize();
}
/**
* Delete created files and temporary files directory, delete the tables created by setUp(),
* and reset the database prefix.
*/
protected function tearDown() {
global $user, $language, $language_url, $theme, $theme_key, $theme_path;
// In case a fatal error occurred that was not in the test process read the
// log to pick up any fatal errors.
simpletest_log_read($this->testId, $this->databasePrefix, get_class($this), TRUE);
$emailCount = count(variable_get('drupal_test_email_collector', array()));
if ($emailCount) {
$message = format_plural($emailCount, '1 e-mail was sent during this test.', '@count e-mails were sent during this test.');
$this->pass($message, t('E-mail'));
}
// Delete temporary files directory.
file_unmanaged_delete_recursive($this->originalFileDirectory . '/simpletest/' . substr($this->databasePrefix, 10));
// Remove all prefixed tables.
$tables = db_find_tables_d8('%');
if (empty($tables)) {
$this->fail('Failed to find test tables to drop.');
}
foreach ($tables as $table) {
if (db_drop_table($table)) {
unset($tables[$table]);
}
}
if (!empty($tables)) {
$this->fail('Failed to drop all prefixed tables.');
}
// In PHP 8 some tests encounter problems when shutdown code tries to
// access the database connection after it's been explicitly closed, for
// example the destructor of DrupalCacheArray. We avoid this by not fully
// destroying the test database connection.
$close = \PHP_VERSION_ID < 80000;
// Get back to the original connection.
Database::removeConnection('default', $close);
Database::renameConnection('simpletest_original_default', 'default');
// Restore original shutdown callbacks array to prevent original
// environment of calling handlers from test run.
$callbacks = &drupal_register_shutdown_function();
$callbacks = $this->originalShutdownCallbacks;
// Return the user to the original one.
$user = $this->originalUser;
drupal_save_session(TRUE);
// Ensure that internal logged in variable and cURL options are reset.
$this->loggedInUser = FALSE;
$this->additionalCurlOptions = array();
// Reload module list and implementations to ensure that test module hooks
// aren't called after tests.
module_list(TRUE);
module_implements('', FALSE, TRUE);
// Reset the Field API.
field_cache_clear();
// Rebuild caches.
$this->refreshVariables();
// Reset public files directory.
$GLOBALS['conf']['file_public_path'] = $this->originalFileDirectory;
// Reset language.
$language = $this->originalLanguage;
$language_url = $this->originalLanguageUrl;
if ($this->originalLanguageDefault) {
$GLOBALS['conf']['language_default'] = $this->originalLanguageDefault;
}
// Reset theme.
$theme = $this->originalTheme;
$theme_key = $this->originalThemeKey;
$theme_path = $this->originalThemePath;
// Close the CURL handler and reset the cookies array so test classes
// containing multiple tests are not polluted.
$this->curlClose();
$this->cookies = array();
}
/**
* Initializes the cURL connection.
*
* If the simpletest_httpauth_credentials variable is set, this function will
* add HTTP authentication headers. This is necessary for testing sites that
* are protected by login credentials from public access.
* See the description of $curl_options for other options.
*/
protected function curlInitialize() {
global $base_url;
if (!isset($this->curlHandle)) {
$this->curlHandle = curl_init();
// Some versions/configurations of cURL break on a NULL cookie jar, so
// supply a real file.
if (empty($this->cookieFile)) {
$this->cookieFile = $this->public_files_directory . '/cookie.jar';
}
$curl_options = array(
CURLOPT_COOKIEJAR => $this->cookieFile,
CURLOPT_URL => $base_url,
CURLOPT_FOLLOWLOCATION => FALSE,
CURLOPT_RETURNTRANSFER => TRUE,
CURLOPT_SSL_VERIFYPEER => FALSE, // Required to make the tests run on HTTPS.
CURLOPT_SSL_VERIFYHOST => FALSE, // Required to make the tests run on HTTPS.
CURLOPT_HEADERFUNCTION => array(&$this, 'curlHeaderCallback'),
CURLOPT_USERAGENT => $this->databasePrefix,
);
if (isset($this->httpauth_credentials)) {
$curl_options[CURLOPT_HTTPAUTH] = $this->httpauth_method;
$curl_options[CURLOPT_USERPWD] = $this->httpauth_credentials;
}
// curl_setopt_array() returns FALSE if any of the specified options
// cannot be set, and stops processing any further options.
$result = curl_setopt_array($this->curlHandle, $this->additionalCurlOptions + $curl_options);
if (!$result) {
throw new Exception('One or more cURL options could not be set.');
}
// By default, the child session name should be the same as the parent.
$this->session_name = session_name();
}
// We set the user agent header on each request so as to use the current
// time and a new uniqid.
if (preg_match('/simpletest\d+/', $this->databasePrefix, $matches)) {
curl_setopt($this->curlHandle, CURLOPT_USERAGENT, drupal_generate_test_ua($matches[0]));
}
}
/**
* Initializes and executes a cURL request.
*
* @param $curl_options
* An associative array of cURL options to set, where the keys are constants
* defined by the cURL library. For a list of valid options, see
* http://www.php.net/manual/function.curl-setopt.php
* @param $redirect
* FALSE if this is an initial request, TRUE if this request is the result
* of a redirect.
*
* @return
* The content returned from the call to curl_exec().
*
* @see curlInitialize()
*/
protected function curlExec($curl_options, $redirect = FALSE) {
$this->curlInitialize();
if (!empty($curl_options[CURLOPT_URL])) {
// Forward XDebug activation if present.
if (isset($_COOKIE['XDEBUG_SESSION'])) {
$options = drupal_parse_url($curl_options[CURLOPT_URL]);
$options += array('query' => array());
$options['query'] += array('XDEBUG_SESSION_START' => $_COOKIE['XDEBUG_SESSION']);
$curl_options[CURLOPT_URL] = url($options['path'], $options);
}
// cURL incorrectly handles URLs with a fragment by including the
// fragment in the request to the server, causing some web servers
// to reject the request citing "400 - Bad Request". To prevent
// this, we strip the fragment from the request.
// TODO: Remove this for Drupal 8, since fixed in curl 7.20.0.
if (strpos($curl_options[CURLOPT_URL], '#')) {
$original_url = $curl_options[CURLOPT_URL];
$curl_options[CURLOPT_URL] = strtok($curl_options[CURLOPT_URL], '#');
}
}
$url = empty($curl_options[CURLOPT_URL]) ? curl_getinfo($this->curlHandle, CURLINFO_EFFECTIVE_URL) : $curl_options[CURLOPT_URL];
if (!empty($curl_options[CURLOPT_POST])) {
// This is a fix for the Curl library to prevent Expect: 100-continue
// headers in POST requests, that may cause unexpected HTTP response
// codes from some webservers (like lighttpd that returns a 417 error
// code). It is done by setting an empty "Expect" header field that is
// not overwritten by Curl.
$curl_options[CURLOPT_HTTPHEADER][] = 'Expect:';
}
curl_setopt_array($this->curlHandle, $this->additionalCurlOptions + $curl_options);
if (!$redirect) {
// Reset headers, the session ID and the redirect counter.
$this->session_id = NULL;
$this->headers = array();
$this->redirect_count = 0;
}
$content = curl_exec($this->curlHandle);
$status = curl_getinfo($this->curlHandle, CURLINFO_HTTP_CODE);
// cURL incorrectly handles URLs with fragments, so instead of
// letting cURL handle redirects we take of them ourselves to
// to prevent fragments being sent to the web server as part
// of the request.
// TODO: Remove this for Drupal 8, since fixed in curl 7.20.0.
if (in_array($status, array(300, 301, 302, 303, 305, 307)) && $this->redirect_count < variable_get('simpletest_maximum_redirects', 5)) {
if ($this->drupalGetHeader('location')) {
$this->redirect_count++;
$curl_options = array();
$curl_options[CURLOPT_URL] = $this->drupalGetHeader('location');
$curl_options[CURLOPT_HTTPGET] = TRUE;
return $this->curlExec($curl_options, TRUE);
}
}
$this->drupalSetContent($content, isset($original_url) ? $original_url : curl_getinfo($this->curlHandle, CURLINFO_EFFECTIVE_URL));
$message_vars = array(
'!method' => !empty($curl_options[CURLOPT_NOBODY]) ? 'HEAD' : (empty($curl_options[CURLOPT_POSTFIELDS]) ? 'GET' : 'POST'),
'@url' => isset($original_url) ? $original_url : $url,
'@status' => $status,
'!length' => format_size(strlen($this->drupalGetContent()))
);
$message = t('!method @url returned @status (!length).', $message_vars);
$this->assertTrue($this->drupalGetContent() !== FALSE, $message, t('Browser'));
return $this->drupalGetContent();
}
/**
* Reads headers and registers errors received from the tested site.
*
* @see _drupal_log_error().
*
* @param $curlHandler
* The cURL handler.
* @param $header
* An header.
*/
protected function curlHeaderCallback($curlHandler, $header) {
// Header fields can be extended over multiple lines by preceding each
// extra line with at least one SP or HT. They should be joined on receive.
// Details are in RFC2616 section 4.
if ($header[0] == ' ' || $header[0] == "\t") {
// Normalize whitespace between chucks.
$this->headers[] = array_pop($this->headers) . ' ' . trim($header);
}
else {
$this->headers[] = $header;
}
// Errors are being sent via X-Drupal-Assertion-* headers,
// generated by _drupal_log_error() in the exact form required
// by DrupalWebTestCase::error().
if (preg_match('/^X-Drupal-Assertion-[0-9]+: (.*)$/', $header, $matches)) {
// Call DrupalWebTestCase::error() with the parameters from the header.
call_user_func_array(array(&$this, 'error'), unserialize(urldecode($matches[1])));
}
// Save cookies.
if (preg_match('/^Set-Cookie: ([^=]+)=(.+)/', $header, $matches)) {
$name = $matches[1];
$parts = array_map('trim', explode(';', $matches[2]));
$value = array_shift($parts);
$this->cookies[$name] = array('value' => $value, 'secure' => in_array('secure', $parts));
if ($name == $this->session_name) {
if ($value != 'deleted') {
$this->session_id = $value;
}
else {
$this->session_id = NULL;
}
}
}
// This is required by cURL.
return strlen($header);
}
/**
* Close the cURL handler and unset the handler.
*/
protected function curlClose() {
if (isset($this->curlHandle)) {
curl_close($this->curlHandle);
unset($this->curlHandle);
}
}
/**
* Parse content returned from curlExec using DOM and SimpleXML.
*
* @return
* A SimpleXMLElement or FALSE on failure.
*/
protected function parse() {
if (!$this->elements) {
// DOM can load HTML soup. But, HTML soup can throw warnings, suppress
// them.
$htmlDom = new DOMDocument();
@$htmlDom->loadHTML($this->drupalGetContent());
if ($htmlDom) {
$this->pass(t('Valid HTML found on "@path"', array('@path' => $this->getUrl())), t('Browser'));
// It's much easier to work with simplexml than DOM, luckily enough
// we can just simply import our DOM tree.
$this->elements = simplexml_import_dom($htmlDom);
}
}
if (!$this->elements) {
$this->fail(t('Parsed page successfully.'), t('Browser'));
}
return $this->elements;
}
/**
* Retrieves a Drupal path or an absolute path.
*
* @param $path
* Drupal path or URL to load into internal browser
* @param $options
* Options to be forwarded to url().
* @param $headers
* An array containing additional HTTP request headers, each formatted as
* "name: value".
* @return
* The retrieved HTML string, also available as $this->drupalGetContent()
*/
protected function drupalGet($path, array $options = array(), array $headers = array()) {
$options['absolute'] = TRUE;
// We re-using a CURL connection here. If that connection still has certain
// options set, it might change the GET into a POST. Make sure we clear out
// previous options.
$out = $this->curlExec(array(CURLOPT_HTTPGET => TRUE, CURLOPT_URL => url($path, $options), CURLOPT_NOBODY => FALSE, CURLOPT_HTTPHEADER => $headers));
$this->refreshVariables(); // Ensure that any changes to variables in the other thread are picked up.
// Replace original page output with new output from redirected page(s).
if ($new = $this->checkForMetaRefresh()) {
$out = $new;
}
$this->verbose('GET request to: ' . $path .
'' . $command['data'] . '
');
// Suppress warnings thrown when duplicate HTML IDs are
// encountered. This probably means we are replacing an element
// with the same ID.
$newNode = @$dom->importNode($newDom->documentElement->firstChild->firstChild, TRUE);
$method = isset($command['method']) ? $command['method'] : $ajax_settings['method'];
// The "method" is a jQuery DOM manipulation function. Emulate
// each one using PHP's DOMNode API.
switch ($method) {
case 'replaceWith':
$wrapperNode->parentNode->replaceChild($newNode, $wrapperNode);
break;
case 'append':
$wrapperNode->appendChild($newNode);
break;
case 'prepend':
// If no firstChild, insertBefore() falls back to
// appendChild().
$wrapperNode->insertBefore($newNode, $wrapperNode->firstChild);
break;
case 'before':
$wrapperNode->parentNode->insertBefore($newNode, $wrapperNode);
break;
case 'after':
// If no nextSibling, insertBefore() falls back to
// appendChild().
$wrapperNode->parentNode->insertBefore($newNode, $wrapperNode->nextSibling);
break;
case 'html':
foreach ($wrapperNode->childNodes as $childNode) {
$wrapperNode->removeChild($childNode);
}
$wrapperNode->appendChild($newNode);
break;
}
}
break;
case 'updateBuildId':
$buildId = $xpath->query('//input[@name="form_build_id" and @value="' . $command['old'] . '"]')->item(0);
if ($buildId) {
$buildId->setAttribute('value', $command['new']);
}
break;
// @todo Add suitable implementations for these commands in order to
// have full test coverage of what ajax.js can do.
case 'remove':
break;
case 'changed':
break;
case 'css':
break;
case 'data':
break;
case 'restripe':
break;
case 'add_css':
break;
}
}
$content = $dom->saveHTML();
}
$this->drupalSetContent($content);
$this->drupalSetSettings($drupal_settings);
$verbose = 'AJAX POST request to: ' . $path;
$verbose .= '.*)/i', $refresh[0]['content'], $match)) {
return $this->drupalGet($this->getAbsoluteUrl(decode_entities($match['url'])));
}
}
}
return FALSE;
}
/**
* Retrieves only the headers for a Drupal path or an absolute path.
*
* @param $path
* Drupal path or URL to load into internal browser
* @param $options
* Options to be forwarded to url().
* @param $headers
* An array containing additional HTTP request headers, each formatted as
* "name: value".
* @return
* The retrieved headers, also available as $this->drupalGetContent()
*/
protected function drupalHead($path, array $options = array(), array $headers = array()) {
$options['absolute'] = TRUE;
$out = $this->curlExec(array(CURLOPT_NOBODY => TRUE, CURLOPT_URL => url($path, $options), CURLOPT_HTTPHEADER => $headers));
$this->refreshVariables(); // Ensure that any changes to variables in the other thread are picked up.
return $out;
}
/**
* Handle form input related to drupalPost(). Ensure that the specified fields
* exist and attempt to create POST data in the correct manner for the particular
* field type.
*
* @param $post
* Reference to array of post values.
* @param $edit
* Reference to array of edit values to be checked against the form.
* @param $submit
* Form submit button value.
* @param $form
* Array of form elements.
* @return
* Submit value matches a valid submit input in the form.
*/
protected function handleForm(&$post, &$edit, &$upload, $submit, $form) {
// Retrieve the form elements.
$elements = $form->xpath('.//input[not(@disabled)]|.//textarea[not(@disabled)]|.//select[not(@disabled)]');
$submit_matches = FALSE;
foreach ($elements as $element) {
// SimpleXML objects need string casting all the time.
$name = (string) $element['name'];
// This can either be the type of or