diff --git i/core/modules/contact/contact.admin.inc w/core/modules/contact/contact.admin.inc index f6835f9..08769bb 100644 --- i/core/modules/contact/contact.admin.inc +++ w/core/modules/contact/contact.admin.inc @@ -40,10 +40,12 @@ function contact_category_list() { } if (!$rows) { - $rows[] = array(array( - 'data' => t('No categories available.'), - 'colspan' => 5, - )); + $rows[] = array( + array( + 'data' => t('No categories available.'), + 'colspan' => 5, + ), + ); } $build['category_table'] = array( @@ -57,7 +59,7 @@ function contact_category_list() { /** * Form constructor for the category edit form. * - * @param $category + * @param Array $category * An array describing the category to be edited. May be empty for new * categories. Recognized array keys are: * - category: The name of the category. @@ -186,7 +188,7 @@ function contact_category_edit_form_submit($form, &$form_state) { /** * Form constructor for the contact category deletion form. * - * @param $contact + * @param Array $contact * Array describing the contact category to be deleted. See the documentation * of contact_category_edit_form() for the recognized keys. * diff --git i/core/modules/contact/contact.pages.inc w/core/modules/contact/contact.pages.inc index 92d73bc..d9c6a0a 100644 --- i/core/modules/contact/contact.pages.inc +++ w/core/modules/contact/contact.pages.inc @@ -81,7 +81,7 @@ function contact_site_form($form, &$form_state) { // Do not allow authenticated usrs to alter the name or e-mail values to // prevent the impersonation of other users. - if ($user->uid){ + if ($user->uid) { // Change form elements to values. $form['name']['#type'] = $form['mail']['#type'] = 'value'; @@ -182,7 +182,11 @@ function contact_site_form_submit($form, &$form_state) { } flood_register_event('contact', config('contact.settings')->get('flood.interval')); - watchdog('mail', '%sender-name (@sender-from) sent an e-mail regarding %category.', array('%sender-name' => $values['name'], '@sender-from' => $from, '%category' => $values['category']['category'])); + watchdog('mail', '%sender-name (@sender-from) sent an e-mail regarding %category.', array( + '%sender-name' => $values['name'], + '@sender-from' => $from, + '%category' => $values['category']['category']) + ); // Jump to home page rather than back to contact page to avoid // contradictory messages if flood control has been activated. @@ -237,7 +241,7 @@ function contact_personal_form($form, &$form_state, $recipient) { ); // Do not allow authenticated users to alter the name or e-mail values to // prevent the impersonation of other users. - if ($user->uid){ + if ($user->uid) { // Change form elements to values. $form['name']['#type'] = $form['mail']['#type'] = 'value'; @@ -318,7 +322,11 @@ function contact_personal_form_submit($form, &$form_state) { } flood_register_event('contact', config('contact.settings')->get('flood.interval')); - watchdog('mail', '%sender-name (@sender-from) sent %recipient-name an e-mail.', array('%sender-name' => $values['name'], '@sender-from' => $from, '%recipient-name' => $values['recipient']->name)); + watchdog('mail', '%sender-name (@sender-from) sent %recipient-name an e-mail.', array( + '%sender-name' => $values['name'], + '@sender-from' => $from, + '%recipient-name' => $values['recipient']->name) + ); // Jump to the contacted user's profile page. drupal_set_message(t('Your message has been sent.')); diff --git i/core/modules/contact/lib/Drupal/contact/Tests/ContactAuthenticatedUserTest.php w/core/modules/contact/lib/Drupal/contact/Tests/ContactAuthenticatedUserTest.php index 059923f..3650d34 100644 --- i/core/modules/contact/lib/Drupal/contact/Tests/ContactAuthenticatedUserTest.php +++ w/core/modules/contact/lib/Drupal/contact/Tests/ContactAuthenticatedUserTest.php @@ -21,6 +21,9 @@ class ContactAuthenticatedUserTest extends WebTestBase { */ public static $modules = array('contact'); + /** + * Info about the test, shows up on simpletest page. + */ public static function getInfo() { return array( 'name' => 'Contact form textfields', @@ -32,7 +35,7 @@ class ContactAuthenticatedUserTest extends WebTestBase { /** * Tests that name and email fields are not present for authenticated users. */ - function testContactSiteWideTextfieldsLoggedInTestCase() { + public function testContactSiteWideTextfieldsLoggedInTestCase() { $this->drupalLogin($this->drupalCreateUser(array('access site-wide contact form'))); $this->drupalGet('contact'); diff --git i/core/modules/contact/lib/Drupal/contact/Tests/ContactPersonalTest.php w/core/modules/contact/lib/Drupal/contact/Tests/ContactPersonalTest.php index 16d26b0..c31c813 100644 --- i/core/modules/contact/lib/Drupal/contact/Tests/ContactPersonalTest.php +++ w/core/modules/contact/lib/Drupal/contact/Tests/ContactPersonalTest.php @@ -21,10 +21,13 @@ class ContactPersonalTest extends WebTestBase { */ public static $modules = array('contact'); - private $admin_user; - private $web_user; - private $contact_user; + protected $adminUser; + protected $webUser; + protected $contactUser; + /** + * Info about the test, shows up on simpletest page. + */ public static function getInfo() { return array( 'name' => 'Personal contact form', @@ -33,40 +36,43 @@ class ContactPersonalTest extends WebTestBase { ); } - function setUp() { + /** + * Setup the test, Creating an user. + */ + public function setUp() { parent::setUp(); // Create an admin user. - $this->admin_user = $this->drupalCreateUser(array('administer contact forms', 'administer users')); + $this->adminUser = $this->drupalCreateUser(array('administer contact forms', 'administer users')); // Create some normal users with their contact forms enabled by default. config('contact.settings')->set('user_default_enabled', 1)->save(); - $this->web_user = $this->drupalCreateUser(array('access user contact forms')); - $this->contact_user = $this->drupalCreateUser(); + $this->webUser = $this->drupalCreateUser(array('access user contact forms')); + $this->contactUser = $this->drupalCreateUser(); } /** * Tests access to the personal contact form. */ - function testPersonalContactAccess() { + public function testPersonalContactAccess() { // Test allowed access to admin user's contact form. - $this->drupalLogin($this->web_user); - $this->drupalGet('user/' . $this->admin_user->uid . '/contact'); + $this->drupalLogin($this->webUser); + $this->drupalGet('user/' . $this->adminUser->uid . '/contact'); $this->assertResponse(200); // Test denied access to admin user's own contact form. $this->drupalLogout(); - $this->drupalLogin($this->admin_user); - $this->drupalGet('user/' . $this->admin_user->uid . '/contact'); + $this->drupalLogin($this->adminUser); + $this->drupalGet('user/' . $this->adminUser->uid . '/contact'); $this->assertResponse(403); // Test allowed access to user with contact form enabled. - $this->drupalLogin($this->web_user); - $this->drupalGet('user/' . $this->contact_user->uid . '/contact'); + $this->drupalLogin($this->webUser); + $this->drupalGet('user/' . $this->contactUser->uid . '/contact'); $this->assertResponse(200); // Test denied access to the user's own contact form. - $this->drupalGet('user/' . $this->web_user->uid . '/contact'); + $this->drupalGet('user/' . $this->webUser->uid . '/contact'); $this->assertResponse(403); // Test always denied access to the anonymous user contact form. @@ -76,22 +82,22 @@ class ContactPersonalTest extends WebTestBase { // Test that anonymous users can access the contact form. $this->drupalLogout(); user_role_grant_permissions(DRUPAL_ANONYMOUS_RID, array('access user contact forms')); - $this->drupalGet('user/' . $this->contact_user->uid . '/contact'); + $this->drupalGet('user/' . $this->contactUser->uid . '/contact'); $this->assertResponse(200); // Test that anonymous users can access admin user's contact form. - $this->drupalGet('user/' . $this->admin_user->uid . '/contact'); + $this->drupalGet('user/' . $this->adminUser->uid . '/contact'); $this->assertResponse(200); // Revoke the personal contact permission for the anonymous user. user_role_revoke_permissions(DRUPAL_ANONYMOUS_RID, array('access user contact forms')); - $this->drupalGet('user/' . $this->contact_user->uid . '/contact'); + $this->drupalGet('user/' . $this->contactUser->uid . '/contact'); $this->assertResponse(403); - $this->drupalGet('user/' . $this->admin_user->uid . '/contact'); + $this->drupalGet('user/' . $this->adminUser->uid . '/contact'); $this->assertResponse(403); // Disable the personal contact form. - $this->drupalLogin($this->admin_user); + $this->drupalLogin($this->adminUser); $edit = array('contact_default_status' => FALSE); $this->drupalPost('admin/config/people/accounts', $edit, t('Save configuration')); $this->assertText(t('The configuration options have been saved.'), t('Setting successfully saved.')); @@ -99,69 +105,70 @@ class ContactPersonalTest extends WebTestBase { // Re-create our contacted user with personal contact forms disabled by // default. - $this->contact_user = $this->drupalCreateUser(); + $this->contactUser = $this->drupalCreateUser(); // Test denied access to a user with contact form disabled. - $this->drupalLogin($this->web_user); - $this->drupalGet('user/' . $this->contact_user->uid . '/contact'); + $this->drupalLogin($this->webUser); + $this->drupalGet('user/' . $this->contactUser->uid . '/contact'); $this->assertResponse(403); // Test allowed access for admin user to a user with contact form disabled. - $this->drupalLogin($this->admin_user); - $this->drupalGet('user/' . $this->contact_user->uid . '/contact'); + $this->drupalLogin($this->adminUser); + $this->drupalGet('user/' . $this->contactUser->uid . '/contact'); $this->assertResponse(200); // Re-create our contacted user as a blocked user. - $this->contact_user = $this->drupalCreateUser(); - $this->contact_user->status = 0; - $this->contact_user->save(); + $this->contactUser = $this->drupalCreateUser(); + $this->contactUser->status = 0; + $this->contactUser->save(); // Test that blocked users can still be contacted by admin. - $this->drupalGet('user/' . $this->contact_user->uid . '/contact'); + $this->drupalGet('user/' . $this->contactUser->uid . '/contact'); $this->assertResponse(200); // Test that blocked users cannot be contacted by non-admins. - $this->drupalLogin($this->web_user); - $this->drupalGet('user/' . $this->contact_user->uid . '/contact'); + $this->drupalLogin($this->webUser); + $this->drupalGet('user/' . $this->contactUser->uid . '/contact'); $this->assertResponse(403); } /** * Tests the personal contact form flood protection. */ - function testPersonalContactFlood() { + public function testPersonalContactFlood() { $flood_limit = 3; config('contact.settings')->set('flood.limit', $flood_limit)->save(); - // Clear flood table in preparation for flood test and allow other checks to complete. + // Clear flood table in preparation for flood test, + // and allow other checks to complete. db_delete('flood')->execute(); $num_records_flood = db_query("SELECT COUNT(*) FROM {flood}")->fetchField(); $this->assertIdentical($num_records_flood, '0', 'Flood table emptied.'); - $this->drupalLogin($this->web_user); + $this->drupalLogin($this->webUser); // Submit contact form with correct values and check flood interval. for ($i = 0; $i < $flood_limit; $i++) { - $this->submitPersonalContact($this->contact_user); + $this->submitPersonalContact($this->contactUser); $this->assertText(t('Your message has been sent.'), 'Message sent.'); } // Submit contact form one over limit. - $this->drupalGet('user/' . $this->contact_user->uid. '/contact'); + $this->drupalGet('user/' . $this->contactUser->uid . '/contact'); $this->assertRaw(t('You cannot send more than %number messages in @interval. Try again later.', array('%number' => $flood_limit, '@interval' => format_interval(config('contact.settings')->get('flood.interval')))), 'Normal user denied access to flooded contact form.'); // Test that the admin user can still access the contact form even though // the flood limit was reached. - $this->drupalLogin($this->admin_user); + $this->drupalLogin($this->adminUser); $this->assertNoText('Try again later.', 'Admin user not denied access to flooded contact form.'); } /** * Fills out a user's personal contact form and submits it. * - * @param $account + * @param Object $account * A user object of the user being contacted. - * @param $message + * @param Array $message * An optional array with the form fields being used. */ protected function submitPersonalContact($account, array $message = array()) { diff --git i/core/modules/contact/lib/Drupal/contact/Tests/ContactSitewideTest.php w/core/modules/contact/lib/Drupal/contact/Tests/ContactSitewideTest.php index 7eae709..80ebdb8 100644 --- i/core/modules/contact/lib/Drupal/contact/Tests/ContactSitewideTest.php +++ w/core/modules/contact/lib/Drupal/contact/Tests/ContactSitewideTest.php @@ -21,6 +21,10 @@ class ContactSitewideTest extends WebTestBase { */ public static $modules = array('contact'); + + /** + * Info about the test, shows up on simpletest page. + */ public static function getInfo() { return array( 'name' => 'Site-wide contact form', @@ -32,9 +36,13 @@ class ContactSitewideTest extends WebTestBase { /** * Tests configuration options and the site-wide contact form. */ - function testSiteWideContact() { + public function testSiteWideContact() { // Create and login administrative user. - $admin_user = $this->drupalCreateUser(array('access site-wide contact form', 'administer contact forms', 'administer users')); + $admin_user = $this->drupalCreateUser(array( + 'access site-wide contact form', + 'administer contact forms', + 'administer users') + ); $this->drupalLogin($admin_user); $flood_limit = 3; @@ -64,10 +72,21 @@ class ContactSitewideTest extends WebTestBase { // Add categories. // Test invalid recipients. - $invalid_recipients = array('invalid', 'invalid@', 'invalid@site.', '@site.', '@site.com'); + $invalid_recipients = array( + 'invalid', + 'invalid@', + 'invalid@site.', + '@site.', + '@site.com'); + foreach ($invalid_recipients as $invalid_recipient) { $this->addCategory($this->randomName(16), $invalid_recipient, '', FALSE); - $this->assertRaw(t('%recipient is an invalid e-mail address.', array('%recipient' => $invalid_recipient)), t('Caught invalid recipient (' . $invalid_recipient . ').')); + $this->assertRaw( + t('%recipient is an invalid e-mail address.', array( + '%recipient' => $invalid_recipient)), + t('Caught invalid recipient (%recipient).', array( + '%recipient' => $invalid_recipient)) + ); } // Test validation of empty category and recipients fields. @@ -76,11 +95,15 @@ class ContactSitewideTest extends WebTestBase { $this->assertText(t('Recipients field is required.'), t('Caught empty recipients field.')); // Create first valid category. - $recipients = array('simpletest@example.com', 'simpletest2@example.com', 'simpletest3@example.com'); - $this->addCategory($category = $this->randomName(16), implode(',', array($recipients[0])), '', TRUE); + $recipients = array( + 'simpletest@example.com', + 'simpletest2@example.com', + 'simpletest3@example.com'); + $category = $this->randomName(16); + $this->addCategory($category, implode(',', array($recipients[0])), '', TRUE); $this->assertRaw(t('Category %category has been saved.', array('%category' => $category)), t('Category successfully saved.')); - // Make sure the newly created category is included in the list of categories. + // Make sure the newly created category is included in the category list. $this->assertNoUniqueText($category, t('New category included in categories list.')); // Test update contact form category. @@ -102,10 +125,15 @@ class ContactSitewideTest extends WebTestBase { $this->drupalLogin($admin_user); // Add more categories. - $this->addCategory($category = $this->randomName(16), implode(',', array($recipients[0], $recipients[1])), '', FALSE); + $category = $this->randomName(16); + $this->addCategory($category, implode(',', array($recipients[0], $recipients[1])), '', FALSE); $this->assertRaw(t('Category %category has been saved.', array('%category' => $category)), t('Category successfully saved.')); - $this->addCategory($category = $this->randomName(16), implode(',', array($recipients[0], $recipients[1], $recipients[2])), '', FALSE); + $category = $this->randomName(16); + $this->addCategory($category, implode(',', array( + $recipients[0], + $recipients[1], + $recipients[2])), '', FALSE); $this->assertRaw(t('Category %category has been saved.', array('%category' => $category)), t('Category successfully saved.')); // Try adding a category that already exists. @@ -113,13 +141,14 @@ class ContactSitewideTest extends WebTestBase { $this->assertNoRaw(t('Category %category has been saved.', array('%category' => $category)), t('Category not saved.')); $this->assertRaw(t('A contact form with category %category already exists.', array('%category' => $category)), t('Duplicate category error found.')); - // Clear flood table in preparation for flood test and allow other checks to complete. + // Clear flood table in preparation for flood test, + // and allow other checks to complete. db_delete('flood')->execute(); $num_records_after = db_query("SELECT COUNT(*) FROM {flood}")->fetchField(); $this->assertIdentical($num_records_after, '0', t('Flood table emptied.')); $this->drupalLogout(); - // Check to see that anonymous user cannot see contact page without permission. + // Check that anonymous user cannot see contact page without permission. user_role_revoke_permissions(DRUPAL_ANONYMOUS_RID, array('access site-wide contact form')); $this->drupalGet('contact'); $this->assertResponse(403, t('Access denied to anonymous user without permission.')); @@ -172,11 +201,16 @@ class ContactSitewideTest extends WebTestBase { } /** - * Tests auto-reply on the site-wide contact form. - */ - function testAutoReply() { + * Tests auto-reply on the site-wide contact form. + */ + public function testAutoReply() { // Create and login administrative user. - $admin_user = $this->drupalCreateUser(array('access site-wide contact form', 'administer contact forms', 'administer permissions', 'administer users')); + $admin_user = $this->drupalCreateUser(array( + 'access site-wide contact form', + 'administer contact forms', + 'administer permissions', + 'administer users') + ); $this->drupalLogin($admin_user); // Set up three categories, 2 with an auto-reply and one without. @@ -195,8 +229,13 @@ class ContactSitewideTest extends WebTestBase { $subject = $this->randomName(64); $this->submitContact($this->randomName(16), $email, $subject, 2, $this->randomString(128)); - // We are testing the auto-reply, so there should be one e-mail going to the sender. - $captured_emails = $this->drupalGetMails(array('id' => 'contact_page_autoreply', 'to' => $email, 'from' => 'foo@example.com')); + // We are testing the auto-reply, + // so there should be one e-mail going to the sender. + $captured_emails = $this->drupalGetMails(array( + 'id' => 'contact_page_autoreply', + 'to' => $email, + 'from' => 'foo@example.com') + ); $this->assertEqual(count($captured_emails), 1, t('Auto-reply e-mail was sent to the sender for category "foo".'), t('Contact')); $this->assertEqual($captured_emails[0]['body'], drupal_html_to_text($foo_autoreply), t('Auto-reply e-mail body is correct for category "foo".'), t('Contact')); @@ -204,15 +243,24 @@ class ContactSitewideTest extends WebTestBase { $email = $this->randomName(32) . '@example.com'; $this->submitContact($this->randomName(16), $email, $this->randomString(64), 3, $this->randomString(128)); - // Auto-reply for category 'bar' should result in one auto-reply e-mail to the sender. - $captured_emails = $this->drupalGetMails(array('id' => 'contact_page_autoreply', 'to' => $email, 'from' => 'bar@example.com')); + // Auto-reply for category 'bar', + // should result in one auto-reply e-mail to the sender. + $captured_emails = $this->drupalGetMails(array( + 'id' => 'contact_page_autoreply', + 'to' => $email, + 'from' => 'bar@example.com') + ); $this->assertEqual(count($captured_emails), 1, t('Auto-reply e-mail was sent to the sender for category "bar".'), t('Contact')); $this->assertEqual($captured_emails[0]['body'], drupal_html_to_text($bar_autoreply), t('Auto-reply e-mail body is correct for category "bar".'), t('Contact')); - // Verify that no auto-reply is sent when the auto-reply field is left blank. + // Verify that no auto-reply is sent when the auto-reply field is blank. $email = $this->randomName(32) . '@example.com'; $this->submitContact($this->randomName(16), $email, $this->randomString(64), 4, $this->randomString(128)); - $captured_emails = $this->drupalGetMails(array('id' => 'contact_page_autoreply', 'to' => $email, 'from' => 'no_autoreply@example.com')); + $captured_emails = $this->drupalGetMails(array( + 'id' => 'contact_page_autoreply', + 'to' => $email, + 'from' => 'no_autoreply@example.com') + ); $this->assertEqual(count($captured_emails), 0, t('No auto-reply e-mail was sent to the sender for category "no-autoreply".'), t('Contact')); } @@ -229,7 +277,7 @@ class ContactSitewideTest extends WebTestBase { * @param boolean $selected * Boolean indicating whether the category should be selected by default. */ - function addCategory($category, $recipients, $reply, $selected) { + public function addCategory($category, $recipients, $reply, $selected) { $edit = array(); $edit['category'] = $category; $edit['recipients'] = $recipients; @@ -251,7 +299,7 @@ class ContactSitewideTest extends WebTestBase { * @param boolean $selected * Boolean indicating whether the category should be selected by default. */ - function updateCategory($categories, $category, $recipients, $reply, $selected) { + public function updateCategory($categories, $category, $recipients, $reply, $selected) { $category_id = $categories[array_rand($categories)]; $edit = array(); $edit['category'] = $category; @@ -276,7 +324,7 @@ class ContactSitewideTest extends WebTestBase { * @param string $message * The message body. */ - function submitContact($name, $mail, $subject, $cid, $message) { + public function submitContact($name, $mail, $subject, $cid, $message) { $edit = array(); $edit['name'] = $name; $edit['mail'] = $mail; @@ -289,7 +337,7 @@ class ContactSitewideTest extends WebTestBase { /** * Deletes all categories. */ - function deleteCategories() { + public function deleteCategories() { $categories = $this->getCategories(); foreach ($categories as $category) { $category_name = db_query("SELECT category FROM {contact} WHERE cid = :cid", array(':cid' => $category))->fetchField(); @@ -304,7 +352,7 @@ class ContactSitewideTest extends WebTestBase { * @return array * A list of the category IDs. */ - function getCategories() { + public function getCategories() { $categories = db_query('SELECT cid FROM {contact}')->fetchCol(); return $categories; }