ContactPersonalTest.php 10.9 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Contains \Drupal\contact\Tests\ContactPersonalTest.
6 7 8 9
 */

namespace Drupal\contact\Tests;

10
use Drupal\Component\Utility\String;
11
use Drupal\Core\Session\AccountInterface;
12 13 14
use Drupal\simpletest\WebTestBase;

/**
15 16 17
 * Tests personal contact form functionality.
 *
 * @group contact
18 19
 */
class ContactPersonalTest extends WebTestBase {
20 21 22 23 24 25

  /**
   * Modules to enable.
   *
   * @var array
   */
26
  public static $modules = array('contact', 'dblog');
27

28 29 30 31 32
  /**
   * A user with some administrative permissions.
   *
   * @var object
   */
33
  private $admin_user;
34 35 36 37 38 39

  /**
   * A user with 'access user contact forms' permission.
   *
   * @var object
   */
40
  private $web_user;
41 42 43 44 45 46

  /**
   * A user without any permissions.
   *
   * @var object
   */
47 48 49
  private $contact_user;

  function setUp() {
50
    parent::setUp();
51 52

    // Create an admin user.
53
    $this->admin_user = $this->drupalCreateUser(array('administer contact forms', 'administer users', 'administer account settings', 'access site reports'));
54 55

    // Create some normal users with their contact forms enabled by default.
56
    \Drupal::config('contact.settings')->set('user_default_enabled', TRUE)->save();
57 58 59 60
    $this->web_user = $this->drupalCreateUser(array('access user contact forms'));
    $this->contact_user = $this->drupalCreateUser();
  }

61 62 63 64 65 66 67 68 69 70
  /**
   * Tests that mails for contact messages are correctly sent.
   */
  function testSendPersonalContactMessage() {
    $this->drupalLogin($this->web_user);

    $message = $this->submitPersonalContact($this->contact_user);
    $mails = $this->drupalGetMails();
    $this->assertEqual(1, count($mails));
    $mail = $mails[0];
71
    $this->assertEqual($mail['to'], $this->contact_user->getEmail());
72 73
    $this->assertEqual($mail['from'], \Drupal::config('system.site')->get('mail'));
    $this->assertEqual($mail['reply-to'], $this->web_user->getEmail());
74 75
    $this->assertEqual($mail['key'], 'user_mail');
    $variables = array(
76
      '!site-name' => \Drupal::config('system.site')->get('name'),
77
      '!subject' => $message['subject[0][value]'],
78
      '!recipient-name' => $this->contact_user->getUsername(),
79 80 81
    );
    $this->assertEqual($mail['subject'], t('[!site-name] !subject', $variables), 'Subject is in sent message.');
    $this->assertTrue(strpos($mail['body'], t('Hello !recipient-name,', $variables)) !== FALSE, 'Recipient name is in sent message.');
82
    $this->assertTrue(strpos($mail['body'], $this->web_user->getUsername()) !== FALSE, 'Sender name is in sent message.');
83
    $this->assertTrue(strpos($mail['body'], $message['message[0][value]']) !== FALSE, 'Message body is in sent message.');
84 85 86 87 88 89 90 91 92 93 94

    // Check there was no problems raised during sending.
    $this->drupalLogout();
    $this->drupalLogin($this->admin_user);
    // Verify that the correct watchdog message has been logged.
    $this->drupalGet('/admin/reports/dblog');
    $placeholders = array(
      '@sender_name' => $this->web_user->username,
      '@sender_email' => $this->web_user->getEmail(),
      '@recipient_name' => $this->contact_user->getUsername()
    );
95
    $this->assertText(String::format('@sender_name (@sender_email) sent @recipient_name an email.', $placeholders));
96 97
  }

98 99 100 101
  /**
   * Tests access to the personal contact form.
   */
  function testPersonalContactAccess() {
102 103
    // Test allowed access to admin user's contact form.
    $this->drupalLogin($this->web_user);
104
    $this->drupalGet('user/' . $this->admin_user->id() . '/contact');
105
    $this->assertResponse(200);
106 107
    // Check the page title is properly displayed.
    $this->assertRaw(t('Contact @username', array('@username' => $this->admin_user->getUsername())));
108 109 110 111

    // Test denied access to admin user's own contact form.
    $this->drupalLogout();
    $this->drupalLogin($this->admin_user);
112
    $this->drupalGet('user/' . $this->admin_user->id() . '/contact');
113 114
    $this->assertResponse(403);

115 116
    // Test allowed access to user with contact form enabled.
    $this->drupalLogin($this->web_user);
117
    $this->drupalGet('user/' . $this->contact_user->id() . '/contact');
118 119 120
    $this->assertResponse(200);

    // Test denied access to the user's own contact form.
121
    $this->drupalGet('user/' . $this->web_user->id() . '/contact');
122 123 124 125 126 127 128 129 130
    $this->assertResponse(403);

    // Test always denied access to the anonymous user contact form.
    $this->drupalGet('user/0/contact');
    $this->assertResponse(403);

    // Test that anonymous users can access the contact form.
    $this->drupalLogout();
    user_role_grant_permissions(DRUPAL_ANONYMOUS_RID, array('access user contact forms'));
131
    $this->drupalGet('user/' . $this->contact_user->id() . '/contact');
132 133
    $this->assertResponse(200);

134
    // Test that anonymous users can access admin user's contact form.
135
    $this->drupalGet('user/' . $this->admin_user->id() . '/contact');
136 137
    $this->assertResponse(200);

138 139
    // Revoke the personal contact permission for the anonymous user.
    user_role_revoke_permissions(DRUPAL_ANONYMOUS_RID, array('access user contact forms'));
140
    $this->drupalGet('user/' . $this->contact_user->id() . '/contact');
141
    $this->assertResponse(403);
142
    $this->drupalGet('user/' . $this->admin_user->id() . '/contact');
143
    $this->assertResponse(403);
144 145 146 147

    // Disable the personal contact form.
    $this->drupalLogin($this->admin_user);
    $edit = array('contact_default_status' => FALSE);
148
    $this->drupalPostForm('admin/config/people/accounts', $edit, t('Save configuration'));
149
    $this->assertText(t('The configuration options have been saved.'), 'Setting successfully saved.');
150 151 152 153 154 155 156 157
    $this->drupalLogout();

    // Re-create our contacted user with personal contact forms disabled by
    // default.
    $this->contact_user = $this->drupalCreateUser();

    // Test denied access to a user with contact form disabled.
    $this->drupalLogin($this->web_user);
158
    $this->drupalGet('user/' . $this->contact_user->id() . '/contact');
159 160 161 162
    $this->assertResponse(403);

    // Test allowed access for admin user to a user with contact form disabled.
    $this->drupalLogin($this->admin_user);
163
    $this->drupalGet('user/' . $this->contact_user->id() . '/contact');
164 165 166 167
    $this->assertResponse(200);

    // Re-create our contacted user as a blocked user.
    $this->contact_user = $this->drupalCreateUser();
168
    $this->contact_user->block();
169 170 171
    $this->contact_user->save();

    // Test that blocked users can still be contacted by admin.
172
    $this->drupalGet('user/' . $this->contact_user->id() . '/contact');
173 174 175 176
    $this->assertResponse(200);

    // Test that blocked users cannot be contacted by non-admins.
    $this->drupalLogin($this->web_user);
177
    $this->drupalGet('user/' . $this->contact_user->id() . '/contact');
178
    $this->assertResponse(403);
179 180 181 182 183 184

    // Test enabling and disabling the contact page through the user profile
    // form.
    $this->drupalGet('user/' . $this->web_user->id() . '/edit');
    $this->assertNoFieldChecked('edit-contact--2');
    $this->assertFalse(\Drupal::service('user.data')->get('contact', $this->web_user->id(), 'enabled'), 'Personal contact form disabled');
185
    $this->drupalPostForm(NULL, array('contact' => TRUE), t('Save'));
186 187
    $this->assertFieldChecked('edit-contact--2');
    $this->assertTrue(\Drupal::service('user.data')->get('contact', $this->web_user->id(), 'enabled'), 'Personal contact form enabled');
188 189 190 191 192 193 194
  }

  /**
   * Tests the personal contact form flood protection.
   */
  function testPersonalContactFlood() {
    $flood_limit = 3;
195
    \Drupal::config('contact.settings')->set('flood.limit', $flood_limit)->save();
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210

    // 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);

    // Submit contact form with correct values and check flood interval.
    for ($i = 0; $i < $flood_limit; $i++) {
      $this->submitPersonalContact($this->contact_user);
      $this->assertText(t('Your message has been sent.'), 'Message sent.');
    }

    // Submit contact form one over limit.
211
    $this->drupalGet('user/' . $this->contact_user->id(). '/contact');
212
    $this->assertRaw(t('You cannot send more than %number messages in @interval. Try again later.', array('%number' => $flood_limit, '@interval' => format_interval(\Drupal::config('contact.settings')->get('flood.interval')))), 'Normal user denied access to flooded contact form.');
213 214 215 216 217 218 219

    // Test that the admin user can still access the contact form even though
    // the flood limit was reached.
    $this->drupalLogin($this->admin_user);
    $this->assertNoText('Try again later.', 'Admin user not denied access to flooded contact form.');
  }

220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
  /**
   * Tests the personal contact form based access when an admin adds users.
   */
  function testAdminContact() {
    user_role_grant_permissions(DRUPAL_ANONYMOUS_RID, array('access user contact forms'));
    $this->checkContactAccess(200);
    $this->checkContactAccess(403, FALSE);
    $config = \Drupal::config('contact.settings');
    $config->set('user_default_enabled', FALSE);
    $config->save();
    $this->checkContactAccess(403);
  }

  /**
   * Creates a user and then checks contact form access.
   *
   * @param integer $response
   *   The expected response code.
   * @param boolean $contact_value
   *   (optional) The value the contact field should be set too.
   */
  protected function checkContactAccess($response, $contact_value = NULL) {
    $this->drupalLogin($this->admin_user);
    $this->drupalGet('admin/people/create');
    if (\Drupal::config('contact.settings')->get('user_default_enabled', TRUE)) {
      $this->assertFieldChecked('edit-contact--2');
    }
    else {
      $this->assertNoFieldChecked('edit-contact--2');
    }
    $name = $this->randomName();
    $edit = array(
      'name' => $name,
      'mail' => $this->randomName() . '@example.com',
      'pass[pass1]' => $pass = $this->randomString(),
      'pass[pass2]' => $pass,
      'notify' => FALSE,
    );
    if (isset($contact_value)) {
      $edit['contact'] = $contact_value;
    }
    $this->drupalPostForm('admin/people/create', $edit, t('Create new account'));
    $user = user_load_by_name($name);
    $this->drupalLogout();

    $this->drupalGet('user/' . $user->id() . '/contact');
    $this->assertResponse($response);
  }

269 270 271
  /**
   * Fills out a user's personal contact form and submits it.
   *
272
   * @param \Drupal\Core\Session\AccountInterface $account
273
   *   A user object of the user being contacted.
274
   * @param array $message
275 276
   *   (optional) An array with the form fields being used. Defaults to an empty
   *   array.
277 278 279
   *
   * @return array
   *   An array with the form fields being used.
280
   */
281
  protected function submitPersonalContact(AccountInterface $account, array $message = array()) {
282
    $message += array(
283 284
      'subject[0][value]' => $this->randomName(16),
      'message[0][value]' => $this->randomName(64),
285
    );
286
    $this->drupalPostForm('user/' . $account->id() . '/contact', $message, t('Send message'));
287
    return $message;
288
  }
289

290
}