contact.module 10.2 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 9
use Drupal\Core\Routing\RouteMatchInterface;

Dries's avatar
 
Dries committed
10
/**
11
 * Implements hook_help().
Dries's avatar
 
Dries committed
12
 */
13
function contact_help($route_name, RouteMatchInterface $route_match) {
14 15
  switch ($route_name) {
    case 'help.page.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 email 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
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('User contact forms') . '</dt>';
22
      $output .= '<dd>' . t('Site users can be contacted with a user contact form that keeps their email 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>';
23
      $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). Email 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 32

    case 'contact.category_list':
33
      $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>';
34
      $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>';
35
      $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>';
36
      return $output;
Dries's avatar
 
Dries committed
37 38 39
  }
}

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

57
/**
58
 * Implements hook_entity_type_alter().
59
 */
60 61 62
function contact_entity_type_alter(array &$entity_types) {
  /** @var $entity_types \Drupal\Core\Entity\EntityTypeInterface[] */
  $entity_types['user']->setLinkTemplate('contact-form', 'contact.personal_page');
63 64
}

65
/**
66
 * Implements hook_entity_extra_field_info().
67
 */
68
function contact_entity_extra_field_info() {
69
  $fields = array();
70
  foreach (array_keys(entity_get_bundles('contact_message')) as $bundle) {
71 72 73 74 75 76
    $fields['contact_message'][$bundle]['form']['name'] = array(
      'label' => t('Sender name'),
      'description' => t('Text'),
      'weight' => -50,
    );
    $fields['contact_message'][$bundle]['form']['mail'] = array(
77 78
      'label' => t('Sender email'),
      'description' => t('Email'),
79 80
      'weight' => -40,
    );
81 82 83 84 85 86 87
    if ($bundle == 'personal') {
      $fields['contact_message'][$bundle]['form']['recipient'] = array(
        'label' => t('Recipient user name'),
        'description' => t('User'),
        'weight' => -30,
      );
    }
88 89 90 91 92 93
    $fields['contact_message'][$bundle]['form']['copy'] = array(
      'label' => t('Send copy to sender'),
      'description' => t('Option'),
      'weight' => 50,
    );
  }
94 95 96 97 98 99

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

103
/**
104
 * Implements hook_mail().
105 106
 */
function contact_mail($key, &$message, $params) {
107
  $contact_message = $params['contact_message'];
108
  /** @var $sender \Drupal\user\UserInterface */
109
  $sender = $params['sender'];
110
  $language = language_load($message['langcode']);
111

112
  $variables = array(
113
    '!site-name' => \Drupal::config('system.site')->get('name'),
114 115
    '!subject' => $contact_message->getSubject(),
    '!category' => !empty($params['contact_category']) ? $params['contact_category']->label() : NULL,
116
    '!form-url' => url(current_path(), array('absolute' => TRUE, 'language' => $language)),
117
    '!sender-name' => user_format_name($sender),
118
  );
119
  if ($sender->isAuthenticated()) {
120
    $variables['!sender-url'] = $sender->url('canonical', array('absolute' => TRUE, 'language' => $language));
121 122
  }
  else {
123
    $variables['!sender-url'] = $params['sender']->getEmail();
124 125
  }

126
  $options = array('langcode' => $language->id);
127

128 129 130
  switch ($key) {
    case 'page_mail':
    case 'page_copy':
131 132
      $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);
133
      $build = entity_view($contact_message, 'mail', $language->id);
134
      $message['body'][] = drupal_render($build);
135
      break;
136

137
    case 'page_autoreply':
138 139
      $message['subject'] .= t('[!category] !subject', $variables, $options);
      $message['body'][] = $params['contact_category']->reply;
140
      break;
141

142 143
    case 'user_mail':
    case 'user_copy':
144
      $variables += array(
145
        '!recipient-name' => user_format_name($params['recipient']),
146
        '!recipient-edit-url' => url('user/' . $params['recipient']->id() . '/edit', array('absolute' => TRUE, 'language' => $language)),
147
      );
148 149 150
      $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);
151
      $message['body'][] = t("If you don't want to receive such emails, you can change your settings at !recipient-edit-url.", $variables, $options);
152
      $build = entity_view($contact_message, 'mail', $language->id);
153
      $message['body'][] = drupal_render($build);
154 155
      break;
  }
156
}
157

158
/**
159
 * Implements hook_form_FORM_ID_alter().
160 161
 *
 * Add the enable personal contact form to an individual user's account page.
162
 *
163
 * @see \Drupal\user\ProfileForm::form()
164
 */
165
function contact_form_user_form_alter(&$form, &$form_state) {
166
  $form['contact'] = array(
167
    '#type' => 'details',
168
    '#title' => t('Contact settings'),
169
    '#open' => TRUE,
170 171
    '#weight' => 5,
  );
172
  $account = $form_state['controller']->getEntity();
173 174 175
  if (!\Drupal::currentUser()->isAnonymous() && $account->id()) {
    $account_data = \Drupal::service('user.data')->get('contact', $account->id(), 'enabled');
  }
176 177 178
  $form['contact']['contact'] = array(
    '#type' => 'checkbox',
    '#title' => t('Personal contact form'),
179
    '#default_value' => isset($account_data) ? $account_data : \Drupal::config('contact.settings')->get('user_default_enabled'),
180
    '#description' => t('Allow other users to contact you via a personal contact form which keeps your email 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.'),
181
  );
182
  $form['actions']['submit']['#submit'][] = 'contact_user_profile_form_submit';
183 184
}

185
/**
186
 * Submit callback for the user profile form to save the contact page setting.
187
 */
188 189 190
function contact_user_profile_form_submit($form, &$form_state) {
  $account = $form_state['controller']->getEntity();
  if ($account->id() && isset($form_state['values']['contact'])) {
191
    \Drupal::service('user.data')->set('contact', $account->id(), 'enabled', (int) $form_state['values']['contact']);
192
  }
193 194
}

195
/**
196
 * Implements hook_form_FORM_ID_alter().
197 198
 *
 * Add the default personal contact setting on the user settings page.
199 200
 *
 * @see user_admin_settings()
201
 */
202
function contact_form_user_admin_settings_alter(&$form, &$form_state) {
203
  $form['contact'] = array(
204
    '#type' => 'details',
205
    '#title' => t('Contact settings'),
206
    '#open' => TRUE,
207 208 209 210 211
    '#weight' => 0,
  );
  $form['contact']['contact_default_status'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable the personal contact form by default for new users.'),
212
    '#description' => t('Changing this setting will not affect existing users.'),
213
    '#default_value' => \Drupal::config('contact.settings')->get('user_default_enabled'),
214
  );
215 216 217 218 219 220 221 222 223 224
  // 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) {
225
  \Drupal::config('contact.settings')
226 227
    ->set('user_default_enabled', $form_state['values']['contact_default_status'])
    ->save();
228
}