contact.module 14.9 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>Footer</em> menu is created, which you can modify 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 is added to the <em>Footer</em> 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
    'file' => 'contact.admin.inc',
  );
  $items['admin/structure/contact/manage/%contact_category/edit'] = array(
    'title' => 'Edit',
    'type' => MENU_DEFAULT_LOCAL_TASK,
87
  );
88
  $items['admin/structure/contact/manage/%contact_category/delete'] = array(
89
    'title' => 'Delete',
90
    'route_name' => 'contact_category_delete',
91
    'type' => MENU_LOCAL_TASK,
92
    'weight' => 10,
93
  );
94

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

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

137 138
  // Anonymous users cannot have contact forms.
  if (!$account->uid) {
139 140 141 142 143 144 145 146
    return FALSE;
  }

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

147 148 149 150 151
  // User administrators should always have access to personal contact forms.
  if (user_access('administer users')) {
    return TRUE;
  }

152 153
  // If requested user has been blocked, do not allow users to contact them.
  if (empty($account->status)) {
154 155 156
    return FALSE;
  }

157 158 159 160 161 162 163 164 165
  // 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')) {
166 167 168
    return FALSE;
  }

169
  return user_access('access user contact forms');
170 171
}

172
/**
173
 * Implements hook_entity_bundle_info().
174
 */
175 176
function contact_entity_bundle_info() {
  $bundles = array();
177 178
  foreach (config_get_storage_names_with_prefix('contact.category.') as $config_name) {
    $config = config($config_name);
179
    $bundles['contact_message'][$config->get('id')] = array(
180 181 182 183 184 185 186
      'label' => $config->get('label'),
      'admin' => array(
        'real path' => 'admin/structure/contact/manage/' . $config->get('id'),
        'access arguments' => array('administer contact forms'),
      ),
    );
  }
187
  return $bundles;
188 189 190 191 192 193 194
}

/**
 * Implements hook_field_extra_fields().
 */
function contact_field_extra_fields() {
  $fields = array();
195
  foreach (array_keys(entity_get_bundles('contact_message')) as $bundle) {
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 226 227 228 229 230 231 232 233
    $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,
    );
  }
234 235 236 237 238 239

  $fields['user']['user']['form']['contact'] = array(
    'label' => t('Contact settings'),
    'description' => t('Contact module form element.'),
    'weight' => 5,
  );
240 241 242
  return $fields;
}

243
/**
244
 * Loads a contact category.
245
 *
246 247
 * @param $id
 *   The ID of the contact category to load.
248
 *
249
 * @return Drupal\contact\Plugin\Core\Entity\Category|false
250
 *   A Category object or FALSE if the requested $id does not exist.
251
 */
252 253 254 255 256 257 258
function contact_category_load($id) {
  return entity_load('contact_category', $id);
}

/**
 * Entity URI callback.
 *
259
 * @param Drupal\contact\Plugin\Core\Entity\Category $category
260 261 262 263 264 265 266 267 268
 *   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(),
  );
269 270
}

271
/**
272
 * Implements hook_mail().
273 274
 */
function contact_mail($key, &$message, $params) {
275 276
  $contact_message = $params['contact_message'];
  $sender = $params['sender'];
277
  $language = language_load($message['langcode']);
278

279
  $variables = array(
280
    '!site-name' => config('system.site')->get('name'),
281 282
    '!subject' => $contact_message->subject,
    '!category' => isset($params['contact_category']) ? $params['contact_category']->label() : NULL,
283
    '!form-url' => url(current_path(), array('absolute' => TRUE, 'language' => $language)),
284
    '!sender-name' => user_format_name($sender),
285
  );
286 287 288 289 290 291 292 293 294
  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);
295

296 297 298
  switch ($key) {
    case 'page_mail':
    case 'page_copy':
299 300 301 302
      $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);
303
      break;
304

305
    case 'page_autoreply':
306 307
      $message['subject'] .= t('[!category] !subject', $variables, $options);
      $message['body'][] = $params['contact_category']->reply;
308
      break;
309

310 311
    case 'user_mail':
    case 'user_copy':
312
      $variables += array(
313
        '!recipient-name' => user_format_name($params['recipient']),
314
        '!recipient-edit-url' => url('user/' . $params['recipient']->uid . '/edit', array('absolute' => TRUE, 'language' => $language)),
315
      );
316 317 318 319 320 321
      $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;
322 323
      break;
  }
324
}
325

326
/**
327
 * Implements hook_form_FORM_ID_alter().
328 329
 *
 * Add the enable personal contact form to an individual user's account page.
330 331
 *
 * @see user_profile_form()
332 333
 */
function contact_form_user_profile_form_alter(&$form, &$form_state) {
334
  $form['contact'] = array(
335
    '#type' => 'details',
336 337 338
    '#title' => t('Contact settings'),
    '#weight' => 5,
  );
339
  $account = $form_state['controller']->getEntity();
340
  $account_data = drupal_container()->get('user.data')->get('contact', $account->id(), 'enabled');
341 342 343
  $form['contact']['contact'] = array(
    '#type' => 'checkbox',
    '#title' => t('Personal contact form'),
344
    '#default_value' => isset($account_data) ? $account_data : config('contact.settings')->get('user_default_enabled'),
345
    '#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.'),
346
  );
347 348
}

349
/**
350
 * Implements hook_user_update().
351
 */
352 353 354 355
function contact_user_update($account) {
  if (isset($account->contact)) {
    drupal_container()->get('user.data')->set('contact', $account->id(), 'enabled', (int) $account->contact);
  }
356 357
}

358
/**
359
 * Implements hook_form_FORM_ID_alter().
360 361
 *
 * Add the default personal contact setting on the user settings page.
362 363
 *
 * @see user_admin_settings()
364
 */
365
function contact_form_user_admin_settings_alter(&$form, &$form_state) {
366
  $form['contact'] = array(
367
    '#type' => 'details',
368
    '#title' => t('Contact settings'),
369 370 371 372 373
    '#weight' => 0,
  );
  $form['contact']['contact_default_status'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable the personal contact form by default for new users.'),
374
    '#description' => t('Changing this setting will not affect existing users.'),
375
    '#default_value' => config('contact.settings')->get('user_default_enabled'),
376
  );
377 378 379 380 381 382 383 384 385 386 387 388 389
  // 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();
390
}