contact.module 16.3 KB
Newer Older
Dries's avatar
 
Dries committed
1 2 3 4
<?php

/**
 * @file
5
 * Enables the use of personal and site-wide contact forms.
Dries's avatar
 
Dries committed
6 7
 */

8
use Drupal\contact\Plugin\Core\Entity\Category;
9

Dries's avatar
 
Dries committed
10
/**
11
 * Implements hook_help().
Dries's avatar
 
Dries committed
12
 */
13 14
function contact_help($path, $arg) {
  switch ($path) {
15
    case 'admin/help#contact':
16 17
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
18
      $output .= '<p>' . t('The Contact module allows visitors to contact site administrators and other users. Users specify a subject, write their message, and can have a copy of their message sent to their own e-mail address. For more information, see the online handbook entry for <a href="@contact">Contact module</a>.', array('@contact' => 'http://drupal.org/documentation/modules/contact')) . '</p>';
19 20 21 22 23
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('User contact forms') . '</dt>';
      $output .= '<dd>' . t('Site users can be contacted with a user contact form that keeps their e-mail address private. Users may enable or disable their personal contact forms by editing their <em>My account</em> page. If enabled, a <em>Contact</em> tab leads to a personal contact form displayed on their user profile. Site administrators are still able to use the contact form, even if has been disabled. The <em>Contact</em> tab is not shown when you view your own profile.') . '</dd>';
      $output .= '<dt>' . t('Site-wide contact forms') . '</dt>';
24
      $output .= '<dd>' . t('The <a href="@contact">Contact page</a> provides a simple form for users with the <em>Use the site-wide contact form</em> permission to send comments, feedback, or other requests. You can create categories for directing the contact form messages to a set of defined recipients. Common categories for a business site, for example, might include "Website feedback" (messages are forwarded to website administrators) and "Product information" (messages are forwarded to members of the sales department). E-mail addresses defined within a category are not displayed publicly.', array('@contact' => url('contact'))) . '</p>';
25
      $output .= '<dt>' . t('Navigation') . '</dt>';
26
      $output .= '<dd>' . t('When the site-wide contact form is enabled, a link in the <em>Main navigation</em> menu is created, but the link is disabled by default. This menu link can be enabled on the <a href="@menu">Menus administration page</a>.', array('@menu' => url('admin/structure/menu'))) . '</dd>';
27 28
      $output .= '<dt>' . t('Customization') . '</dt>';
      $output .= '<dd>' . t('If you would like additional text to appear on the site-wide or personal contact page, use a block. You can create and edit blocks on the <a href="@blocks">Blocks administration page</a>.', array('@blocks' => url('admin/structure/block'))) . '</dd>';
29
      $output .= '</dl>';
30
      return $output;
31
    case 'admin/structure/contact':
32
      $output = '<p>' . t('Add one or more categories on this page to set up your site-wide <a href="@form">contact form</a>.', array('@form' => url('contact'))) . '</p>';
33
      $output .= '<p>' . t('A <em>Contact</em> menu item (disabled by default) is added to the Tools menu, which you can modify on the <a href="@menu-settings">Menus administration page</a>.', array('@menu-settings' => url('admin/structure/menu'))) . '</p>';
34
      $output .= '<p>' . t('If you would like additional text to appear on the site-wide contact page, use a block. You can create and edit blocks on the <a href="@blocks">Blocks administration page</a>.', array('@blocks' => url('admin/structure/block'))) . '</p>';
35
      return $output;
Dries's avatar
 
Dries committed
36 37 38
  }
}

39
/**
40
 * Implements hook_permission().
41
 */
42
function contact_permission() {
43
  return array(
44
    'administer contact forms' => array(
45
      'title' => t('Administer contact forms and contact form settings'),
46 47
    ),
    'access site-wide contact form' => array(
48
      'title' => t('Use the site-wide contact form'),
49
    ),
50
    'access user contact forms' => array(
51
      'title' => t("Use users' personal contact forms"),
52
    ),
53
  );
54
}
55

Dries's avatar
 
Dries committed
56
/**
57
 * Implements hook_menu().
Dries's avatar
 
Dries committed
58
 */
59
function contact_menu() {
60
  $items['admin/structure/contact'] = array(
61 62
    'title' => 'Contact form',
    'description' => 'Create a system contact form and set up categories for the form to use.',
63
    'page callback' => 'contact_category_list',
64
    'access arguments' => array('administer contact forms'),
65
    'file' => 'contact.admin.inc',
66
  );
67
  $items['admin/structure/contact/add'] = array(
68
    'title' => 'Add category',
69
    'page callback' => 'contact_category_add',
70
    'access arguments' => array('administer contact forms'),
71
    'type' => MENU_LOCAL_ACTION,
72
    'weight' => 1,
73
    'file' => 'contact.admin.inc',
74
  );
75
  $items['admin/structure/contact/manage/%contact_category'] = array(
76
    'title' => 'Edit contact category',
77 78
    'title callback' => 'entity_page_label',
    'title arguments' => array(4),
79
    'page callback' => 'contact_category_edit',
80
    'page arguments' => array(4),
81
    'access arguments' => array('administer contact forms'),
82 83 84 85 86 87
    'file' => 'contact.admin.inc',
  );
  $items['admin/structure/contact/manage/%contact_category/edit'] = array(
    'title' => 'Edit',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
88
  );
89
  $items['admin/structure/contact/manage/%contact_category/delete'] = array(
90
    'title' => 'Delete',
91
    'page callback' => 'drupal_get_form',
92
    'page arguments' => array('contact_category_delete_form', 4),
93
    'access arguments' => array('administer contact forms'),
94
    'type' => MENU_LOCAL_TASK,
95
    'weight' => 10,
96
    'file' => 'contact.admin.inc',
97
  );
98

99
  $items['contact'] = array(
100
    'title' => 'Contact',
101
    'page callback' => 'contact_site_page',
102
    'access arguments' => array('access site-wide contact form'),
103
    'menu_name' => 'footer',
104
    'type' => MENU_SUGGESTED_ITEM,
105
    'file' => 'contact.pages.inc',
106
  );
107 108 109 110 111 112 113 114 115 116
  $items['contact/%contact_category'] = array(
    'title' => 'Contact category form',
    'title callback' => 'entity_page_label',
    'title arguments' => array(1),
    'page callback' => 'contact_site_page',
    'page arguments' => array(1),
    'access arguments' => array('access site-wide contact form'),
    'type' => MENU_VISIBLE_IN_BREADCRUMB,
    'file' => 'contact.pages.inc',
  );
117
  $items['user/%user/contact'] = array(
118
    'title' => 'Contact',
119 120
    'page callback' => 'contact_personal_page',
    'page arguments' => array(1),
121
    'type' => MENU_LOCAL_TASK,
122
    'access callback' => '_contact_personal_tab_access',
123 124
    'access arguments' => array(1),
    'weight' => 2,
125
    'file' => 'contact.pages.inc',
126
  );
Dries's avatar
 
Dries committed
127 128 129
  return $items;
}

130
/**
131 132
 * Access callback: Checks access for a user's personal contact form.
 *
133
 * @param $account
134 135 136
 *   The user object of the user whose contact form is being requested.
 *
 * @see contact_menu()
137
 */
138
function _contact_personal_tab_access($account) {
139
  global $user;
140

141 142
  // Anonymous users cannot have contact forms.
  if (!$account->uid) {
143 144 145 146 147 148 149 150
    return FALSE;
  }

  // Users may not contact themselves.
  if ($user->uid == $account->uid) {
    return FALSE;
  }

151 152 153 154 155
  // User administrators should always have access to personal contact forms.
  if (user_access('administer users')) {
    return TRUE;
  }

156 157
  // If requested user has been blocked, do not allow users to contact them.
  if (empty($account->status)) {
158 159 160
    return FALSE;
  }

161 162 163 164 165 166 167 168 169
  // If the requested user has disabled their contact form, do not allow users
  // to contact them.
  $account_data = drupal_container()->get('user.data')->get('contact', $account->id(), 'enabled');
  if (isset($account_data) && empty($account_data)) {
    return FALSE;
  }
  // If the requested user did not save a preference yet, deny access if the
  // configured default is disabled.
  elseif (!config('contact.settings')->get('user_default_enabled')) {
170 171 172
    return FALSE;
  }

173
  return user_access('access user contact forms');
174 175
}

176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
/**
 * Implements MODULE_config_import_create().
 */
function contact_config_import_create($name, $new_config, $old_config) {
  if (strpos($name, 'contact.category.') !== 0) {
    return FALSE;
  }

  $category = entity_create('contact_category', $new_config->get());
  $category->save();
  return TRUE;
}

/**
 * Implements MODULE_config_import_change().
 */
function contact_config_import_change($name, $new_config, $old_config) {
  if (strpos($name, 'contact.category.') !== 0) {
    return FALSE;
  }

  list(, , $id) = explode('.', $name);
  $category = entity_load('contact_category', $id);

  $category->original = clone $category;
  foreach ($old_config->get() as $property => $value) {
    $category->original->$property = $value;
  }

  foreach ($new_config->get() as $property => $value) {
    $category->$property = $value;
  }

  $category->save();
  return TRUE;
}

/**
 * Implements MODULE_config_import_delete().
 */
function contact_config_import_delete($name, $new_config, $old_config) {
  if (strpos($name, 'contact.category.') !== 0) {
    return FALSE;
  }

  list(, , $id) = explode('.', $name);
  entity_delete_multiple('contact_category', array($id));
  return TRUE;
}

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 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
/**
 * Implements hook_entity_info().
 */
function contact_entity_info(&$types) {
  foreach (config_get_storage_names_with_prefix('contact.category.') as $config_name) {
    $config = config($config_name);
    $types['contact_message']['bundles'][$config->get('id')] = array(
      'label' => $config->get('label'),
      'admin' => array(
        'path' => 'admin/structure/contact/manage/%contact_category',
        'real path' => 'admin/structure/contact/manage/' . $config->get('id'),
        'bundle argument' => 4,
        'access arguments' => array('administer contact forms'),
      ),
    );
  }
}

/**
 * Implements hook_field_extra_fields().
 */
function contact_field_extra_fields() {
  $fields = array();
  $entity_info = entity_get_info('contact_message');
  foreach (array_keys($entity_info['bundles']) as $bundle) {
    $fields['contact_message'][$bundle]['form']['name'] = array(
      'label' => t('Sender name'),
      'description' => t('Text'),
      'weight' => -50,
    );
    $fields['contact_message'][$bundle]['form']['mail'] = array(
      'label' => t('Sender e-mail'),
      'description' => t('E-mail'),
      'weight' => -40,
    );
    // @todo Recipient only makes sense if user contact form is a bundle/category.
    $fields['contact_message'][$bundle]['form']['recipient'] = array(
      'label' => t('Recipient user name'),
      'description' => t('User'),
      'weight' => -30,
    );
    $fields['contact_message'][$bundle]['form']['subject'] = array(
      'label' => t('Subject'),
      'description' => t('Text'),
      'weight' => -10,
    );
    $fields['contact_message'][$bundle]['form']['message'] = array(
      'label' => t('Message'),
      'description' => t('Long text'),
      'weight' => 0,
    );
    $fields['contact_message'][$bundle]['form']['copy'] = array(
      'label' => t('Send copy to sender'),
      'description' => t('Option'),
      'weight' => 50,
    );

    $fields['contact_message'][$bundle]['display']['message'] = array(
      'label' => t('Message'),
      'description' => t('The main contact message'),
      'weight' => 0,
    );
  }
  return $fields;
}

292
/**
293
 * Loads a contact category.
294
 *
295 296
 * @param $id
 *   The ID of the contact category to load.
297
 *
298
 * @return Drupal\contact\Plugin\Core\Entity\Category|false
299
 *   A Category object or FALSE if the requested $id does not exist.
300
 */
301 302 303 304 305 306 307
function contact_category_load($id) {
  return entity_load('contact_category', $id);
}

/**
 * Entity URI callback.
 *
308
 * @param Drupal\contact\Plugin\Core\Entity\Category $category
309 310 311 312 313 314 315 316 317
 *   A contact category entity.
 *
 * @return array
 *   An array with 'path' as the key and the path to the category as the value.
 */
function contact_category_uri(Category $category) {
  return array(
    'path' => 'admin/structure/contact/manage/' . $category->id(),
  );
318 319
}

320
/**
321
 * Implements hook_mail().
322 323
 */
function contact_mail($key, &$message, $params) {
324 325
  $contact_message = $params['contact_message'];
  $sender = $params['sender'];
326
  $language = language_load($message['langcode']);
327

328
  $variables = array(
329
    '!site-name' => config('system.site')->get('name'),
330 331
    '!subject' => $contact_message->subject,
    '!category' => isset($params['contact_category']) ? $params['contact_category']->label() : NULL,
332
    '!form-url' => url(current_path(), array('absolute' => TRUE, 'language' => $language)),
333
    '!sender-name' => user_format_name($sender),
334
  );
335 336 337 338 339 340 341 342 343
  if (!empty($sender->uid)) {
    $sender_uri = $sender->uri();
    $variables['!sender-url'] = url($sender_uri['path'], array('absolute' => TRUE, 'language' => $language) + $sender_uri['options']);
  }
  else {
    $variables['!sender-url'] = $params['sender']->mail;
  }

  $options = array('langcode' => $language->langcode);
344

345 346 347
  switch ($key) {
    case 'page_mail':
    case 'page_copy':
348 349 350 351
      $message['subject'] .= t('[!category] !subject', $variables, $options);
      $message['body'][] = t("!sender-name (!sender-url) sent a message using the contact form at !form-url.", $variables, $options);
      $build = entity_view($contact_message, 'mail', $language->langcode);
      $message['body'][] = drupal_render($build);
352
      break;
353

354
    case 'page_autoreply':
355 356
      $message['subject'] .= t('[!category] !subject', $variables, $options);
      $message['body'][] = $params['contact_category']->reply;
357
      break;
358

359 360
    case 'user_mail':
    case 'user_copy':
361
      $variables += array(
362
        '!recipient-name' => user_format_name($params['recipient']),
363
        '!recipient-edit-url' => url('user/' . $params['recipient']->uid . '/edit', array('absolute' => TRUE, 'language' => $language)),
364
      );
365 366 367 368 369 370
      $message['subject'] .= t('[!site-name] !subject', $variables, $options);
      $message['body'][] = t('Hello !recipient-name,', $variables, $options);
      $message['body'][] = t("!sender-name (!sender-url) has sent you a message via your contact form at !site-name.", $variables, $options);
      $message['body'][] = t("If you don't want to receive such e-mails, you can change your settings at !recipient-edit-url.", $variables, $options);
      $message['body'][] = t('Message:', array(), $options);
      $message['body'][] = $contact_message->message;
371 372
      break;
  }
373
}
374

375
/**
376
 * Implements hook_form_FORM_ID_alter().
377 378
 *
 * Add the enable personal contact form to an individual user's account page.
379 380
 *
 * @see user_profile_form()
381 382
 */
function contact_form_user_profile_form_alter(&$form, &$form_state) {
383
  $form['contact'] = array(
384
    '#type' => 'details',
385 386 387 388
    '#title' => t('Contact settings'),
    '#weight' => 5,
    '#collapsible' => TRUE,
  );
389
  $account = $form_state['controller']->getEntity($form_state);
390
  $account_data = drupal_container()->get('user.data')->get('contact', $account->id(), 'enabled');
391 392 393
  $form['contact']['contact'] = array(
    '#type' => 'checkbox',
    '#title' => t('Personal contact form'),
394
    '#default_value' => isset($account_data) ? $account_data : config('contact.settings')->get('user_default_enabled'),
395
    '#description' => t('Allow other users to contact you via a personal contact form which keeps your e-mail address hidden. Note that some privileged users such as site administrators are still able to contact you even if you choose to disable this feature.'),
396
  );
397 398
}

399
/**
400
 * Implements hook_user_update().
401
 */
402 403 404 405
function contact_user_update($account) {
  if (isset($account->contact)) {
    drupal_container()->get('user.data')->set('contact', $account->id(), 'enabled', (int) $account->contact);
  }
406 407
}

408
/**
409
 * Implements hook_form_FORM_ID_alter().
410 411
 *
 * Add the default personal contact setting on the user settings page.
412 413
 *
 * @see user_admin_settings()
414
 */
415
function contact_form_user_admin_settings_alter(&$form, &$form_state) {
416
  $form['contact'] = array(
417
    '#type' => 'details',
418
    '#title' => t('Contact settings'),
419 420 421 422 423
    '#weight' => 0,
  );
  $form['contact']['contact_default_status'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable the personal contact form by default for new users.'),
424
    '#description' => t('Changing this setting will not affect existing users.'),
425
    '#default_value' => config('contact.settings')->get('user_default_enabled'),
426
  );
427 428 429 430 431 432 433 434 435 436 437 438 439
  // Add submit handler to save contact configuration.
  $form['#submit'][] = 'contact_form_user_admin_settings_submit';
}

/**
 * Form submission handler for user_admin_settings().
 *
 * @see contact_form_user_admin_settings_alter()
 */
function contact_form_user_admin_settings_submit($form, &$form_state) {
  config('contact.settings')
    ->set('user_default_enabled', $form_state['values']['contact_default_status'])
    ->save();
440
}