contact.module 11.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
 * 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/handbook/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 112
 * Access callback: Checks access for a user's personal contact form.
 *
 * Path: user/%user/contact
113 114
 *
 * @param $account
115 116 117
 *   The user object of the user whose contact form is being requested.
 *
 * @see contact_menu()
118
 */
119
function _contact_personal_tab_access($account) {
120
  global $user;
121

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

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

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

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

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

148
  return user_access('access user contact forms');
149 150
}

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

169
/**
170
 * Implements hook_mail().
171 172 173
 */
function contact_mail($key, &$message, $params) {
  $language = $message['language'];
174 175 176
  $variables = array(
    '!site-name' => variable_get('site_name', 'Drupal'),
    '!subject' => $params['subject'],
177
    '!category' => isset($params['category']['category']) ? $params['category']['category'] : '',
178
    '!form-url' => url($_GET['q'], array('absolute' => TRUE, 'language' => $language)),
179
    '!sender-name' => format_username($params['sender']),
180
    '!sender-url' => $params['sender']->uid ? url('user/' . $params['sender']->uid, array('absolute' => TRUE, 'language' => $language)) : $params['sender']->mail,
181 182
  );

183 184 185
  switch ($key) {
    case 'page_mail':
    case 'page_copy':
186 187
      $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));
188 189
      $message['body'][] = $params['message'];
      break;
190

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

196 197
    case 'user_mail':
    case 'user_copy':
198
      $variables += array(
199
        '!recipient-name' => format_username($params['recipient']),
200
        '!recipient-edit-url' => url('user/' . $params['recipient']->uid . '/edit', array('absolute' => TRUE, 'language' => $language)),
201
      );
202 203 204 205 206
      $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));
207 208 209
      $message['body'][] = $params['message'];
      break;
  }
210
}
211

212
/**
213
 * Implements hook_form_FORM_ID_alter().
214 215
 *
 * Add the enable personal contact form to an individual user's account page.
216 217
 *
 * @see user_profile_form()
218 219
 */
function contact_form_user_profile_form_alter(&$form, &$form_state) {
220 221 222 223 224 225 226 227 228 229 230 231 232
  $form['contact'] = array(
    '#type' => 'fieldset',
    '#title' => t('Contact settings'),
    '#weight' => 5,
    '#collapsible' => TRUE,
  );
  $account = $form['#user'];
  $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"))),
  );
233 234
}

235 236 237
/**
 * Implements hook_user_presave().
 */
238
function contact_user_presave(&$edit, $account) {
239 240 241
  $edit['data']['contact'] = isset($edit['contact']) ? $edit['contact'] : variable_get('contact_default_status', 1);
}

242
/**
243
 * Implements hook_form_FORM_ID_alter().
244 245
 *
 * Add the default personal contact setting on the user settings page.
246 247
 *
 * @see user_admin_settings()
248
 */
249
function contact_form_user_admin_settings_alter(&$form, &$form_state) {
250 251
  $form['contact'] = array(
    '#type' => 'fieldset',
252
    '#title' => t('Contact settings'),
253 254 255 256 257
    '#weight' => 0,
  );
  $form['contact']['contact_default_status'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable the personal contact form by default for new users.'),
258
    '#description' => t('Changing this setting will not affect existing users.'),
259
    '#default_value' => variable_get('contact_default_status', 1),
260 261
  );
}