contact.module 14.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>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
    'title' => 'Contact form categories',
62
    'description' => 'Create a system contact form and set up categories for the form to use.',
63
    'route_name' => 'contact_category_list',
64
  );
65
  $items['admin/structure/contact/add'] = array(
66
    'title' => 'Add category',
67
    'route_name' => 'contact_category_add',
68
    'type' => MENU_LOCAL_ACTION,
69 70
    'weight' => 1,
  );
71
  $items['admin/structure/contact/manage/%contact_category'] = array(
72
    'title' => 'Edit contact category',
73
    'route_name' => 'contact_category_edit',
74 75 76 77
  );
  $items['admin/structure/contact/manage/%contact_category/edit'] = array(
    'title' => 'Edit',
    'type' => MENU_DEFAULT_LOCAL_TASK,
78
  );
79
  $items['admin/structure/contact/manage/%contact_category/delete'] = array(
80
    'title' => 'Delete',
81
    'route_name' => 'contact_category_delete',
82
    'type' => MENU_LOCAL_TASK,
83
    'weight' => 10,
84
  );
85

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

117
/**
118 119
 * Access callback: Checks access for a user's personal contact form.
 *
120
 * @param $account
121 122 123
 *   The user object of the user whose contact form is being requested.
 *
 * @see contact_menu()
124
 */
125
function _contact_personal_tab_access($account) {
126
  global $user;
127

128 129
  // Anonymous users cannot have contact forms.
  if (!$account->uid) {
130 131 132 133 134 135 136 137
    return FALSE;
  }

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

138 139 140 141 142
  // User administrators should always have access to personal contact forms.
  if (user_access('administer users')) {
    return TRUE;
  }

143 144
  // If requested user has been blocked, do not allow users to contact them.
  if (empty($account->status)) {
145 146 147
    return FALSE;
  }

148 149
  // If the requested user has disabled their contact form, do not allow users
  // to contact them.
150
  $account_data = Drupal::service('user.data')->get('contact', $account->id(), 'enabled');
151 152 153 154 155 156
  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')) {
157 158 159
    return FALSE;
  }

160
  return user_access('access user contact forms');
161 162
}

163
/**
164
 * Implements hook_entity_bundle_info().
165
 */
166 167
function contact_entity_bundle_info() {
  $bundles = array();
168 169
  foreach (config_get_storage_names_with_prefix('contact.category.') as $config_name) {
    $config = config($config_name);
170
    $bundles['contact_message'][$config->get('id')]['label'] = $config->get('label');
171
  }
172
  return $bundles;
173 174 175 176 177 178 179
}

/**
 * Implements hook_field_extra_fields().
 */
function contact_field_extra_fields() {
  $fields = array();
180
  foreach (array_keys(entity_get_bundles('contact_message')) as $bundle) {
181 182 183 184 185 186 187 188 189 190
    $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,
    );
191 192 193 194 195 196 197
    if ($bundle == 'personal') {
      $fields['contact_message'][$bundle]['form']['recipient'] = array(
        'label' => t('Recipient user name'),
        'description' => t('User'),
        'weight' => -30,
      );
    }
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
    $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,
    );
  }
220 221 222 223 224 225

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

229
/**
230
 * Loads a contact category.
231
 *
232 233
 * @param $id
 *   The ID of the contact category to load.
234
 *
235 236
 * @return \Drupal\contact\Plugin\Core\Entity\Category|null
 *   A Category object or NULL if the requested $id does not exist.
237
 */
238 239 240 241 242 243 244
function contact_category_load($id) {
  return entity_load('contact_category', $id);
}

/**
 * Entity URI callback.
 *
245
 * @param Drupal\contact\Plugin\Core\Entity\Category $category
246 247 248 249 250 251 252 253 254
 *   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(),
  );
255 256
}

257
/**
258
 * Implements hook_mail().
259 260
 */
function contact_mail($key, &$message, $params) {
261 262
  $contact_message = $params['contact_message'];
  $sender = $params['sender'];
263
  $language = language_load($message['langcode']);
264

265
  $variables = array(
266
    '!site-name' => config('system.site')->get('name'),
267 268
    '!subject' => $contact_message->getSubject(),
    '!category' => !empty($params['contact_category']) ? $params['contact_category']->label() : NULL,
269
    '!form-url' => url(current_path(), array('absolute' => TRUE, 'language' => $language)),
270
    '!sender-name' => user_format_name($sender),
271
  );
272 273 274 275 276 277 278 279
  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;
  }

280
  $options = array('langcode' => $language->id);
281

282 283 284
  switch ($key) {
    case 'page_mail':
    case 'page_copy':
285 286
      $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);
287
      $build = entity_view($contact_message, 'mail', $language->id);
288
      $message['body'][] = drupal_render($build);
289
      break;
290

291
    case 'page_autoreply':
292 293
      $message['subject'] .= t('[!category] !subject', $variables, $options);
      $message['body'][] = $params['contact_category']->reply;
294
      break;
295

296 297
    case 'user_mail':
    case 'user_copy':
298
      $variables += array(
299
        '!recipient-name' => user_format_name($params['recipient']),
300
        '!recipient-edit-url' => url('user/' . $params['recipient']->uid . '/edit', array('absolute' => TRUE, 'language' => $language)),
301
      );
302 303 304 305
      $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);
306
      $build = entity_view($contact_message, 'mail', $language->id);
307
      $message['body'][] = drupal_render($build);
308 309
      break;
  }
310
}
311

312
/**
313
 * Implements hook_form_FORM_ID_alter().
314 315
 *
 * Add the enable personal contact form to an individual user's account page.
316
 *
317
 * @see \Drupal\user\ProfileFormController::form()
318
 */
319
function contact_form_user_form_alter(&$form, &$form_state) {
320
  $form['contact'] = array(
321
    '#type' => 'details',
322 323 324
    '#title' => t('Contact settings'),
    '#weight' => 5,
  );
325
  $account = $form_state['controller']->getEntity();
326
  $account_data = !user_is_anonymous() ? Drupal::service('user.data')->get('contact', $account->id(), 'enabled') : NULL;
327 328 329
  $form['contact']['contact'] = array(
    '#type' => 'checkbox',
    '#title' => t('Personal contact form'),
330
    '#default_value' => isset($account_data) ? $account_data : config('contact.settings')->get('user_default_enabled'),
331
    '#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.'),
332
  );
333 334
}

335
/**
336
 * Implements hook_user_update().
337
 */
338 339
function contact_user_update($account) {
  if (isset($account->contact)) {
340
    Drupal::service('user.data')->set('contact', $account->id(), 'enabled', (int) $account->contact);
341
  }
342 343
}

344
/**
345
 * Implements hook_form_FORM_ID_alter().
346 347
 *
 * Add the default personal contact setting on the user settings page.
348 349
 *
 * @see user_admin_settings()
350
 */
351
function contact_form_user_admin_settings_alter(&$form, &$form_state) {
352
  $form['contact'] = array(
353
    '#type' => 'details',
354
    '#title' => t('Contact settings'),
355 356 357 358 359
    '#weight' => 0,
  );
  $form['contact']['contact_default_status'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable the personal contact form by default for new users.'),
360
    '#description' => t('Changing this setting will not affect existing users.'),
361
    '#default_value' => config('contact.settings')->get('user_default_enabled'),
362
  );
363 364 365 366 367 368 369 370 371 372 373 374 375
  // 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();
376
}