og_ui.pages.inc in Organic groups 7

Page callbacks for Group module.

File

og_ui/og_ui.pages.inc

<?php

/**
 * @file
 * Page callbacks for Group module.
 */

/**
 * Manage user subscription to a group.
 *
 * @param $node
 *   The group node entity.
 * @param $uid
 *   Optional; The user ID of the subscribing user. If empty the current user
 *   will be used.
 */
function og_ui_subscribe($entity_type, $etid, $uid = NULL) {
  global $user;
  if ($group = og_get_group($entity_type, $etid)) {
    if (empty($uid)) {
      $account = clone $user;
      if (!$account->uid) {
        $dest = drupal_get_destination();
        if (variable_get('user_register', 1)) {
          drupal_set_message(t('In order to join any group, you must <a href="!login">login</a>. After you have successfully done so, you will need to request membership again.', array(
            '!login' => url("user/login", array(
              'query' => $dest,
            )),
          )));
        }
        else {
          drupal_set_message(t('In order to join any group, you must <a href="!login">login</a> or <a href="!register">register</a> a new account. After you have successfully done so, you will need to request membership again.', array(
            '!register' => url("user/register", array(
              'query' => $dest,
            )),
            '!login' => url("user/login", array(
              'query' => $dest,
            )),
          )));
        }
        drupal_goto('user');
      }
    }
    else {
      $account = user_load($uid);
    }
    $entity = entity_load($entity_type, array(
      $etid,
    ));
    $entity = reset($entity);
    $redirect = FALSE;
    $params = array(
      '@user' => format_username($account),
      // TODO: check user has permissions to see label (e.g. node title).
      '@group' => og_entity_label($entity_type, $entity),
    );
    if (og_is_member($group->gid, 'user', $account, array(
      OG_STATE_BLOCKED,
    ))) {

      // User is blocked, give them access denied.
      drupal_access_denied();
    }
    if (og_is_member($group->gid, 'user', $account, array(
      OG_STATE_PENDING,
    ))) {

      // User is pending, return them back.
      $message = $account->uid == $user->uid ? t('You already have a pending membership for the group @group.', $params) : t('@user already has a pending membership for the  the group @group.', $params);
      $redirect = TRUE;
    }
    if (og_is_member($group->gid, 'user', $account, array(
      OG_STATE_ACTIVE,
    ))) {

      // User is already a member, return them back.
      $message = $account->uid == $user->uid ? t('You are already a member of the group @group.', $params) : t('@user is already a member of the group @group.', $params);
      $redirect = TRUE;
    }
    if (!empty($message)) {
      drupal_set_message($message);
    }
    if ($redirect) {
      _group_ui_redirect($entity_type, $entity);
    }
    if (og_user_access($group->gid, 'subscribe', $account) || og_user_access($group->gid, 'subscribe without approval', $account)) {

      // Show the user a subscription confirmation.
      return drupal_get_form('og_ui_confirm_subscribe', $group, $account);
    }
    drupal_access_denied();
  }

  // Not a valid group node.
  drupal_not_found();
}

/**
 * Confirm subscribe form.
 */
function og_ui_confirm_subscribe($form, &$form_state, $group, $account) {
  $form['group'] = array(
    '#type' => 'value',
    '#value' => $group,
  );
  $form['account'] = array(
    '#type' => 'value',
    '#value' => $account,
  );

  // Add group membership form.
  // TODO: We need to associate a group membership with group?
  $type = OG_MEMBERSHIP_TYPE_DEFAULT;
  $form['membership_type'] = array(
    '#type' => 'value',
    '#value' => $type,
  );
  $dummy_entity = og_membership_create(0, 'user', 0, array(
    'type' => $type,
  ));
  $form['membership_fields'] = array(
    '#prefix' => '<div id="og-ui-membership-type">',
    '#suffix' => '</div>',
    '#tree' => TRUE,
    '#parents' => array(
      'membership_fields',
    ),
  );
  field_attach_form('og_membership', $dummy_entity, $form['membership_fields'], $form_state);
  if (og_user_access($group->gid, 'subscribe without approval')) {

    // Hide the user request field.
    if (!empty($form['membership_fields'][OG_MEMBERSHIP_REQUEST_FIELD])) {
      $form['membership_fields'][OG_MEMBERSHIP_REQUEST_FIELD]['#access'] = FALSE;
    }
  }
  $label = og_label($group->gid);
  return confirm_form($form, t('Are you sure you want to join the group %title?', array(
    '%title' => $label,
  )), "{$group->entity_type}/{$group->etid}", ' ', t('Join'), t('Cancel'));
}

/**
 * Submit handler; Confirm OG membership.
 */
function og_ui_confirm_subscribe_validate($form, &$form_state) {

  // @see entity_form_field_validate().
  $dummy_entity = new stdClass();
  if (!empty($form_state['values']['membership_fields'])) {
    $dummy_entity = (object) $form_state['values']['membership_fields'];
  }
  $dummy_entity->type = $form_state['values']['membership_type'];
  field_attach_form_validate('og_membership', $dummy_entity, $form['membership_fields'], $form_state);
}

/**
 * Submit handler; Confirm OG membership.
 */
function og_ui_confirm_subscribe_submit($form, &$form_state) {
  $group = $form_state['values']['group'];
  $account = $form_state['values']['account'];
  $state = og_user_access($group->gid, 'subscribe without approval') ? OG_STATE_ACTIVE : OG_STATE_PENDING;
  $values = array(
    'entity' => $account,
    'state' => $state,
    'membership type' => $form_state['values']['membership_type'],
    'membership fields' => $form_state['values']['membership_fields'],
  );
  og_group($group->gid, $values);

  // Redirect.
  $form_state['redirect'] = "{$group->entity_type}/{$group->etid}";
}

/**
 * Confirm OG unsubscription form.
 *
 * The unsubscribing user is always the acting user - like this we make sure
 * no malicious user will unsubscribe another user. Administrators can reject or
 * ban another group member from the "people" page.
 */
function og_ui_unsubscribe($entity_type, $etid) {
  if ($group = og_get_group($entity_type, $etid)) {
    global $user;
    $label = og_label($group->gid);

    // Check the user isn't the manager of the group.
    $manager = $group
      ->user();
    if ($manager->uid != $user->uid) {
      $account = clone $user;
      if (og_is_member($group->gid, 'user', $account, array(
        OG_STATE_ACTIVE,
        OG_STATE_PENDING,
      ))) {

        // Show the user a subscription confirmation.
        return drupal_get_form('og_ui_confirm_unsubscribe', $group, $account);
      }
    }
    else {
      drupal_set_message(t('As the manager of %group, you can not leave the group.', array(
        '%group' => $label,
      )));
    }
    $entity = $group
      ->getEntity();
    _group_ui_redirect($group->entity_type, $entity);
  }

  // Not a valid group.
  drupal_not_found();
}

/**
 * Helper function; Redirect back to entity, if access is allowed.
 *
 * @param $entity_type
 * @param $entity
 * @return unknown_type
 */
function _group_ui_redirect($entity_type, $entity, $account = NULL) {

  // Redirect back to entity, if access is allowed. Access is checked only
  // for nodes.
  $uri = array();
  if ($entity_type == 'node') {
    if (!node_access('view', $entity, $account)) {
      $uri = array(
        'path' => '<front>',
        'options' => array(),
      );
    }
  }
  if (!$uri) {
    $uri = entity_uri($entity_type, $entity);
  }
  drupal_goto($uri['path'], $uri['options']);
}

/**
 * Confirm unsubscribe form.
 */
function og_ui_confirm_unsubscribe($form, &$form_state, $group, $account) {
  $form['group'] = array(
    '#type' => 'value',
    '#value' => $group,
  );
  $form['account'] = array(
    '#type' => 'value',
    '#value' => $account,
  );
  $label = og_label($group->gid);
  return confirm_form($form, t('Are you sure you want to unsubscribe from the group %title?', array(
    '%title' => $label,
  )), "{$group->entity_type}/{$group->etid}", ' ', t('Remove'), t('Cancel'));
}

/**
 * Submit handler; Confirm OG unsubscription.
 */
function og_ui_confirm_unsubscribe_submit($form, &$form_state) {
  $group = $form_state['values']['group'];
  $account = $form_state['values']['account'];
  og_ungroup($group->gid, 'user', $account);

  // TODO: Determine where to go next - Group if accessible, or else site front
  // page.
  $form_state['redirect'] = "{$group->entity_type}/{$group->etid}";
}

Functions

Name	Description
og_ui_confirm_subscribe	Confirm subscribe form.
og_ui_confirm_subscribe_submit	Submit handler; Confirm OG membership.
og_ui_confirm_subscribe_validate	Submit handler; Confirm OG membership.
og_ui_confirm_unsubscribe	Confirm unsubscribe form.
og_ui_confirm_unsubscribe_submit	Submit handler; Confirm OG unsubscription.
og_ui_subscribe	Manage user subscription to a group.
og_ui_unsubscribe	Confirm OG unsubscription form.
_group_ui_redirect	Helper function; Redirect back to entity, if access is allowed.