contact.module

<?php

/**
 * @file
 * Enables the use of personal and site-wide contact forms.
 */
use Drupal\contact\Plugin\Core\Entity\Category;

/**
 * Implements hook_help().
 */
function contact_help($path, $arg) {
  switch ($path) {
    case 'admin/help#contact':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $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>';
      $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>';
      $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>';
      $output .= '<dt>' . t('Navigation') . '</dt>';
      $output .= '<dd>' . t('When the site-wide contact form is enabled, a link in the <em>Main 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(
        '@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>';
      $output .= '</dl>';
      return $output;
    case 'admin/structure/contact':
      $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 Tools 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>';
      return $output;
  }
}

/**
 * Implements hook_permission().
 */
function contact_permission() {
  return array(
    'administer contact forms' => array(
      'title' => t('Administer contact forms and contact form settings'),
    ),
    'access site-wide contact form' => array(
      'title' => t('Use the site-wide contact form'),
    ),
    'access user contact forms' => array(
      'title' => t("Use users' personal contact forms"),
    ),
  );
}

/**
 * Implements hook_menu().
 */
function contact_menu() {
  $items['admin/structure/contact'] = array(
    'title' => 'Contact form',
    'description' => 'Create a system contact form and set up categories for the form to use.',
    'page callback' => 'contact_category_list',
    'access arguments' => array(
      'administer contact forms',
    ),
    'file' => 'contact.admin.inc',
  );
  $items['admin/structure/contact/add'] = array(
    'title' => 'Add category',
    'page callback' => 'contact_category_add',
    'access arguments' => array(
      'administer contact forms',
    ),
    'type' => MENU_LOCAL_ACTION,
    'weight' => 1,
    'file' => 'contact.admin.inc',
  );
  $items['admin/structure/contact/manage/%contact_category'] = array(
    'title' => 'Edit contact category',
    'page callback' => 'contact_category_edit',
    'page arguments' => array(
      4,
    ),
    'access arguments' => array(
      'administer contact forms',
    ),
    'file' => 'contact.admin.inc',
  );
  $items['admin/structure/contact/manage/%contact_category/edit'] = array(
    'title' => 'Edit',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/structure/contact/manage/%contact_category/delete'] = array(
    'title' => 'Delete',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'contact_category_delete_form',
      4,
    ),
    'access arguments' => array(
      'administer contact forms',
    ),
    'type' => MENU_LOCAL_TASK,
    'file' => 'contact.admin.inc',
  );
  $items['contact'] = array(
    'title' => 'Contact',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'contact_site_form',
    ),
    'access arguments' => array(
      'access site-wide contact form',
    ),
    'menu_name' => 'footer',
    'type' => MENU_SUGGESTED_ITEM,
    'file' => 'contact.pages.inc',
  );
  $items['user/%user/contact'] = array(
    'title' => 'Contact',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'contact_personal_form',
      1,
    ),
    'type' => MENU_LOCAL_TASK,
    'access callback' => '_contact_personal_tab_access',
    'access arguments' => array(
      1,
    ),
    'weight' => 2,
    'file' => 'contact.pages.inc',
  );
  return $items;
}

/**
 * Access callback: Checks access for a user's personal contact form.
 *
 * @param $account
 *   The user object of the user whose contact form is being requested.
 *
 * @see contact_menu()
 */
function _contact_personal_tab_access($account) {
  global $user;

  // Anonymous users cannot have contact forms.
  if (!$account->uid) {
    return FALSE;
  }

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

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

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

  // If the requested user has disabled their contact form, do not allow users
  // to contact them.
  $account_data = drupal_container()
    ->get('user.data')
    ->get('contact', $account
    ->id(), 'enabled');
  if (isset($account_data) && empty($account_data)) {
    return FALSE;
  }
  elseif (!config('contact.settings')
    ->get('user_default_enabled')) {
    return FALSE;
  }
  return user_access('access user contact forms');
}

/**
 * Implements MODULE_config_import_create().
 */
function contact_config_import_create($name, $new_config, $old_config) {
  if (strpos($name, 'contact.category.') !== 0) {
    return FALSE;
  }
  $category = entity_create('contact_category', $new_config
    ->get());
  $category
    ->save();
  return TRUE;
}

/**
 * Implements MODULE_config_import_change().
 */
function contact_config_import_change($name, $new_config, $old_config) {
  if (strpos($name, 'contact.category.') !== 0) {
    return FALSE;
  }
  list(, , $id) = explode('.', $name);
  $category = entity_load('contact_category', $id);
  $category->original = clone $category;
  foreach ($old_config
    ->get() as $property => $value) {
    $category->original->{$property} = $value;
  }
  foreach ($new_config
    ->get() as $property => $value) {
    $category->{$property} = $value;
  }
  $category
    ->save();
  return TRUE;
}

/**
 * Implements MODULE_config_import_delete().
 */
function contact_config_import_delete($name, $new_config, $old_config) {
  if (strpos($name, 'contact.category.') !== 0) {
    return FALSE;
  }
  list(, , $id) = explode('.', $name);
  entity_delete_multiple('contact_category', array(
    $id,
  ));
  return TRUE;
}

/**
 * Loads a contact category.
 *
 * @param $id
 *   The ID of the contact category to load.
 *
 * @return Drupal\contact\Plugin\Core\Entity\Category|false
 *   A Category object or FALSE if the requested $id does not exist.
 */
function contact_category_load($id) {
  return entity_load('contact_category', $id);
}

/**
 * Entity URI callback.
 *
 * @param Drupal\contact\Plugin\Core\Entity\Category $category
 *   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(),
  );
}

/**
 * Implements hook_mail().
 */
function contact_mail($key, &$message, $params) {
  $language = language_load($message['langcode']);
  $variables = array(
    '!site-name' => config('system.site')
      ->get('name'),
    '!subject' => $params['subject'],
    '!category' => isset($params['category']) ? $params['category']
      ->label() : '',
    '!form-url' => url(current_path(), array(
      'absolute' => TRUE,
      'language' => $language,
    )),
    '!sender-name' => user_format_name($params['sender']),
    '!sender-url' => $params['sender']->uid ? url('user/' . $params['sender']->uid, array(
      'absolute' => TRUE,
      'language' => $language,
    )) : $params['sender']->mail,
  );
  switch ($key) {
    case 'page_mail':
    case 'page_copy':
      $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,
      ));
      $message['body'][] = $params['message'];
      break;
    case 'page_autoreply':
      $message['subject'] .= t('[!category] !subject', $variables, array(
        'langcode' => $language->langcode,
      ));
      $message['body'][] = $params['category']->reply;
      break;
    case 'user_mail':
    case 'user_copy':
      $variables += array(
        '!recipient-name' => user_format_name($params['recipient']),
        '!recipient-edit-url' => url('user/' . $params['recipient']->uid . '/edit', array(
          'absolute' => TRUE,
          'language' => $language,
        )),
      );
      $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 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,
      ));
      $message['body'][] = $params['message'];
      break;
  }
}

/**
 * Implements hook_form_FORM_ID_alter().
 *
 * Add the enable personal contact form to an individual user's account page.
 *
 * @see user_profile_form()
 */
function contact_form_user_profile_form_alter(&$form, &$form_state) {
  $form['contact'] = array(
    '#type' => 'details',
    '#title' => t('Contact settings'),
    '#weight' => 5,
    '#collapsible' => TRUE,
  );
  $account = $form_state['controller']
    ->getEntity($form_state);
  $account_data = drupal_container()
    ->get('user.data')
    ->get('contact', $account
    ->id(), 'enabled');
  $form['contact']['contact'] = array(
    '#type' => 'checkbox',
    '#title' => t('Personal contact form'),
    '#default_value' => isset($account_data) ? $account_data : config('contact.settings')
      ->get('user_default_enabled'),
    '#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.'),
  );
}

/**
 * Implements hook_user_update().
 */
function contact_user_update($account) {
  if (isset($account->contact)) {
    drupal_container()
      ->get('user.data')
      ->set('contact', $account
      ->id(), 'enabled', (int) $account->contact);
  }
}

/**
 * Implements hook_form_FORM_ID_alter().
 *
 * Add the default personal contact setting on the user settings page.
 *
 * @see user_admin_settings()
 */
function contact_form_user_admin_settings_alter(&$form, &$form_state) {
  $form['contact'] = array(
    '#type' => 'details',
    '#title' => t('Contact settings'),
    '#weight' => 0,
  );
  $form['contact']['contact_default_status'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable the personal contact form by default for new users.'),
    '#description' => t('Changing this setting will not affect existing users.'),
    '#default_value' => config('contact.settings')
      ->get('user_default_enabled'),
  );

  // 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();
}