contact.module 11.7 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 25 26
      $output .= '<dd>' . t("When the site-wide contact form is enabled, a link in the main <em>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('@contact' => url('contact'), '@menu' => url('admin/structure/menu'))) . '</dd>';
      $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 31 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>';
      $output .= '<p>' . t('A <em>Contact</em> menu item (disabled by default) is added to the Navigation menu, which you can modify on the <a href="@menu-settings">Menus administration page</a>.', array('@menu-settings' => url('admin/structure/menu'))) . '</p>';
      $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

Dries's avatar
 
Dries committed
54
/**
55
 * Implements hook_menu().
Dries's avatar
 
Dries committed
56
 */
57
function contact_menu() {
58
  $items['admin/structure/contact'] = array(
59 60
    'title' => 'Contact form',
    'description' => 'Create a system contact form and set up categories for the form to use.',
61
    'page callback' => 'contact_category_list',
62
    'access arguments' => array('administer contact forms'),
63
    'file' => 'contact.admin.inc',
64
  );
65
  $items['admin/structure/contact/add'] = array(
66
    'title' => 'Add category',
67
    'page callback' => 'drupal_get_form',
68
    'page arguments' => array('contact_category_edit_form'),
69
    'access arguments' => array('administer contact forms'),
70
    'type' => MENU_LOCAL_ACTION,
71
    'weight' => 1,
72
    'file' => 'contact.admin.inc',
73
  );
74
  $items['admin/structure/contact/edit/%contact'] = array(
75
    'title' => 'Edit contact category',
76
    'page callback' => 'drupal_get_form',
77
    'page arguments' => array('contact_category_edit_form', 4),
78
    'access arguments' => array('administer contact forms'),
79
    'file' => 'contact.admin.inc',
80
  );
81
  $items['admin/structure/contact/delete/%contact'] = array(
82
    'title' => 'Delete contact',
83
    'page callback' => 'drupal_get_form',
84
    'page arguments' => array('contact_category_delete_form', 4),
85
    'access arguments' => array('administer contact forms'),
86
    'file' => 'contact.admin.inc',
87 88
  );
  $items['contact'] = array(
89
    'title' => 'Contact',
90 91
    'page callback' => 'drupal_get_form',
    'page arguments' => array('contact_site_form'),
92 93
    'access arguments' => array('access site-wide contact form'),
    'type' => MENU_SUGGESTED_ITEM,
94
    'file' => 'contact.pages.inc',
95
  );
96
  $items['user/%user/contact'] = array(
97
    'title' => 'Contact',
98 99
    'page callback' => 'drupal_get_form',
    'page arguments' => array('contact_personal_form', 1),
100
    'type' => MENU_LOCAL_TASK,
101
    'access callback' => '_contact_personal_tab_access',
102 103
    'access arguments' => array(1),
    'weight' => 2,
104
    'file' => 'contact.pages.inc',
105
  );
Dries's avatar
 
Dries committed
106 107 108
  return $items;
}

109
/**
110 111
 * Access callback: Checks access for a user's personal contact form.
 *
112
 * @param $account
113 114 115
 *   The user object of the user whose contact form is being requested.
 *
 * @see contact_menu()
116
 */
117
function _contact_personal_tab_access($account) {
118
  global $user;
119

120 121
  // Anonymous users cannot have contact forms.
  if (!$account->uid) {
122 123 124 125 126 127 128 129
    return FALSE;
  }

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

130 131 132 133 134
  // User administrators should always have access to personal contact forms.
  if (user_access('administer users')) {
    return TRUE;
  }

135 136
  // If the requested user has disabled their contact form, or this preference
  // has not yet been saved, do not allow users to contact them.
137
  if (empty($account->data['contact'])) {
138 139 140
    return FALSE;
  }

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

146
  return user_access('access user contact forms');
147 148
}

149
/**
150
 * Loads a contact category.
151 152 153
 *
 * @param $cid
 *   The contact category ID.
154
 *
155 156
 * @return
 *   An array with the contact category's data.
157 158
 */
function contact_load($cid) {
159 160 161 162 163 164
  return db_select('contact', 'c')
    ->addTag('translatable')
    ->fields('c')
    ->condition('cid', $cid)
    ->execute()
    ->fetchAssoc();
165 166
}

167
/**
168
 * Implements hook_mail().
169 170
 */
function contact_mail($key, &$message, $params) {
171
  $language = language_load($message['langcode']);
172
  $variables = array(
173
    '!site-name' => config('system.site')->get('name'),
174
    '!subject' => $params['subject'],
175
    '!category' => isset($params['category']['category']) ? $params['category']['category'] : '',
176
    '!form-url' => url(current_path(), array('absolute' => TRUE, 'language' => $language)),
177
    '!sender-name' => user_format_name($params['sender']),
178
    '!sender-url' => $params['sender']->uid ? url('user/' . $params['sender']->uid, array('absolute' => TRUE, 'language' => $language)) : $params['sender']->mail,
179 180
  );

181 182 183
  switch ($key) {
    case 'page_mail':
    case 'page_copy':
184 185
      $message['subject'] .= t('[!category] !subject', $variables, array('langcode' => $language->langcode));
      $message['body'][] = t("!sender-name (!sender-url) sent a message using the contact form at !form-url.", $variables, array('langcode' => $language->langcode));
186 187
      $message['body'][] = $params['message'];
      break;
188

189
    case 'page_autoreply':
190
      $message['subject'] .= t('[!category] !subject', $variables, array('langcode' => $language->langcode));
191
      $message['body'][] = $params['category']['reply'];
192
      break;
193

194 195
    case 'user_mail':
    case 'user_copy':
196
      $variables += array(
197
        '!recipient-name' => user_format_name($params['recipient']),
198
        '!recipient-edit-url' => url('user/' . $params['recipient']->uid . '/edit', array('absolute' => TRUE, 'language' => $language)),
199
      );
200 201 202 203 204
      $message['subject'] .= t('[!site-name] !subject', $variables, array('langcode' => $language->langcode));
      $message['body'][] = t('Hello !recipient-name,', $variables, array('langcode' => $language->langcode));
      $message['body'][] = t("!sender-name (!sender-url) has sent you a message via your contact form (!form-url) at !site-name.", $variables, array('langcode' => $language->langcode));
      $message['body'][] = t("If you don't want to receive such e-mails, you can change your settings at !recipient-edit-url.", $variables, array('langcode' => $language->langcode));
      $message['body'][] = t('Message:', array(), array('langcode' => $language->langcode));
205 206 207
      $message['body'][] = $params['message'];
      break;
  }
208
}
209

210
/**
211
 * Implements hook_form_FORM_ID_alter().
212 213
 *
 * Add the enable personal contact form to an individual user's account page.
214 215
 *
 * @see user_profile_form()
216 217
 */
function contact_form_user_profile_form_alter(&$form, &$form_state) {
218 219 220 221 222 223
  $form['contact'] = array(
    '#type' => 'fieldset',
    '#title' => t('Contact settings'),
    '#weight' => 5,
    '#collapsible' => TRUE,
  );
224
  $account = $form_state['controller']->getEntity($form_state);
225 226 227 228 229 230
  $form['contact']['contact'] = array(
    '#type' => 'checkbox',
    '#title' => t('Personal contact form'),
    '#default_value' => !empty($account->data['contact']) ? $account->data['contact'] : FALSE,
    '#description' => t('Allow other users to contact you via a <a href="@url">personal contact form</a> 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.', array('@url' => url("user/$account->uid/contact"))),
  );
231 232
}

233 234 235
/**
 * Implements hook_user_presave().
 */
236
function contact_user_presave($account) {
237
  $account->data['contact'] = isset($account->contact) ? $account->contact : config('contact.settings')->get('user_default_enabled');
238 239
}

240
/**
241
 * Implements hook_form_FORM_ID_alter().
242 243
 *
 * Add the default personal contact setting on the user settings page.
244 245
 *
 * @see user_admin_settings()
246
 */
247
function contact_form_user_admin_settings_alter(&$form, &$form_state) {
248 249
  $form['contact'] = array(
    '#type' => 'fieldset',
250
    '#title' => t('Contact settings'),
251 252 253 254 255
    '#weight' => 0,
  );
  $form['contact']['contact_default_status'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable the personal contact form by default for new users.'),
256
    '#description' => t('Changing this setting will not affect existing users.'),
257
    '#default_value' => config('contact.settings')->get('user_default_enabled'),
258
  );
259 260 261 262 263 264 265 266 267 268 269 270 271
  // 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();
272
}