Extension:Facebook

From MediaWiki.org
Jump to: navigation, search
Language: English  • Deutsch
MediaWiki extensions manual - list
Crystal Clear action run.png
Facebook Open Graph

Release status: stable

FBConnect logo.png
Implementation User identity, Parser extension, Tag, Special page, Ajax
Description Facebook Open Graph for MediaWiki
Author(s) Garrett Bruin
Sean Colombo
Last version 4.0-final (Feb 14, 2011)
MediaWiki 1.16 - 1.19
License GPLv2
Download Download zip from GitHub

View Network on GitHub for forks and bugfixes from other developers

CHANGELOG.txt

Parameters

See config.default.php

Hooks used
ArticleViewHeader

AutopromoteCondition
BeforePageDisplay
LoadExtensionSchemaUpdates
MakeGlobalVariablesScript
ParserFirstCallInit
PersonalUrls
ResourceLoaderGetConfigVars
SkinTemplateOutputPageBeforeExec
SpecialListusersFormatRow
SpecialPage_initList
userCan
UserComparePasswords
UserGetRights
UserLoadAfterLoadFromSession

Check usage (experimental)


Facebook Open Graph for MediaWiki allows users to log in with their Facebook account and integrates your wiki into Facebook's Open Graph. Open Graph social plugins can be used on wiki pages, and you can even manage user rights from within Facebook using Facebook Groups.

This extension was not developed by Facebook. Many thanks go to the Wikia Development Team in the development of this extension.

Please consider donating to gbruin@ucla.edu (https://paypal.com/cgi-bin/webscr?cmd=_donations&business=gbruin@ucla.edu) if my extension is bringing your wiki fame and fortune. I'm a full-time student working towards my mechanical engineering degree, and your support will help greatly. Click now, because I'm taking the donate link down when I get my degree!

Contents

[edit] Download

The extension has moved to GitHub. It can be obtained by downloading the ZIP from the developer's GitHub page. Forks of the project can be found by clicking on the Network tab. Additional bugfixes may be found in forks by other developers.

  1. https://github.com/garbear/facebook-mediawiki


If you would like to obtain an old version from SourceForge, you may check one out via SVN

  1. svn co https://fbconnect4mw.svn.sourceforge.net/svnroot/fbconnect4mw/trunk/Facebook Facebook

[edit] Installation

First, like any extension, you will need to place the folder containing the PHP source files into the extensions folder of your MediaWiki installation. Make your wiki aware of the extension by including it in your Localsettings.php.

require_once("$IP/extensions/Facebook/Facebook.php");

[edit] Database update

Note(1/1/12): Tables fbconnect_event_show.sql and fbconnect_event_stats.sql are not used in the latest version. If these tables exist they will be safely ignored.

Your database will need to be updated to work with Facebook. This process will probably be made much simpler for MediaWiki 1.17, but until then the update must be done from the command line. It will only work with PHP 5. Some web servers still default to PHP 4, which you can check using the following command:

$ php --version
PHP 5.2.15 (cli) (built: Dec 15 2010 14:09:31)

Assuming PHP 5, run MediaWiki's update script.

$ cd path/to/site/w/
$ php maintenance/update.php

[edit] Fixing Database prefix problems

If you use a database prefix, the maintenance update script may fail. In that case, add your database prefix to the file-names in the folder /extensions/Facebook/sql to the following files:

fbconnect_event_show.sql
fbconnect_event_stats.sql
user_fbconnect.sql

and run the maintenance/update script again.

If you are using a really old version of this extension, you may have to apply this patch.

[edit] Upgrading

  • Version 4.0 (2012) has been updated to support Facebook Open Graph. Please read through config.default.php for an explanation of new features.
  • After upgrading, visit Special:Connect/Debug to make sure your Facebook application is configured correctly.
  • Note that if you are using a version from 2011 (v3.0+), the name of the extension folder has changed from "extensions/FBConnect" to "extensions/Facebook". Simply overwriting the files in the old directory won't work because some JavaScript and CSS paths are hard-coded.
  • Take care upgrading from older versions of this extension (from r91, pre-March 2010). Unfortunately, due to the new database layout, backwards compatibility was unable to be retained and considerable user renaming might have to be done. Updating from r100+ is safe and recommended.
  • When updating from an older version, consider bumping $wgStyleVersion.

[edit] Facebook Open Graph

By enabling $wgFbOpenGraph in the newest version, your wiki will be integrated with Facebook's Open Graph. Every page now has its own Open Graph ID used to publish actions on users' Timelines. To verify and check for problems, use the Object Debugger on Special:Connect/Debug.

[edit] Facebook Timeline

This extension supports pushing actions to a user's Timeline. See the documentation in config.default.php for how to configure your application within Facebook. Note that before actions show up in Timelines they must first be submitted and approved by Facebook.

[edit] Customizing the extension

[edit] Configuration

The file config.default.php (here) contains the steps for creating a new Facebook application and different ways to customize your setup. You may edit config.default.php directly, but in order to preserve changes across updates it is recommended that you save the modified file as config.php. Alternatively, you may include your settings in Localsettings.php after the require_once statement above.

##
## Facebook Connect
##
require_once("$IP/extensions/Facebook/Facebook.php");
$wgFbAppId  = '47406044892';
$wgFbSecret = '04137a722facf86d075f737ab6e93818';

[edit] User login form

If you want to have a Facebook Login button on the user login page, you will need to edit the nologin message at [[MediaWiki:Nologin]]. Change Don't have an account? $1. to

Don't have an account? $1. You can also <span class="mw-facebook-logo">[[Special:Connect|log in with Facebook]]</span>.
 
<fb:login-button show-faces="true" width="450" max-rows="1" scope="auto"></fb:login-button><br/><br/>

The extension will automatically fill in scope="auto" with the correct permissions as determined by your configuration parameters.

[edit] Facebook permissions

The FacebookPermissions hook allows you to specify the permissions required by your application explicitly. For more info, see Facebook permissions. The hooks below can be placed directly in your LocalSettings.php file.

Note that if you previously requested offline_access, this permission will be removed from Facebook on May 1, 2012. See the annoucement here.

$wgHooks['FacebookPermissions'][] = 'fnMyHook';
function fnMyHook( &$scope ) {
    // Unset a permission
    foreach ( $scope as $i => $perm ) {
        if ( $perm == 'email' )
            unset( $scope[$i] );
    }
    // Require an additional permission
    $scope[] = 'publish_actions';
    return true;
}

[edit] Social plugins

XFBMLAvailableTags provides an array of available social plugins (see Social plugins and Open Graph beta social plugins). Specific social plugins can be blacklisted. If a new plugin becomes available that this extension does not yet support, it can be added via this hook. View the default list of plugins in FacebookXFBML.php. You can disable all plugins using the $wgFbSocialPlugins configuration parameter.

$wgHooks['XFBMLAvailableTags'][] = 'fnMyHook';
function fnMyHook( &$tags ) {
    // Disable a tag
    foreach ( $tags as $i => $tag ) {
        if ( $tag == 'fb:like' )
            unset( $tags[$i] );
    }
    // Add a new tag
    $tags[] = 'fb:roundhouse-kick';
    return true;
}

[edit] Social plugins color scheme

XFBMLSkinColorScheme can be used to automatically theme social plugins based on your site's various skins. This hook causes social plugins to automatically include the colorscheme="dark" parameter on dark-themed wikis. You can override this on a per-plugin basis by explicitly specifying colorscheme="light" in your page's wiki text. The color scheme is determined by the skin of the user saving the page; if you have multiple light/dark skins, install Extension:MagicNoCache and include __NOCACHE__ on the pages with social plugins.

$wgHooks['XFBMLSkinColorScheme'][] = 'fnMyHook';
function fnMyHook( &$skins ) {
    $skins['mistylook'] = 'dark';
    return true;
}

[edit] See also

Personal tools
Namespaces

Variants
Actions
Navigation
Support
Download
Development
Communication
Print/export
Toolbox