2010-11-02 08:50:45 +09:00
< ? php
/**
* StatusNet , the distributed open - source microblogging tool
*
2010-11-05 15:34:06 +09:00
* Login or register a local user based on a Facebook user
2010-11-02 08:50:45 +09:00
*
* PHP version 5
*
* LICENCE : This program is free software : you can redistribute it and / or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation , either version 3 of the License , or
* ( at your option ) any later version .
*
* This program is distributed in the hope that it will be useful ,
* but WITHOUT ANY WARRANTY ; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
* GNU Affero General Public License for more details .
*
* You should have received a copy of the GNU Affero General Public License
* along with this program . If not , see < http :// www . gnu . org / licenses />.
*
* @ category Plugin
* @ package StatusNet
* @ author Zach Copley < zach @ status . net >
* @ copyright 2010 StatusNet , Inc .
* @ license http :// www . fsf . org / licensing / licenses / agpl - 3.0 . html GNU Affero General Public License version 3.0
* @ link http :// status . net /
*/
if ( ! defined ( 'STATUSNET' )) {
exit ( 1 );
}
2010-11-05 15:34:06 +09:00
class FacebookfinishloginAction extends Action
2010-11-02 08:50:45 +09:00
{
private $facebook = null ; // Facebook client
private $fbuid = null ; // Facebook user ID
private $fbuser = null ; // Facebook user object (JSON)
function prepare ( $args ) {
parent :: prepare ( $args );
$this -> facebook = new Facebook (
array (
'appId' => common_config ( 'facebook' , 'appid' ),
'secret' => common_config ( 'facebook' , 'secret' ),
'cookie' => true ,
)
);
// Check for a Facebook user session
$session = $this -> facebook -> getSession ();
$me = null ;
if ( $session ) {
try {
$this -> fbuid = $this -> facebook -> getUser ();
$this -> fbuser = $this -> facebook -> api ( '/me' );
} catch ( FacebookApiException $e ) {
common_log ( LOG_ERROR , $e , __FILE__ );
}
}
if ( ! empty ( $this -> fbuser )) {
// OKAY, all is well... proceed to register
common_debug ( " Found a valid Facebook user. " , __FILE__ );
} else {
// This shouldn't happen in the regular course of things
list ( $proxy , $ip ) = common_client_ip ();
common_log (
LOG_WARNING ,
sprintf (
'Failed Facebook authentication attempt, proxy = %s, ip = %s.' ,
$proxy ,
$ip
),
__FILE__
);
$this -> clientError (
_m ( 'You must be logged into Facebook to register a local account using Facebook.' )
);
}
return true ;
}
function handle ( $args )
{
parent :: handle ( $args );
if ( common_is_real_login ()) {
// User is already logged in, are her accounts already linked?
$flink = Foreign_link :: getByForeignID ( $this -> fbuid , FACEBOOK_SERVICE );
if ( ! empty ( $flink )) {
// User already has a linked Facebook account and shouldn't be here!
common_debug (
sprintf (
'There\'s already a local user %d linked with Facebook user %s.' ,
$flink -> user_id ,
$this -> fbuid
)
);
$this -> clientError (
_m ( 'There is already a local account linked with that Facebook account.' )
);
} else {
// Possibly reconnect an existing account
$this -> connectUser ();
}
} else if ( $_SERVER [ 'REQUEST_METHOD' ] == 'POST' ) {
$token = $this -> trimmed ( 'token' );
if ( ! $token || $token != common_session_token ()) {
$this -> showForm (
_m ( 'There was a problem with your session token. Try again, please.' ));
return ;
}
if ( $this -> arg ( 'create' )) {
if ( ! $this -> boolean ( 'license' )) {
$this -> showForm (
_m ( 'You can\'t register if you don\'t agree to the license.' ),
$this -> trimmed ( 'newname' )
);
return ;
}
// We has a valid Facebook session and the Facebook user has
// agreed to the SN license, so create a new user
$this -> createNewUser ();
} else if ( $this -> arg ( 'connect' )) {
$this -> connectNewUser ();
} else {
$this -> showForm (
_m ( 'An unknown error has occured.' ),
$this -> trimmed ( 'newname' )
);
}
} else {
$this -> tryLogin ();
}
}
function showPageNotice ()
{
if ( $this -> error ) {
$this -> element ( 'div' , array ( 'class' => 'error' ), $this -> error );
} else {
$this -> element (
'div' , 'instructions' ,
// TRANS: %s is the site name.
sprintf (
_m ( 'This is the first time you\'ve logged into %s so we must connect your Facebook to a local account. You can either create a new local account, or connect with an existing local account.' ),
common_config ( 'site' , 'name' )
)
);
}
}
function title ()
{
// TRANS: Page title.
return _m ( 'Facebook Setup' );
}
function showForm ( $error = null , $username = null )
{
$this -> error = $error ;
$this -> username = $username ;
$this -> showPage ();
}
function showPage ()
{
parent :: showPage ();
}
/**
* @ fixme much of this duplicates core code , which is very fragile .
* Should probably be replaced with an extensible mini version of
* the core registration form .
*/
function showContent ()
{
if ( ! empty ( $this -> message_text )) {
$this -> element ( 'p' , null , $this -> message );
return ;
}
$this -> elementStart ( 'form' , array ( 'method' => 'post' ,
'id' => 'form_settings_facebook_connect' ,
'class' => 'form_settings' ,
2010-11-05 15:34:06 +09:00
'action' => common_local_url ( 'facebookfinishlogin' )));
2010-11-02 08:50:45 +09:00
$this -> elementStart ( 'fieldset' , array ( 'id' => 'settings_facebook_connect_options' ));
// TRANS: Legend.
$this -> element ( 'legend' , null , _m ( 'Connection options' ));
$this -> elementStart ( 'ul' , 'form_data' );
$this -> elementStart ( 'li' );
$this -> element ( 'input' , array ( 'type' => 'checkbox' ,
'id' => 'license' ,
'class' => 'checkbox' ,
'name' => 'license' ,
'value' => 'true' ));
$this -> elementStart ( 'label' , array ( 'class' => 'checkbox' , 'for' => 'license' ));
// TRANS: %s is the name of the license used by the user for their status updates.
$message = _m ( 'My text and files are available under %s ' .
'except this private data: password, ' .
'email address, IM address, and phone number.' );
$link = '<a href="' .
htmlspecialchars ( common_config ( 'license' , 'url' )) .
'">' .
htmlspecialchars ( common_config ( 'license' , 'title' )) .
'</a>' ;
$this -> raw ( sprintf ( htmlspecialchars ( $message ), $link ));
$this -> elementEnd ( 'label' );
$this -> elementEnd ( 'li' );
$this -> elementEnd ( 'ul' );
$this -> elementStart ( 'fieldset' );
$this -> hidden ( 'token' , common_session_token ());
$this -> element ( 'legend' , null ,
// TRANS: Legend.
_m ( 'Create new account' ));
$this -> element ( 'p' , null ,
_m ( 'Create a new user with this nickname.' ));
$this -> elementStart ( 'ul' , 'form_data' );
$this -> elementStart ( 'li' );
// TRANS: Field label.
$this -> input ( 'newname' , _m ( 'New nickname' ),
( $this -> username ) ? $this -> username : '' ,
_m ( '1-64 lowercase letters or numbers, no punctuation or spaces' ));
$this -> elementEnd ( 'li' );
$this -> elementEnd ( 'ul' );
// TRANS: Submit button.
$this -> submit ( 'create' , _m ( 'BUTTON' , 'Create' ));
$this -> elementEnd ( 'fieldset' );
$this -> elementStart ( 'fieldset' );
// TRANS: Legend.
$this -> element ( 'legend' , null ,
_m ( 'Connect existing account' ));
$this -> element ( 'p' , null ,
_m ( 'If you already have an account, login with your username and password to connect it to your Facebook.' ));
$this -> elementStart ( 'ul' , 'form_data' );
$this -> elementStart ( 'li' );
// TRANS: Field label.
$this -> input ( 'nickname' , _m ( 'Existing nickname' ));
$this -> elementEnd ( 'li' );
$this -> elementStart ( 'li' );
$this -> password ( 'password' , _m ( 'Password' ));
$this -> elementEnd ( 'li' );
$this -> elementEnd ( 'ul' );
// TRANS: Submit button.
$this -> submit ( 'connect' , _m ( 'BUTTON' , 'Connect' ));
$this -> elementEnd ( 'fieldset' );
$this -> elementEnd ( 'fieldset' );
$this -> elementEnd ( 'form' );
}
function message ( $msg )
{
$this -> message_text = $msg ;
$this -> showPage ();
}
function createNewUser ()
{
if ( common_config ( 'site' , 'closed' )) {
// TRANS: Client error trying to register with registrations not allowed.
$this -> clientError ( _m ( 'Registration not allowed.' ));
return ;
}
$invite = null ;
if ( common_config ( 'site' , 'inviteonly' )) {
$code = $_SESSION [ 'invitecode' ];
if ( empty ( $code )) {
// TRANS: Client error trying to register with registrations 'invite only'.
$this -> clientError ( _m ( 'Registration not allowed.' ));
return ;
}
$invite = Invitation :: staticGet ( $code );
if ( empty ( $invite )) {
// TRANS: Client error trying to register with an invalid invitation code.
$this -> clientError ( _m ( 'Not a valid invitation code.' ));
return ;
}
}
$nickname = $this -> trimmed ( 'newname' );
if ( ! Validate :: string ( $nickname , array ( 'min_length' => 1 ,
'max_length' => 64 ,
'format' => NICKNAME_FMT ))) {
$this -> showForm ( _m ( 'Nickname must have only lowercase letters and numbers and no spaces.' ));
return ;
}
if ( ! User :: allowed_nickname ( $nickname )) {
$this -> showForm ( _m ( 'Nickname not allowed.' ));
return ;
}
if ( User :: staticGet ( 'nickname' , $nickname )) {
$this -> showForm ( _m ( 'Nickname already in use. Try another one.' ));
return ;
}
$args = array (
2010-11-10 08:14:50 +09:00
'nickname' => $nickname ,
'fullname' => $this -> fbuser [ 'first_name' ]
. ' ' . $this -> fbuser [ 'last_name' ],
'email' => $this -> fbuser [ 'email' ],
'email_confirmed' => true ,
'homepage' => $this -> fbuser [ 'website' ],
'bio' => $this -> fbuser [ 'about' ],
'location' => $this -> fbuser [ 'location' ][ 'name' ]
2010-11-02 08:50:45 +09:00
);
if ( ! empty ( $invite )) {
$args [ 'code' ] = $invite -> code ;
}
$user = User :: register ( $args );
$result = $this -> flinkUser ( $user -> id , $this -> fbuid );
if ( ! $result ) {
$this -> serverError ( _m ( 'Error connecting user to Facebook.' ));
return ;
}
2010-11-10 08:14:50 +09:00
$this -> setAvatar ( $user );
2010-11-02 08:50:45 +09:00
common_set_user ( $user );
common_real_login ( true );
common_log (
LOG_INFO ,
sprintf (
'Registered new user %d from Facebook user %s' ,
$user -> id ,
$this -> fbuid
),
__FILE__
);
common_redirect (
common_local_url (
'showstream' ,
array ( 'nickname' => $user -> nickname )
),
303
);
}
2010-11-10 08:14:50 +09:00
/*
* Attempt to download the user ' s Facebook picture and create a
* StatusNet avatar for the new user .
*/
function setAvatar ( $user )
{
$picUrl = sprintf (
'http://graph.facebook.com/%s/picture?type=large' ,
$this -> fbuid
);
// fetch the picture from Facebook
$client = new HTTPClient ();
common_debug ( " status = $status - " . $finalUrl , __FILE__ );
// fetch the actual picture
$response = $client -> get ( $picUrl );
if ( $response -> isOk ()) {
$finalUrl = $client -> getUrl ();
$filename = 'facebook-' . substr ( strrchr ( $finalUrl , '/' ), 1 );
common_debug ( " Filename = " . $filename , __FILE__ );
$ok = file_put_contents (
Avatar :: path ( $filename ),
$response -> getBody ()
);
if ( ! $ok ) {
common_log (
LOG_WARNING ,
sprintf (
'Couldn\'t save Facebook avatar %s' ,
$tmp
),
__FILE__
);
} else {
$profile = $user -> getProfile ();
if ( $profile -> setOriginal ( $filename )) {
common_log (
LOG_INFO ,
sprintf (
'Saved avatar for %s (%d) from Facebook profile %s, filename = %s' ,
$user -> nickname ,
$user -> id ,
$this -> fbuid ,
$picture
),
__FILE__
);
}
}
}
}
2010-11-02 08:50:45 +09:00
function connectNewUser ()
{
$nickname = $this -> trimmed ( 'nickname' );
$password = $this -> trimmed ( 'password' );
if ( ! common_check_user ( $nickname , $password )) {
$this -> showForm ( _m ( 'Invalid username or password.' ));
return ;
}
$user = User :: staticGet ( 'nickname' , $nickname );
if ( ! empty ( $user )) {
common_debug ( 'Facebook Connect Plugin - ' .
" Legit user to connect to Facebook: $nickname " );
}
$result = $this -> flinkUser ( $user -> id , $this -> fbuid );
if ( ! $result ) {
$this -> serverError ( _m ( 'Error connecting user to Facebook.' ));
return ;
}
common_debug ( 'Facebook Connnect Plugin - ' .
" Connected Facebook user $this->fbuid to local user $user->id " );
common_set_user ( $user );
common_real_login ( true );
$this -> goHome ( $user -> nickname );
}
function connectUser ()
{
$user = common_current_user ();
$result = $this -> flinkUser ( $user -> id , $this -> fbuid );
if ( empty ( $result )) {
$this -> serverError ( _m ( 'Error connecting user to Facebook.' ));
return ;
}
2010-11-05 15:34:06 +09:00
common_debug (
sprintf (
'Connected Facebook user %s to local user %d' ,
$this -> fbuid ,
$user -> id
),
__FILE__
);
2010-11-02 08:50:45 +09:00
2010-11-05 15:34:06 +09:00
common_redirect ( common_local_url ( 'facebookfinishlogin' ), 303 );
2010-11-02 08:50:45 +09:00
}
function tryLogin ()
{
2010-11-05 15:34:06 +09:00
common_debug (
sprintf (
'Trying login for Facebook user %s' ,
$this -> fbuid
),
__FILE__
);
2010-11-02 08:50:45 +09:00
2010-11-05 15:34:06 +09:00
$flink = Foreign_link :: getByForeignID ( $this -> fbuid , FACEBOOK_SERVICE );
2010-11-02 08:50:45 +09:00
if ( ! empty ( $flink )) {
$user = $flink -> getUser ();
if ( ! empty ( $user )) {
2010-11-05 15:34:06 +09:00
common_log (
LOG_INFO ,
sprintf (
'Logged in Facebook user %s as user %d (%s)' ,
$this -> fbuid ,
$user -> nickname ,
$user -> id
),
__FILE__
);
2010-11-02 08:50:45 +09:00
common_set_user ( $user );
common_real_login ( true );
$this -> goHome ( $user -> nickname );
}
} else {
2010-11-05 15:34:06 +09:00
common_debug (
sprintf (
'No flink found for fbuid: %s - new user' ,
$this -> fbuid
),
__FILE__
);
2010-11-02 08:50:45 +09:00
$this -> showForm ( null , $this -> bestNewNickname ());
}
}
function goHome ( $nickname )
{
$url = common_get_returnto ();
if ( $url ) {
// We don't have to return to it again
common_set_returnto ( null );
} else {
$url = common_local_url ( 'all' ,
array ( 'nickname' =>
$nickname ));
}
common_redirect ( $url , 303 );
}
function flinkUser ( $user_id , $fbuid )
{
$flink = new Foreign_link ();
$flink -> user_id = $user_id ;
$flink -> foreign_id = $fbuid ;
$flink -> service = FACEBOOK_SERVICE ;
// Pull the access token from the Facebook cookies
$flink -> credentials = $this -> facebook -> getAccessToken ();
$flink -> created = common_sql_now ();
$flink_id = $flink -> insert ();
return $flink_id ;
}
function bestNewNickname ()
{
if ( ! empty ( $this -> fbuser [ 'name' ])) {
$nickname = $this -> nicknamize ( $this -> fbuser [ 'name' ]);
if ( $this -> isNewNickname ( $nickname )) {
return $nickname ;
}
}
// Try the full name
$fullname = trim ( $this -> fbuser [ 'firstname' ] .
' ' . $this -> fbuser [ 'lastname' ]);
if ( ! empty ( $fullname )) {
$fullname = $this -> nicknamize ( $fullname );
if ( $this -> isNewNickname ( $fullname )) {
return $fullname ;
}
}
return null ;
}
/**
* Given a string , try to make it work as a nickname
*/
function nicknamize ( $str )
{
$str = preg_replace ( '/\W/' , '' , $str );
return strtolower ( $str );
}
function isNewNickname ( $str )
{
if ( ! Validate :: string ( $str , array ( 'min_length' => 1 ,
'max_length' => 64 ,
'format' => NICKNAME_FMT ))) {
return false ;
}
if ( ! User :: allowed_nickname ( $str )) {
return false ;
}
if ( User :: staticGet ( 'nickname' , $str )) {
return false ;
}
return true ;
}
}