f9aafd73bb18ad9fa47ea6582d4a67893ebe47dc
[hermes] / package / src / org / maemo / hermes / engine / facebook / provider.py
1 from facebook import Facebook, FacebookError
2 import gnome.gconf
3 import gtk, hildon
4 import org.maemo.hermes.engine.provider
5 import org.maemo.hermes.engine.facebook.service
6
7 class Provider(org.maemo.hermes.engine.provider.Provider):
8     """Facebook provider for Hermes. 
9
10        This requires two gconf paths to contain Facebook application keys:
11            /apps/maemo/hermes/facebook_app
12            /apps/maemo/hermes/facebook_secret
13        
14        Copyright (c) Andrew Flegg <andrew@bleb.org> 2010.
15        Released under the Artistic Licence."""
16
17     # -----------------------------------------------------------------------
18     def __init__(self):
19         """Initialise the provider, and ensure the environment is going to work."""
20
21         self._gc = gnome.gconf.client_get_default()
22
23         key_app    = self._gc.get_string('/apps/maemo/hermes/facebook_app')
24         key_secret = self._gc.get_string('/apps/maemo/hermes/facebook_secret')
25         if key_app is None or key_secret is None:
26             raise Exception('No Facebook application keys found. Installation error.')
27         
28         self.fb = Facebook(key_app, key_secret)
29         self.fb.desktop = True
30
31         if self.fb.session_key is None:
32             self.fb.session_key = self._gc.get_string('/apps/maemo/hermes/facebook_session_key')
33             self.fb.secret = self._gc.get_string('/apps/maemo/hermes/facebook_secret_key')
34             self.fb.uid = self._gc.get_string('/apps/maemo/hermes/facebook_uid')
35
36
37     # -----------------------------------------------------------------------
38     def get_name(self):
39         """Return the display name of this service. An icon, of with the lower-case,
40            all-alphabetic version of this name is expected to be provided."""
41            
42         return 'Facebook'
43
44     
45     # -----------------------------------------------------------------------
46     def get_account_detail(self):
47         """Return the email address associated with the user, if available."""
48         
49         name = self._gc.get_string('/apps/maemo/hermes/facebook_user')
50         return name and name or _('Pending authorisation')
51     
52     
53     # -----------------------------------------------------------------------
54     def has_preferences(self):
55         """Whether or not this provider has any preferences. If it does not,
56            open_preferences must NOT be called; as the behaviour is undetermined."""
57            
58         return True
59     
60     
61     # -----------------------------------------------------------------------
62     def open_preferences(self, parent):
63         """Open the preferences for this provider as a child of the 'parent' widget."""
64
65         dialog = gtk.Dialog(self.get_name(), parent)
66         dialog.add_button(_('Clear'), gtk.RESPONSE_OK)
67         dialog.add_button(_('Disable'), gtk.RESPONSE_NO)
68         dialog.add_button(_('Enable'), gtk.RESPONSE_YES)
69         
70         checkbox = hildon.CheckButton(gtk.HILDON_SIZE_FINGER_HEIGHT)
71         checkbox.set_label(_('Create birthday-only contacts'))
72         checkbox.set_active(self._gc.get_bool('/apps/maemo/hermes/facebook_birthday_only'))
73         dialog.vbox.add(checkbox)
74         dialog.vbox.add(gtk.Label("\n" + _('Note: authentication via web page') + "\n\n\n"))
75         
76         while True:
77             dialog.show_all()
78             result = dialog.run()
79             dialog.hide()
80             if result == gtk.RESPONSE_CANCEL or result == gtk.RESPONSE_DELETE_EVENT:
81                 return None
82             elif result == gtk.RESPONSE_OK:
83                 self._gc.unset('/apps/maemo/hermes/facebook_session_key')
84                 self._gc.unset('/apps/maemo/hermes/facebook_secret_key')
85                 self._gc.unset('/apps/maemo/hermes/facebook_uid')
86                 self._gc.unset('/apps/maemo/hermes/facebook_user')
87             else:
88                 break
89     
90         self._gc.set_bool('/apps/maemo/hermes/facebook_birthday_only', checkbox.get_active())
91         return result == gtk.RESPONSE_YES
92         
93     
94     # -----------------------------------------------------------------------
95     def service(self, gui_callback):
96         """Return a service instance."""
97         
98         self._gui = gui_callback
99         
100         # Check the available session is still valid...
101         while True:
102             try:
103                 if self.fb.users.getLoggedInUser() and self.fb.session_key:
104                     break
105             except FacebookError:
106                 pass
107             self._do_fb_login()
108
109         return org.maemo.hermes.engine.facebook.service.Service(self.fb)
110
111
112     # -----------------------------------------------------------------------
113     def _do_fb_login(self):
114         """Perform authentication against Facebook and store the result in gconf
115              for later use. Uses the 'need_auth' and 'block_for_auth' methods on
116              the callback class. The former allows a message to warn the user
117              about what is about to happen to be shown; the second is to wait
118              for the user to confirm they have logged in."""
119         self.fb.session_key = None
120         self.fb.secret = None
121         self.fb.uid = None
122         
123         if self._gui:
124             self._gui.need_auth()
125             
126         self.fb.auth.createToken()
127         self.fb.login()
128         
129         if self._gui:
130             self._gui.block_for_auth()
131           
132         session = self.fb.auth.getSession()
133         self._gc.set_string('/apps/maemo/hermes/facebook_session_key', session['session_key'])
134         self._gc.set_string('/apps/maemo/hermes/facebook_secret_key', session['secret'])
135         self._gc.set_string('/apps/maemo/hermes/facebook_uid', str(session['uid']))
136
137         info = self.fb.users.getInfo([self.fb.uid], ['name'])
138         self._gc.set_string('/apps/maemo/hermes/facebook_user', info[0]['name'])
139