fb_example.module in Drupal for Facebook 7.3

Example customizations to modules/fb.

The code in this module provides example of common customizations to modules/fb. The code found here is used on http://drupalforfacebook.org. Feel free to enable this module if you want your site to behave in just the same way. However, advanced Drupal developers may be better served copying these examples into their own module, and customizing as needed.

File

contrib/fb_example.module

<?php

/**
 * @file
 * Example customizations to modules/fb.
 *
 * The code in this module provides example of common customizations to
 * modules/fb.  The code found here is used on http://drupalforfacebook.org.
 * Feel free to enable this module if you want your site to behave in just the
 * same way.  However, advanced Drupal developers may be better served copying
 * these examples into their own module, and customizing as needed.
 */

/**
 * Implements hook_form_alter().
 *
 * Adds a checkbox to node edit and comment forms.  This checkbox lets
 * facebook users know that content may be published to their Wall,
 * and gives them a chance to prevent that.
 */
function fb_example_form_alter(&$form, $form_state, $form_id) {

  // Add stream publish option.
  if (isset($GLOBALS['_fb']) && fb_facebook_user() && variable_get('fb_example_stream_form_alter', TRUE) && module_exists('fb_stream')) {
    if (!empty($form['#node_edit_form'])) {

      // Add checkbox to control feed publish.
      $form['fb_example']['stream_publish'] = array(
        '#type' => 'checkbox',
        '#title' => t('Share on Facebook Wall'),
        '#default_value' => variable_get('fb_example_stream_publish_default', FALSE),
      );
    }
    elseif ($form['#id'] == 'comment-form') {

      // Add checkbox to control feed publish.
      $form['fb_example']['stream_publish'] = array(
        '#type' => 'checkbox',
        '#title' => t('Share on Facebook Wall'),
        '#default_value' => variable_get('fb_example_stream_publish_default', FALSE),
      );
    }
  }
}

/**
 * Implements hook_node_insert().
 *
 * Publish to facebook Walls when users submit nodes.
 *
 * @see http://developers.facebook.com/docs/reference/rest/stream.publish
 * @see http://developers.facebook.com/docs/guides/attachments
 */
function fb_example_node_insert($node) {
  if (isset($node->stream_publish) && $node->stream_publish) {
    $attachment = array(
      'name' => $node->title,
      'href' => url('node/' . $node->nid, array(
        'absolute' => TRUE,
      )),
      'description' => filter_xss($node->teaser, array()),
    );

    /*
    if ($picture = $GLOBALS['user']->picture) {
    $url = url($picture, array('absolute' => TRUE));
    $attachment['media'][] = array(
    'type' => 'image',
    'src' => $url,
    'href' => $url,
    );
    }
    */
    if ($logo_path = theme_get_setting('logo_path')) {
      $url = url($logo_path, array(
        'absolute' => TRUE,
      ));

      //dpm($logo_path, "logo_path is $logo_path and url is $url");
      $attachment['media'][] = array(
        'type' => 'image',
        'src' => $url,
        'href' => $url,
      );
    }

    /* Facebook has disabled the message.  Deprecated.
       $user_message = t('Check out my latest post on !site...',
                         array('!site' => variable_get('site_name', t('my Drupal for Facebook powered site'))));
         */
    $actions = array();
    $actions[] = array(
      'text' => t('Read More'),
      'href' => url('node/' . $node->nid, array(
        'absolute' => TRUE,
      )),
    );
    fb_stream_publish_dialog(array(
      'message' => $user_message,
      'attachment' => $attachment,
      'action_links' => $actions,
    ));
  }
}

/**
 * Implements hook_node_update().
 *
 * Publish to facebook Walls when users submit nodes.
 *
 * @see http://developers.facebook.com/docs/reference/rest/stream.publish
 * @see http://developers.facebook.com/docs/guides/attachments
 */
function fb_example_node_update($node) {
  if (!empty($node->stream_publish)) {
    $teaser = node_view($node, 'teaser');
    $attachment = array(
      'name' => $node->title,
      'href' => url('node/' . $node->nid, array(
        'absolute' => TRUE,
      )),
      'description' => filter_xss($teaser['body'][0]['#markup'], array()),
    );

    /*
    if ($picture = $GLOBALS['user']->picture) {
    $url = url($picture, array('absolute' => TRUE));
    $attachment['media'][] = array(
    'type' => 'image',
    'src' => $url,
    'href' => $url,
    );
    }
    */
    if ($logo_path = theme_get_setting('logo_path')) {
      $url = url($logo_path, array(
        'absolute' => TRUE,
      ));

      //dpm($logo_path, "logo_path is $logo_path and url is $url");
      $attachment['media'][] = array(
        'type' => 'image',
        'src' => $url,
        'href' => $url,
      );
    }
    $user_message = t('Check out my latest post on !site...', array(
      '!site' => variable_get('site_name', t('my Drupal for Facebook powered site')),
    ));
    $actions = array();
    $actions[] = array(
      'text' => t('Read More'),
      'href' => url('node/' . $node->nid, array(
        'absolute' => TRUE,
      )),
    );
    fb_stream_publish_dialog(array(
      'message' => $user_message,
      'attachment' => $attachment,
      'action_links' => $actions,
    ));
  }
}

/**
 * Implements hook_node_view().
 */
function fb_example_node_view($node, $view_mode = 'full') {

  // This is an example of how you might add a 'like' button to the node links.
  if (variable_get('fb_example_link_add_like', TRUE)) {

    // Switch to control this behavior.
    $url = fb_scrub_urls(url('node/' . $node->nid, array(
      'absolute' => TRUE,
    )));
    $node->content['links']['node']['#links']['fb_like'] = array(
      'title' => "<fb:like layout='button_count' href={$url}></fb:like>",
      'html' => TRUE,
    );
  }

  // This is an example of how you might add a 'like' button into the content area.
  if (variable_get('fb_example_nodeapi_add_like', TRUE)) {
    $url = fb_scrub_urls(url('node/' . $node->nid, array(
      'absolute' => TRUE,
    )));
    $node->content['fb_like'] = array(
      '#markup' => "<fb:like href={$url}></fb:like>",
      '#weight' => -10,
      '#prefix' => '<div class="fb_like_wrapper">',
      '#suffix' => '</div>',
    );
  }
}

/**
 * Implements hook_comment_insert().
 *
 * Publish to facebook Walls when users submit comments.
 */
function fb_example_comment_insert($comment) {
  if (!empty($comment->stream_publish)) {

    //dpm($comment, "fb_example_comment, publishing to stream");

    //$node = node_load($comment->nid);

    // http://wiki.developers.facebook.com/index.php/Attachment_(Streams)
    $attachment = array(
      'name' => $comment->subject,
      'href' => url('node/' . $comment->nid, array(
        'absolute' => TRUE,
        'fragment' => 'comment-' . $comment->cid,
      )),
      'description' => $comment->comment_body[$comment->language][0]['value'],
    );
    if ($logo_path = theme_get_setting('logo_path')) {
      $url = url($logo_path, array(
        'absolute' => TRUE,
      ));

      //dpm($logo_path, "logo_path is $logo_path and url is $url");
      $attachment['media'][] = array(
        'type' => 'image',
        'src' => $url,
        'href' => $url,
      );
    }
    $user_message = t('Check out my latest comment on !site...', array(
      '!site' => variable_get('site_name', t('my Drupal for Facebook powered site')),
    ));
    $actions = array();
    $actions[] = array(
      'text' => t('Read More'),
      'href' => url('node/' . $comment->nid, array(
        'absolute' => TRUE,
      )),
    );
    fb_stream_publish_dialog(array(
      'message' => $user_message,
      'attachment' => $attachment,
      'action_links' => $actions,
    ));
  }
}

/**
 * Implements hook_comment_update().
 *
 * Publish to facebook Walls when users submit comments.
 */
function fb_example_comment_update($comment) {
  if ($comment->stream_publish) {

    //dpm($a1, "fb_example_comment, publishing to stream");
    $node = node_load($comment->nid);

    // http://wiki.developers.facebook.com/index.php/Attachment_(Streams)
    $attachment = array(
      'name' => $comment->subject,
      'href' => url('node/' . $comment->nid, array(
        'absolute' => TRUE,
        'fragment' => 'comment-' . $comment->cid,
      )),
      'description' => $comment->comment_body[$comment->language][0]['value'],
    );
    if ($logo_path = theme_get_setting('logo_path')) {
      $url = url($logo_path, array(
        'absolute' => TRUE,
      ));

      //dpm($logo_path, "logo_path is $logo_path and url is $url");
      $attachment['media'][] = array(
        'type' => 'image',
        'src' => $url,
        'href' => $url,
      );
    }
    $user_message = t('Check out my latest comment on !site...', array(
      '!site' => variable_get('site_name', t('my Drupal for Facebook powered site')),
    ));
    $actions = array();
    $actions[] = array(
      'text' => t('Read More'),
      'href' => url('node/' . $comment->nid, array(
        'absolute' => TRUE,
      )),
    );
    fb_stream_publish_dialog(array(
      'message' => $user_message,
      'attachment' => $attachment,
      'action_links' => $actions,
    ));
  }
}

/**
 * Implements hook_fb_required_perms_alter().
 *
 * Builds a list of extended permissions required when authorizing the current
 * facebook app.
 *
 * @see https://developers.facebook.com/docs/reference/login/user-friend-permissions/
 */
function fb_example_fb_required_perms_alter(&$perms) {
  if (variable_get('fb_example_require_email', TRUE)) {
    $perms[] = 'email';
  }
}

/**
 * Implements hook_fb().
 *
 * This hook provides an opportunity to customize the behavior of Facebook
 * Applications.
 *
 * @param $op
 *   Indicates what operation is currently being performed, or which behavior
 *   can be customized.  There are a number of these.  In some cases,
 *   modules/fb is informing other modules, and in other operations it is
 *   asking for information.
 *   - FB_OP_INITIALIZE - The facebook sdk has been initialized.  This tells a
 *     facebook application is enable for the current request.
 *   - FB_OP_APP_IS_AUTHORIZED - The visitor to this page has authorized the
 *     application.
 *
 * @param $data
 *   Associative array of information specific to this operation. Usually, but
 *   not always, contains:
 *   - 'fb' - The API provided by the facebook-php-sdk.
 *   - 'fb_app' - The data about this application stored by fb_app.module.
 *   - 'fbu' - If the current user is known, their facebook id.
 *
 * @param $return
 *   An op-specific return value.  Your hook should change this reference
 *   variable, and not return it.  Some operations return an array of data,
 *   which may be collaboratively built by multiple implementations of this
 *   hook.
 *
 *
 * Note, some example code is disabled.  Change the FALSE to TRUE in
 * variable_get calls to test the code.
 */
function fb_example_fb($op, $data, &$return) {
  $fb_app = isset($data['fb_app']) ? $data['fb_app'] : NULL;
  $fb = isset($data['fb']) ? $data['fb'] : NULL;

  // Uncomment next line to figure out when this hook is called and what it is
  // passed.
  // dpm(func_get_args(), "fb_example_fb($op) called"); // debug.
  if ($op == FB_OP_AJAX_EVENT) {

    // We get FB_OP_AJAX_EVENT when fb.js calls us in reponse to a javascript
    // event.
    if ($data['event_type'] == 'edge.create' && variable_get('fb_example_like_thanks', FALSE)) {

      // Facebook calls this event 'edge.create', because there's a new 'edge'
      // in the open graph.
      drupal_set_message(t('Thanks for clicking Like!'));

      // Reloading allows user to see message.  This example is contrived,
      // there's no real reason to reload page here, and it prevents users
      // from adding a comment.  In practice, you could put some other
      // javascript here.
      $return[] = "FB_JS.reload();";
    }
    if ($data['event_type'] == 'session_change' && variable_get('fb_example_session_change_redirect', FALSE)) {
      if (!isset($GLOBALS['fb_example_new_user'])) {

        // The user has clicked the connect button, or logged into/out-of
        // facebook in another browser window, then refreshed.
        if ($fbu = fb_facebook_user()) {

          // The user has connected (as opposed to logged out).  Let's redirect
          // them to our 'welcome' page.  Replace 'welcome' with the path you
          // really want.
          $url = url('welcome', array(
            'absolute' => TRUE,
            'fb_canvas' => fb_is_canvas(),
          ));

          // We return javascript to be evaluated by fb.js.
          $return[] = "FB_JS.reload('{$url}');";
        }
      }
      elseif ($GLOBALS['fb_example_new_user']) {

        // Send the user to their edit page.
        $url = url('user/' . $GLOBALS['user']->uid . '/edit', array(
          'absolute' => TRUE,
          'fb_canvas' => fb_is_canvas(),
        ));

        // We return javascript to be evaluated by fb.js.
        $return[] = "FB_JS.reload('{$url}');";
      }
    }
  }
}

/**
 * Implements hook_fb_user().
 *
 * This hook provided by fb_user.module will notify us when a new account is
 * created or a local account is logged in via facebook.
 *
 * @param $op
 *   Indicates what operation is currently being performed, or which behavior
 *   can be customized.  There are a number of these.  In some cases,
 *   modules/fb is informing other modules, and in other operations it is
 *   asking for information.
 *   - FB_USER_OP_PRE_USER - You have a chance to the name or other account
 *     attributes, before a new user account is created.
 *   - FB_USER_OP_POST_USER - A new user account was created for a facebook user
 *     who authorized an app.
 *
 * @param $data
 *   Associative array of information specific to this operation.
 *   Usually, but not always, contains:
 *   - 'fb' - The API provided by the facebook-php-sdk.
 *   - 'fb_app' - The data about this application stored by fb_app.module.
 *   - 'fbu' - If the current user is known, their facebook id.
 *
 * @param $return
 *   An op-specific return value.  Your hook should change this reference
 *   variable, and not return it.  Some operations return an array of data,
 *   which may be collaboratively built by multiple implementations of this
 *   hook.
 */
function fb_example_fb_user($op, $data, &$return) {
  $fb_app = isset($data['fb_app']) ? $data['fb_app'] : NULL;
  $fb = isset($data['fb']) ? $data['fb'] : NULL;
  if ($op == FB_USER_OP_POST_USER) {

    // Set a global that can be checked in hook_fb, above.  Note for this to
    // work properly, fb_example.module must be weighted heavier then
    // fb_user.module.  (See fb_example.install).
    $GLOBALS['fb_example_new_user'] = TRUE;
  }
}

/**
 * Implements hook_preprocess_page().
 *
 * Under admin >> site building >> facebook apps >> canvas pages, you'll find
 * some settings regarding the "processing" of canvas pages.  This processing
 * changes links for the entire page, so that all links point to
 * http://apps.facebook.com/... instead of Drupal's normal base_url.
 *
 * If instead you only want some of the links on a page to work this way, and
 * leave some unmodified, you can take the approach shown here.  In this hook
 * we process the text in some regions of the page, but not all.  So for
 * example links in the normal 'content' will not be modified.
 *
 * The code shown here could also be located in your theme's preprocess
 * function, or even in a page template.
 *
 * Note this function is only relavent when the checkboxes on admin >> site
 * building >> facebook apps >> canvas pages are disabled.
 */
function fb_example_preprocess_page(&$variables) {
  if (module_exists('fb_canvas') && fb_is_canvas()) {
    include_once drupal_get_path('module', 'fb') . '/fb.process.inc';

    // Process links in these regions.
    $regions = array(
      'content',
      'header',
      'footer',
      'left',
      'preface_first',
      'preface_middle',
      'preface_last',
    );
    foreach ($regions as $region) {
      $variables[$region] = fb_process($variables[$region], array(
        'add_target' => '_top',
        'absolute_links' => TRUE,
      ));
    }
  }
}

/**
 * Implements hook_init().
 *
 * Workaround for a problem with Drupal where a logged in user gets access
 * denied when visiting the login or register pages.  This can easily happen
 * when clicking the facebook connect button on the login or register forms.
 * Here will simply redirect the user to the profile page when that happens.
 */
function fb_example_init() {
  global $user;
  if ($user->uid != 0) {
    if (arg(0) == 'user' && (arg(1) == 'register' || arg(2) == 'login')) {

      // Avoid Drupal's awkward access denied.
      if (function_exists('fb_canvas_goto')) {
        fb_canvas_goto('user');
      }
      else {
        drupal_goto('user');
      }
    }
  }
}

Functions

Name	Description
fb_example_comment_insert	Implements hook_comment_insert().
fb_example_comment_update	Implements hook_comment_update().
fb_example_fb	Implements hook_fb().
fb_example_fb_required_perms_alter	Implements hook_fb_required_perms_alter().
fb_example_fb_user	Implements hook_fb_user().
fb_example_form_alter	Implements hook_form_alter().
fb_example_init	Implements hook_init().
fb_example_node_insert	Implements hook_node_insert().
fb_example_node_update	Implements hook_node_update().
fb_example_node_view	Implements hook_node_view().
fb_example_preprocess_page	Implements hook_preprocess_page().