contact.module 11.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
 */

/**
9
 * Implements hook_help().
Dries's avatar
 
Dries committed
10
 */
11 12
function contact_help($path, $arg) {
  switch ($path) {
13
    case 'admin/help#contact':
14 15
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
16
      $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>';
17 18 19 20 21
      $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>';
22
      $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>';
23
      $output .= '<dt>' . t('Navigation') . '</dt>';
24
      $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>';
25 26
      $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>';
27
      $output .= '</dl>';
28
      return $output;
29
    case 'admin/structure/contact':
30
      $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>';
31
      $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>';
32
      $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>';
33
      return $output;
Dries's avatar
 
Dries committed
34 35 36
  }
}

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

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

62
/**
63
 * Implements hook_entity_bundle_info().
64
 */
65 66
function contact_entity_bundle_info() {
  $bundles = array();
67
  foreach (\Drupal::configFactory()->listAll('contact.category.') as $config_name) {
68
    $config = \Drupal::config($config_name);
69
    $bundles['contact_message'][$config->get('id')]['label'] = $config->get('label');
70
  }
71
  return $bundles;
72 73 74
}

/**
75
 * Implements hook_entity_extra_field_info().
76
 */
77
function contact_entity_extra_field_info() {
78
  $fields = array();
79
  foreach (array_keys(entity_get_bundles('contact_message')) as $bundle) {
80 81 82 83 84 85 86 87 88 89
    $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,
    );
90 91 92 93 94 95 96
    if ($bundle == 'personal') {
      $fields['contact_message'][$bundle]['form']['recipient'] = array(
        'label' => t('Recipient user name'),
        'description' => t('User'),
        'weight' => -30,
      );
    }
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
    $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,
    );
  }
119 120 121 122 123 124

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

128
/**
129
 * Loads a contact category.
130
 *
131 132
 * @param $id
 *   The ID of the contact category to load.
133
 *
134
 * @return \Drupal\contact\Entity\Category|null
135
 *   A Category object or NULL if the requested $id does not exist.
136
 */
137 138 139 140
function contact_category_load($id) {
  return entity_load('contact_category', $id);
}

141
/**
142
 * Implements hook_mail().
143 144
 */
function contact_mail($key, &$message, $params) {
145
  $contact_message = $params['contact_message'];
146
  /** @var $sender \Drupal\user\UserInterface */
147
  $sender = $params['sender'];
148
  $language = language_load($message['langcode']);
149

150
  $variables = array(
151
    '!site-name' => \Drupal::config('system.site')->get('name'),
152 153
    '!subject' => $contact_message->getSubject(),
    '!category' => !empty($params['contact_category']) ? $params['contact_category']->label() : NULL,
154
    '!form-url' => url(current_path(), array('absolute' => TRUE, 'language' => $language)),
155
    '!sender-name' => user_format_name($sender),
156
  );
157
  if ($sender->isAuthenticated()) {
158
    $variables['!sender-url'] = $sender->url('canonical', array('absolute' => TRUE, 'language' => $language));
159 160
  }
  else {
161
    $variables['!sender-url'] = $params['sender']->getEmail();
162 163
  }

164
  $options = array('langcode' => $language->id);
165

166 167 168
  switch ($key) {
    case 'page_mail':
    case 'page_copy':
169 170
      $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);
171
      $build = entity_view($contact_message, 'mail', $language->id);
172
      $message['body'][] = drupal_render($build);
173
      break;
174

175
    case 'page_autoreply':
176 177
      $message['subject'] .= t('[!category] !subject', $variables, $options);
      $message['body'][] = $params['contact_category']->reply;
178
      break;
179

180 181
    case 'user_mail':
    case 'user_copy':
182
      $variables += array(
183
        '!recipient-name' => user_format_name($params['recipient']),
184
        '!recipient-edit-url' => url('user/' . $params['recipient']->id() . '/edit', array('absolute' => TRUE, 'language' => $language)),
185
      );
186 187 188 189
      $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);
190
      $build = entity_view($contact_message, 'mail', $language->id);
191
      $message['body'][] = drupal_render($build);
192 193
      break;
  }
194
}
195

196
/**
197
 * Implements hook_form_FORM_ID_alter().
198 199
 *
 * Add the enable personal contact form to an individual user's account page.
200
 *
201
 * @see \Drupal\user\ProfileFormController::form()
202
 */
203
function contact_form_user_form_alter(&$form, &$form_state) {
204
  $form['contact'] = array(
205
    '#type' => 'details',
206
    '#title' => t('Contact settings'),
207
    '#open' => TRUE,
208 209
    '#weight' => 5,
  );
210
  $account = $form_state['controller']->getEntity();
211
  $account_data = !\Drupal::currentUser()->isAnonymous() ? \Drupal::service('user.data')->get('contact', $account->id(), 'enabled') : NULL;
212 213 214
  $form['contact']['contact'] = array(
    '#type' => 'checkbox',
    '#title' => t('Personal contact form'),
215
    '#default_value' => isset($account_data) ? $account_data : \Drupal::config('contact.settings')->get('user_default_enabled'),
216
    '#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.'),
217
  );
218
  $form['actions']['submit']['#submit'][] = 'contact_user_profile_form_submit';
219 220
}

221
/**
222
 * Submit callback for the user profile form to save the contact page setting.
223
 */
224 225 226
function contact_user_profile_form_submit($form, &$form_state) {
  $account = $form_state['controller']->getEntity();
  if ($account->id() && isset($form_state['values']['contact'])) {
227
    \Drupal::service('user.data')->set('contact', $account->id(), 'enabled', (int) $form_state['values']['contact']);
228
  }
229 230
}

231
/**
232
 * Implements hook_form_FORM_ID_alter().
233 234
 *
 * Add the default personal contact setting on the user settings page.
235 236
 *
 * @see user_admin_settings()
237
 */
238
function contact_form_user_admin_settings_alter(&$form, &$form_state) {
239
  $form['contact'] = array(
240
    '#type' => 'details',
241
    '#title' => t('Contact settings'),
242
    '#open' => TRUE,
243 244 245 246 247
    '#weight' => 0,
  );
  $form['contact']['contact_default_status'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable the personal contact form by default for new users.'),
248
    '#description' => t('Changing this setting will not affect existing users.'),
249
    '#default_value' => \Drupal::config('contact.settings')->get('user_default_enabled'),
250
  );
251 252 253 254 255 256 257 258 259 260
  // 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) {
261
  \Drupal::config('contact.settings')
262 263
    ->set('user_default_enabled', $form_state['values']['contact_default_status'])
    ->save();
264
}