Geodesic Solutions Community Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Social Connect Addon (AKA Facebook Connect) ======

The **Social Connect Addon** is meant primarily to allow your users to both register, and log in, using popular social websites such as Facebook and Google+.  Currently only Facebook connect is implemented but we have plans to add more sites in future versions.

<tip c w>**__Do not use or test this feature using the admin account or with any facebook account where the email on that account matches the email of the admin user in your Geo software__**</tip>

The secondary function is to add various integration options, such as showing a seller's Facebook profile pic on the seller's listings.
===== What It Does =====

This addon currently allows users to click a link **Login with Facebook**.  This will direct them to a page that will let them log into their Facebook account, and "approve" your website's Facebook app to access minimal information.  The user is then taken back to the site.  Below are the different scenarios for what will happen:

  * If the Facebook profile ID is already attached to an account in the software, the user is logged in under that account. <
  * If the user's **e-mail matches** a user already in the system, then it knows the user is the same as the one already in the system.  In that case, it links the Facebook account to that existing user, and logs the user in. <
  * //Rare Scenario//: If trying to link up a FB account to one account, when it is already linked to another account, it will merge both user accounts together using the "older" of the two user accounts in the system.  Typically this will happen if someone that already has a user account attempts to use "login with Facebook" when the e-mail does not match, so that it creates a brand new user account.  If that user later tries to link the FB account to the older account within the software, it will merge the newer account created using Facebook connect into the pre-existing older user account. <
  * If there are no matching accounts on the site yet, it will **register a new "minimal" user** with the info mentioned in [[#Minimal User Registration]] <


===== Minimal User Registration =====

When a new user is registered by using **Login with Facebook**, the following account fields are used.

  * **Username**:  Tries to use the best appropriate username in the software according to the following heirarchy:
    - Facebook username if set for the profile((requires Facebook profile to be verified, and is not very common.  If user has username you can visit the profile page using http://www.facebook.com/facebookusername )) - example: **facebookusername** <
    - First name and last initial - example: **First L**((Note that a username can have spaces in it.)) <
    - Full name - example: **First Last**((Note that a username can have spaces in it.)) (Only if first/last name could not be determined) <
    - First part of e-mail before @
    - Username is filtered to remove any characters not allowed for a username.
    - If the username generated matches one in the system, it adds a number - example: **First L 1** or **First L 5**((Note that a username can have spaces in it.)) if happen to already have 4 other users with same first name and last initial. <
<
  * **Password**:  //NOT used!// ((The user must always use the "login with Facebook" button to log into an account originally created using the login with Facebook button.)) <
  * **First Name**: Set to first name in Facebook profile. <
  * **Last Name**: Set to last name in Facebook profile. <
  * **Email**: Set to e-mail for Facebook profile.  Note that when user is "allowing access" to your site, they can elect to use anonymous e-mail, which will still work fine, you can read [[http://www.facebook.com/help/?faq=188306974553301|more info on facebook.com's FAQs]]. <
  * **Country**:  It looks at the "locale" on the Facebook profile, and attempts to determine if it matches to any countries within the software.  If it finds a match, it sets the user's country. <
  * **Profile ID**:  In order to allow future "login with facebook" to work, and to allow displaying the profile picture for the user, it stores the Facebook profile ID. <
  * **That's all!((Technically the software //could// ask for permission to see more of the user's information, however the more things that are asked for, the less likely the user is to allow access.  If it asked for all the user's information the user is more likely to just leave the site, so instead the software only asks for the minimal information.))**  Even if you have other required fields set in your registration settings, the above are the only fields that will be populated for a user registered using **Login with Facebook**.  If however, the user ever tries to edit the profile information within "my account" area, it will require that all required fields are entered at that time before they can save any other changes. <

====== Addon Tags ======

There are several addon tags that you can use in your design as explained below.

===== facebook_login_button =====

**{addon author='geo_addons' addon='social_connect' tag='facebook_login_button'}**

Use this tag to display the **Login with Facebook** button anywhere within your site.  Note that we have a few suggestions on where you might want to place this tag in [[#Template Suggestions]].

  * If the user is **not logged in**, it will appear like this:

{{:addons:social_connect:login-with-facebook-small.png?|}}

Clicking will either log the user in (if FB account already linked to user's account), or will register a new user account using info from Facebook profile.
<
  * If the user is **logged in using normal login** and they **do have Facebook profile linked to account**, it will look like this:

{{:addons:social_connect:reconnect-to-facebook.png?|}}

Clicking will re-connect to the FB account.  This can sometimes happen if it has been a while since the user has last authorized the account.  As long as the user is already logged into Facebook, and has previously already allowed access to the site, to the user it will appear to re-load the current page with that button gone((Although a lot more is going on than that, it happens so fast the user cannot tell)).
<
  * If the user is **logged in using normal login** and they **do NOT have Facebook profile linked to account**, it will look like this:

{{:addons:social_connect:link-account-to-facebook.png?|}}

Clicking on the button will prompt the user to authorize the site to have access to the user's account info.  Once they log in and authorize access, that pre-existing user's account will be "linked" to the Facebook account.
<

===== facebook_session_profile_picture =====

**{addon author='geo_addons' addon='social_connect' tag='facebook_session_profile_picture'}**

If the user is currently logged in, and is linked to FB profile, this tag will display the user's Facebook profile picture.

===== facebook_listing_profile_picture =====

**{addon author='geo_addons' addon='social_connect' tag='facebook_listing_profile_picture'}**

This is used on **listing details page**.  If the seller's account is linked to FB, and that seller has checked to show his or her Facebook profile pic.  This setting is found in **my account information** within **my account**, the setting named **Show Facebook Profile Pic in Listings**, as illustrated below:

{{ :addons:social_connect:show-fb-profile-pic-setting.png?direct&200 |}}
====== Template Suggestions ======

This is our suggestion for changes to make to your templates, assuming you are using a design close to the default design.

In the file **header.tpl**, find this section:

<code html><!-- START USER BAR -->
<div id="user_bar">
	Welcome, {module tag='display_username'}
	( 
	{if not $logged_in}
		{*Logged out code*}
		<a href="register.php">Register</a> | <a href="index.php?a=10">Login</a>
	{else}
		{*Logged in code*}
		<a href="index.php?a=4">My Account</a> | <a href="index.php?a=17">Logout</a>
	{/if}
	 )
</div>
<!-- END USER BAR --></code>

**Replace** that entire section, with the below modified version:

<code html><!-- START USER BAR -->
<div id="user_bar">
	{addon author='geo_addons' addon='social_connect' tag='facebook_session_profile_picture' assign='fb_pic'}
	{if $fb_pic}
		<div style="float: left; border: 1px solid black; margin: 0px 8px 8px 5px; line-height: 0px;">{$fb_pic}</div>
	{/if}
	Welcome, {module tag='display_username'}
	( 
	{if not $logged_in}
		{*Logged out code*}
		<a href="register.php">Register</a> | <a href="index.php?a=10">Login</a>
	{else}
		{*Logged in code*}
		<a href="index.php?a=4">My Account</a> | <a href="index.php?a=17">Logout</a>
	{/if}
	 )
	{addon author='geo_addons' addon='social_connect' tag='facebook_login_button'}
</div>
<!-- END USER BAR --></code>

The above changes will make the Facebook profile pic display to the left of the normal "Welcome..." text, if the user is logged in with Facebook.  If the user is not logged in with Facebook, it will show the appropriate Facebook button according to what is mentioned above in [[#facebook_login_button]].
====== Future Plans ======

Our main goal is to add more Social websites, to allow users to log in with **Google+** and any others that clients might want.

We also plan to add **deeper integration**, for instance showing all your friends that use the website.  If you have any suggestions of your own don't hesitate to let us know!
Geodesic Solutions Community Wiki

User Tools

Site Tools

Page Tools
