Extension:Facebook

From MediaWiki.org
Jump to: navigation, search

Other languages:
Deutsch • ‎English • ‎日本語 • ‎polski
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
Facebook Open Graph

Release status:Extension status unmaintained

FBConnect logo.png
ImplementationTemplate:Extension#type User rights, User identity, Parser extension, Tag, Special page, Ajax
DescriptionTemplate:Extension#description Provides Facebook Open Graph for MediaWiki
Author(s)Template:Extension#username Garrett Bruin
Sean Colombo
Latest versionTemplate:Extension#version 4.0.6 (2012-09-25)
MediaWikiTemplate:Extension#mediawiki 1.16 - 1.20
Database changesTemplate:Extension#needs-updatephp Yes
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Download

View Network on GitHub for forks and bugfixes from other developers

CHANGELOG.txt

ParametersTemplate:Extension#parameters

See config.default.php

Hooks usedTemplate:Extension#hook
ArticleViewHeaderManual:Hooks/ArticleViewHeader
AutopromoteConditionManual:Hooks/AutopromoteCondition
BeforePageDisplayManual:Hooks/BeforePageDisplay
LoadExtensionSchemaUpdatesManual:Hooks/LoadExtensionSchemaUpdates
MakeGlobalVariablesScriptManual:Hooks/MakeGlobalVariablesScript
ParserFirstCallInitManual:Hooks/ParserFirstCallInit
PersonalUrlsManual:Hooks/PersonalUrls
ResourceLoaderGetConfigVarsManual:Hooks/ResourceLoaderGetConfigVars
SkinTemplateOutputPageBeforeExecManual:Hooks/SkinTemplateOutputPageBeforeExec
SpecialListusersFormatRowManual:Hooks/SpecialListusersFormatRow
SpecialPage_initListManual:Hooks/SpecialPage_initList
userCanManual:Hooks/userCan
UserComparePasswordsManual:Hooks/UserComparePasswords
UserGetRightsManual:Hooks/UserGetRights
UserLoadAfterLoadFromSessionManual:Hooks/UserLoadAfterLoadFromSession

Translate the Facebook extension if it is available at translatewiki.net

Note Note: As of 2014, this extension has been marked "unmaintained" as it has not been updated to newer MediaWiki versions. The last version of MediaWiki known to be compatible is version 1.20. If you would like to assist in the maintenance/updating of this extension, please see the source code on github: https://github.com/garbear/facebook-mediawiki

The Facebook extension allows MediaWiki users to log into the wiki with their Facebook account by integrating your wiki into Facebook's. 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. Thanks to the Wikia Development Team for their help in the development of this extension.

Installation

  • Download and place the file(s) in a directory called Facebook in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/Facebook/Facebook.php";
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

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.

The below wgFbAppId and wgFbSecret code is an examples only, the code you need to enter are explained here after creating a new Facebook application.

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

Database update

Your database will need to be updated to work with Facebook, which only work with PHP 5.

Some web servers still default to PHP 4. This can be checked by 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, enter this command:

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

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.

If worst comes to worst, you can find the schema here: user_fbconnect.sql.

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 schema files in /extensions/Facebook/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.

Customization

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.

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.

$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;
}

If you previously requested offline_access, this permission was removed from Facebook on May 1, 2012. See the announcement here.

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;
}

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;
}

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.
  • When updating from an older version, consider bumping $wgStyleVersion.

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.

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.

See also

References