trac750 Better workflow for asking user for status update permission

actions/facebookhome.php

@@ -31,14 +31,41 @@ class FacebookhomeAction extends FacebookAction
         $facebook = get_facebook();
         $fbuid = $facebook->require_login();
 
+        // If the user has opted not to initially allow the app to have
+        // Facebook status update permission, store that preference. Only
+        // promt the user the first time she uses the app
+        if ($this->arg('skip')) {
+            $facebook->api_client->data_setUserPreference(
+                FACEBOOK_PROMPTED_UPDATE_PREF, 'true');
+        }
+
         // Check to see whether there's already a Facebook link for this user
         $flink = Foreign_link::getByForeignID($fbuid, FACEBOOK_SERVICE);
 
         if ($flink) {
+
             $user = $flink->getUser();
             common_set_user($user);
+
+            // If this is the first time the user has started the app
+            // prompt for Facebook status update permission
+            if (!$facebook->api_client->users_hasAppPermission('status_update')) {
+
+                if ($facebook->api_client->data_getUserPreference(
+                        FACEBOOK_PROMPTED_UPDATE_PREF) != 'true') {
+                    $this->getUpdatePermission();
+                    return;
+                }
+            }
+
+            // Use is authenticated and has already been prompted once for
+            // Facebook status update permission? Then show the main page
+            // of the app
             $this->showHome($flink, null);
+
         } else {
+
+            // User hasn't authenticated yet, prompt for creds
             $this->login($fbuid);
         }
 
@@ -73,16 +100,18 @@ class FacebookhomeAction extends FacebookAction
                 // XXX: Do some error handling here
 
                 $this->setDefaults();
-                $this->showHome($flink, _('You can now use Identi.ca from Facebook!'));
+                //$this->showHome($flink, _('You can now use Identi.ca from Facebook!'));
+
+                $this->getUpdatePermission();
                 return;
-                
+
             } else {
                 $msg = _('Incorrect username or password.');
             }
         }
 
         $this->showLoginForm($msg);
-        
+
     }
 
     function setDefaults()
@@ -90,7 +119,10 @@ class FacebookhomeAction extends FacebookAction
         $facebook = get_facebook();
 
         // A default prefix string for notices
-        $facebook->api_client->data_setUserPreference(1, 'dented: ');
+        $facebook->api_client->data_setUserPreference(
+            FACEBOOK_NOTICE_PREFIX, 'dented: ');
+        $facebook->api_client->data_setUserPreference(
+            FACEBOOK_PROMPTED_UPDATE_PREF, 'false');
     }
 
     function showHome($flink, $msg)
@@ -138,4 +170,58 @@ class FacebookhomeAction extends FacebookAction
         return $nl->show();
     }
 
+    function getUpdatePermission() {
+
+        $facebook = get_facebook();
+        $fbuid = $facebook->require_login();
+
+        start_fbml();
+
+        common_element('link', array('rel' => 'stylesheet',
+                                     'type' => 'text/css',
+                                     'href' => getFacebookCSS()));
+
+        $this->showLogo();
+
+        common_element_start('div', array('class' => 'content'));
+
+        // Figure what the URL of our app is.
+        $app_props = $facebook->api_client->Admin_getAppProperties(
+                array('canvas_name', 'application_name'));
+        $app_url = 'http://apps.facebook.com/' . $app_props['canvas_name'] . '/index.php';
+        $app_name = $app_props['application_name'];
+
+        $instructions = sprintf(_('If you would like the %s app to automatically update ' .
+            'your Facebook status with your latest notice, you need ' .
+            'to give it permission.'), $app_name);
+
+        common_element_start('p');
+        common_element('span', array('id' => 'permissions_notice'), $instructions);
+        common_element_end('p');
+
+        common_element_start('form', array('method' => 'post',
+                                           'action' => $app_url,
+                                           'id' => 'facebook-skip-permissions'));
+
+        common_element_start('ul', array('id' => 'fb-permissions-list'));
+        common_element_start('li', array('id' => 'fb-permissions-item'));
+        common_element_start('fb:prompt-permission', array('perms' => 'status_update',
+            'next_fbjs' => 'document.setLocation(\'' . $app_url . '\')'));
+        common_element('span', array('class' => 'facebook-button'),
+            _('Allow Identi.ca to update my Facebook status'));
+        common_element_end('fb:prompt-permission');
+        common_element_end('li');
+
+        common_element_start('li', array('id' => 'fb-permissions-item'));
+        common_submit('skip', _('Skip'));
+        common_element_end('li');
+        common_element_end('ul');
+
+        common_element_end('form');
+        common_element_end('div');
+
+        common_end_xml();
+
+    }
+
 }

actions/facebooksettings.php

@@ -50,12 +50,13 @@ class FacebooksettingsAction extends FacebookAction
         $flink->set_flags($noticesync, $replysync, false);
         $result = $flink->update($original);
 
-        $facebook->api_client->data_setUserPreference(1, substr($prefix, 0, 128));
+        $facebook->api_client->data_setUserPreference(FACEBOOK_NOTICE_PREFIX,
+            substr($prefix, 0, 128));
 
         if ($result) {
-            $this->show_form('Sync preferences saved.', true);
+            $this->showForm('Sync preferences saved.', true);
         } else {
-            $this->show_form('There was a problem saving your sync preferences!');
+            $this->showForm('There was a problem saving your sync preferences!');
         }
     }
 
@@ -67,18 +68,7 @@ class FacebooksettingsAction extends FacebookAction
         $flink = Foreign_link::getByForeignID($fbuid, FACEBOOK_SERVICE);
 
         $this->showHeader('Settings', $msg, $success);
-                
+
-        common_element_start('p');
-        
-        // Figure what the URL of our app is.
-        $app_props = $facebook->api_client->Admin_getAppProperties(array('canvas_name'));
-        $app_url = 'http://apps.facebook.com/' . $app_props['canvas_name'] . '/settings.php';
-                
-        common_element_start('fb:prompt-permission', array('perms' => 'status_update',
-            'next_fbjs' => 'document.setLocation(\'' . $app_url . '\')'));
-        common_element('h2', null, _('Allow Identi.ca to update my Facebook status'));
-        common_element_end('fb:prompt-permission');
-        common_element_end('p');
 
         if ($facebook->api_client->users_hasAppPermission('status_update')) {
 
@@ -90,11 +80,11 @@ class FacebooksettingsAction extends FacebookAction
             common_checkbox('noticesync', _('Automatically update my Facebook status with my notices.'),
                                 ($flink) ? ($flink->noticesync & FOREIGN_NOTICE_SEND) : true);
 
-            common_checkbox('replysync', _('Send local "@" replies to Facebook.'),
+            common_checkbox('replysync', _('Send "@" replies to Facebook.'),
                              ($flink) ? ($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY) : true);
 
             $prefix = $facebook->api_client->data_getUserPreference(1);
-            
+
 
             common_input('prefix', _('Prefix'),
                          ($prefix) ? $prefix : null,
@@ -103,6 +93,31 @@ class FacebooksettingsAction extends FacebookAction
 
             common_element_end('form');
 
+        } else {
+
+            // Figure what the URL of our app is.
+            $app_props = $facebook->api_client->Admin_getAppProperties(
+                    array('canvas_name', 'application_name'));
+            $app_url = 'http://apps.facebook.com/' . $app_props['canvas_name'] . '/settings.php';
+            $app_name = $app_props['application_name'];
+
+            $instructions = sprintf(_('If you would like the %s app to automatically update ' .
+                'your Facebook status with your latest notice, you need ' .
+                'to give it permission.'), $app_name);
+
+            common_element_start('p');
+            common_element('span', array('id' => 'permissions_notice'), $instructions);
+            common_element_end('p');
+
+            common_element_start('ul', array('id' => 'fb-permissions-list'));
+            common_element_start('li', array('id' => 'fb-permissions-item'));
+            common_element_start('fb:prompt-permission', array('perms' => 'status_update',
+                'next_fbjs' => 'document.setLocation(\'' . $app_url . '\')'));
+            common_element('span', array('class' => 'facebook-button'),
+                _('Allow Identi.ca to update my Facebook status'));
+            common_element_end('fb:prompt-permission');
+            common_element_end('li');
+            common_element_end('ul');
         }
 
         $this->showFooter();

lib/facebookaction.php

@@ -17,7 +17,7 @@
  * along with this program.     If not, see <http://www.gnu.org/licenses/>.
  */
 
-if (!defined('LACONICA')) { 
+if (!defined('LACONICA')) {
     exit(1);
 }
 
@@ -32,9 +32,9 @@ class FacebookAction extends Action
     }
 
     function showLogo(){
-        
+
         global $xw;
-        
+
         common_element('link', array('rel' => 'stylesheet',
                                      'type' => 'text/css',
                                      'href' => getFacebookCSS()));
@@ -47,14 +47,14 @@ class FacebookAction extends Action
                                             'href' => common_local_url('public')));
         if (common_config('site', 'logo') || file_exists(theme_file('logo.png'))) {
             common_element('img', array('class' => 'logo photo',
-                'src' => (common_config('site', 'logo')) ? 
+                'src' => (common_config('site', 'logo')) ?
                     common_config('site', 'logo') : theme_path('logo.png'),
                 'alt' => common_config('site', 'name')));
         }
-         
+
         common_element('span', array('class' => 'fn org'), common_config('site', 'name'));
         common_element_end('a');
-    
+
     }
 
     function showHeader($selected = 'Home', $msg = null, $success = false)
@@ -76,25 +76,25 @@ class FacebookAction extends Action
 
         common_element_start('ul', array('class' => 'nav'));
 
-        common_element_start('li', array('class' => 
+        common_element_start('li', array('class' =>
             ($selected == 'Home') ? 'current' : 'facebook_home'));
-        common_element('a', 
+        common_element('a',
             array('href' => 'index.php', 'title' => _('Home')), _('Home'));
         common_element_end('li');
 
-        
+
-        common_element_start('li', 
+        common_element_start('li',
             array('class' =>
                 ($selected == 'Invite') ? 'current' : 'facebook_invite'));
-        common_element('a', 
+        common_element('a',
             array('href' => 'invite.php', 'title' => _('Invite')), _('Invite'));
         common_element_end('li');
 
-        common_element_start('li', 
+        common_element_start('li',
             array('class' =>
                 ($selected == 'Settings') ? 'current' : 'facebook_settings'));
-        common_element('a', 
+        common_element('a',
-            array('href' => 'settings.php', 
+            array('href' => 'settings.php',
                 'title' => _('Settings')), _('Settings'));
         common_element_end('li');
 
@@ -125,24 +125,24 @@ class FacebookAction extends Action
 
     function showInstructions()
     {
-        global $xw; 
+        global $xw;
-        
+
         common_element_start('dl', array('class' => 'system_notice'));
         common_element('dt', null, 'Page Notice');
-    
+
         $loginmsg_part1 = _('To use the %s Facebook Application you need to login ' .
-            'with your username and password. Don\'t have a username yet? '); 
+            'with your username and password. Don\'t have a username yet? ');
-        
+
         $loginmsg_part2 = _(' a new account.');
-        
+
         common_element_start('dd');
         common_element_start('p');
         common_text(sprintf($loginmsg_part1, common_config('site', 'name')));
-        common_element('a', 
+        common_element('a',
             array('href' => common_local_url('register')), _('Register'));
         common_text($loginmsg_part2);
         common_element_end('dd');
-        common_element_end('dl');        
+        common_element_end('dl');
     }
 
     function showLoginForm($msg = null)
@@ -154,14 +154,14 @@ class FacebookAction extends Action
                                      'href' => getFacebookCSS()));
 
         $this->showLogo();
-                                 
+
         common_element_start('div', array('class' => 'content'));
         common_element('h1', null, _('Login'));
-   
+
         if ($msg) {
              common_element('fb:error', array('message' => $msg));
         }
-        
+
         $this->showInstructions();
 
         common_element_start('div', array('id' => 'content_inner'));
@@ -169,19 +169,19 @@ class FacebookAction extends Action
         common_element_start('form', array('method' => 'post',
                                                'id' => 'login',
                                                'action' => 'index.php'));
-    
+
         common_element_start('fieldset');
         common_element('legend', null, _('Login to site'));
-        
+
         common_element_start('ul', array('class' => 'form_datas'));
-        common_element_start('li');                                             
+        common_element_start('li');
         common_input('nickname', _('Nickname'));
         common_element_end('li');
         common_element_start('li');
         common_password('password', _('Password'));
         common_element_end('li');
         common_element_end('ul');
-        
+
         common_submit('submit', _('Login'));
         common_element_end('form');
 
@@ -189,7 +189,7 @@ class FacebookAction extends Action
         common_element('a', array('href' => common_local_url('recoverpassword')),
                        _('Lost or forgotten password?'));
         common_element_end('p');
-        
+
         common_element_end('div');
 
         common_end_xml();

lib/facebookutil.php

@@ -21,6 +21,8 @@ require_once INSTALLDIR.'/extlib/facebook/facebook.php';
 require_once INSTALLDIR.'/lib/noticelist.php';
 
 define("FACEBOOK_SERVICE", 2); // Facebook is foreign_service ID 2
+define("FACEBOOK_NOTICE_PREFIX", 1);
+define("FACEBOOK_PROMPTED_UPDATE_PREF", 2);
 
 // Gets all the notices from users with a Facebook link since a given ID
 function get_facebook_notices($since)
@@ -106,18 +108,18 @@ function update_profile_box($facebook, $fbuid, $user, $notice)
 }
 
 function getFacebookCSS()
-{    
+{
     # Add a timestamp to the CSS file so Facebook cache wont ignore our changes
     $ts = filemtime(theme_file('facebookapp.css'));
-    $cssurl = theme_path('facebookapp.css') . "?ts=$ts";   
+    $cssurl = theme_path('facebookapp.css') . "?ts=$ts";
     return $cssurl;
 }
 
 function getFacebookJS() {
-    
+
     # Add a timestamp to the FBJS file so Facebook cache wont ignore our changes
     $ts = filemtime(INSTALLDIR.'/js/facebookapp.js');
-    $jsurl = common_path('js/facebookapp.js') . "?ts=$ts";   
+    $jsurl = common_path('js/facebookapp.js') . "?ts=$ts";
     return $jsurl;
 }
 
@@ -157,7 +159,7 @@ class FacebookNoticeList extends NoticeList
 
         return $cnt;
     }
-    
+
     /**
      * returns a new list item for the current notice
      *
@@ -173,7 +175,7 @@ class FacebookNoticeList extends NoticeList
     {
         return new FacebookNoticeListItem($notice);
     }
-    
+
 }
 
 class FacebookNoticeListItem extends NoticeListItem
@@ -190,7 +192,7 @@ class FacebookNoticeListItem extends NoticeListItem
     function show()
     {
         $this->showStart();
-        
+
         common_element_start('div', 'entry-title');
         $this->showAuthor();
         $this->showContent();
@@ -201,10 +203,10 @@ class FacebookNoticeListItem extends NoticeListItem
         $this->showNoticeSource();
         $this->showReplyTo();
         common_element_end('div');
-        
+
         $this->showEnd();
     }
-    
+
     function showStart()
     {
         // XXX: RDFa
@@ -222,9 +224,9 @@ class FacebookNoticeListItem extends NoticeListItem
             preg_match('/^http/', $this->notice->uri)) {
             $noticeurl = $this->notice->uri;
         }
-        
+
         common_element_start('dl', 'timestamp');
-        common_element('dt', null, _('Published')); 
+        common_element('dt', null, _('Published'));
         common_element_start('dd', null);
         common_element_start('a', array('rel' => 'bookmark',
                                         'href' => $noticeurl));
@@ -237,5 +239,5 @@ class FacebookNoticeListItem extends NoticeListItem
         common_element_end('dl');
     }
 
-} 
+}