1
# Copyright (C) 2011 by Guillaume Hain (zedtux) <zedtux@zedroot.org>
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
from gi.repository import Gtk
18
from gi.repository import GdkPixbuf
20
from bzrlib.config import parse_username
22
from bzrlib.plugins.gtk.i18n import _i18n
23
from bzrlib.plugins.gtk.avatarproviders import (
24
AvatarProviderGravatar,
25
AvatarDownloaderWorker,
29
class Avatar(Gtk.HBox):
30
""" Author or committer avatar """
32
def __init__(self, apparent_username):
34
Gtk.HBox.__init__(self)
36
self.apparent_username = apparent_username
37
self.username, self.email = parse_username(apparent_username)
40
def __eq__(self, other):
41
return (self.apparent_username == other.apparent_username and
42
self.username == other.username and
43
self.email == other.email)
45
def show_spinner(self):
47
Replace the current content of the Avatar with a Gtk.Spinner
48
if an email address has been parsed. If not, show an Gtk.Label with
49
the translatable 'No email' text.
52
tooltip = _i18n("Retrieving avatar for %s...") % self.email
53
spinner = Gtk.Spinner()
55
self.pack_start(spinner, False, True, 0)
56
spinner.set_tooltip_text(tooltip)
57
spinner.set_size_request(20, 20)
60
no_email = Gtk.Label(label=_i18n("No email"))
61
self.pack_start(no_email, True, True, 0)
62
self.set_tooltip_text(self.apparent_username)
66
"""Replace the current content of the Avatar with the Gtk.Image """
67
if self.email and self.image:
68
children = self.get_children()
70
self.remove(children[0])
71
self.pack_start(self.image, True, True, 0)
72
self.image.set_tooltip_text(self.apparent_username)
76
class AvatarBox(Gtk.HBox):
77
"""HBox showing an avatar."""
79
def __init__(self, homogeneous=False, spacing=0):
80
Gtk.HBox.__init__(self, homogeneous=homogeneous, spacing=spacing)
83
self.__displaying = None
86
"""Remove current avatars from the gtk box."""
87
for child in self.get_children():
89
self.__displaying = None
91
def have_avatar(self, avatar):
92
"""Return True if this box has the specified avatar.
94
return avatar.email in self.__avatars
96
def showing(self, avatar):
97
"""Return True if the displaying avatar matches the specified one.
99
return self.__displaying and self.__displaying == avatar
101
def append_avatars_with(self, avatar):
103
Append avatars collection with the given one if not already registed
104
otherwise render it back.
105
When an avatar is added this method True, otherwise, if the avatar
106
was in the collection, return False.
108
if avatar.email and not avatar.email in self.__avatars:
109
self.__avatars[avatar.email] = avatar
110
self._new_cell_for_avatar(avatar)
113
self.and_avatar_email(avatar.email).come_back_to_gui()
116
def and_avatar_email(self, email):
118
Select the avatar from avatars collection
119
in order to apply future actions
122
if email and email in self.__avatars:
123
self.avatar = self.__avatars[email]
128
def update_avatar_image_from_pixbuf_loader(self, loader):
129
"""Replace the Gtk.Spinner with the given loader."""
131
self.avatar.image = Gtk.Image()
132
self.avatar.image.set_from_pixbuf(loader.get_pixbuf())
133
self.avatar.show_image()
134
self.__displaying = self.avatar
136
def come_back_to_gui(self):
137
"""Render back avatar in the GUI."""
139
self.pack_start(self.avatar, True, True, 0)
140
self.__displaying = self.avatar
142
self._show_no_email()
144
def _new_cell_for_avatar(self, avatar):
145
"""Create a new cell in this box with a Gtk.Spinner."""
146
avatar.show_spinner()
147
self.pack_start(avatar, True, True, 0)
149
self.__displaying = avatar
151
def _show_no_email(self):
152
"""Show a Gtk.Label with text 'No email'."""
153
no_email = Gtk.Label(label=_i18n("No email"))
154
self.pack_start(no_email, True, True, 0)
158
class AvatarsBox(Gtk.HBox):
159
"""GTK container for author and committer avatars."""
162
super(AvatarsBox, self).__init__(homogeneous=False, spacing=10)
163
self.__committer_box = None
164
self.__authors_box = None
167
# If more later you want to implement more avatar providers:
168
# * Create a new class named AvatarProvider + provider_name that
169
# inherit from the AvatarProvider class.
170
# * Implement a method that return url to use in the request.
172
# For example, with Gravatar, the method return the complete url
173
# with MD5 hash of the email address and put the value in a
175
# Then create a new worker (manage them in a python dictionary).
176
provider = AvatarProviderGravatar()
177
self.__worker = AvatarDownloaderWorker(
178
provider.gravatar_id_for_email
180
# This callback method should be fired by all workers when a request
182
self.__worker.set_callback_method(self._update_avatar_from_response)
183
self.connect('destroy', self.on_destroy)
185
def on_destroy(self, widget):
187
if self.__worker.is_alive():
190
def add(self, username, role):
191
"""Add the given username in the role box and add in the worker queue.
193
avatar = Avatar(username)
194
is_shown = self._role_box_for("committer").showing(avatar)
195
if (role == "author" and not is_shown) or role == "committer":
196
if self._role_box_for(role).append_avatars_with(avatar):
197
self.__worker.queue(avatar.email)
199
def merge(self, usernames, role):
200
"""Add avatars from a list"""
201
for username in usernames:
202
self.add(username, role)
206
Request a reset view for all boxes in order to show only avatars
207
of the selected line in the revision view screen.
209
for role in ("committer", "author"):
210
self._role_box_for(role).reset_view()
213
"""Create boxes where avatars will be displayed."""
214
# 2 Gtk.HBox: One for the committer and one for authors
216
self.__committer_box = AvatarBox()
217
self.__committer_box.set_size_request(80, 80)
218
self.pack_end(self.__committer_box, False, True, 0)
219
self.__committer_box.show()
221
self.__authors_box = AvatarBox()
222
self.pack_end(self.__authors_box, False, True, 0)
223
self.__authors_box.set_spacing(10)
224
self.__authors_box.show()
226
def _update_avatar_from_response(self, response, email):
227
"""Callback method fired by avatar worker when finished.
229
:param response: a urllib2.urlopen() return value.
230
:param email: used to identify item from self.__avatars.
233
# Convert downloaded image from provider to Gtk.Image
234
loader = GdkPixbuf.PixbufLoader()
235
loader.write(response.read())
238
for role in ["committer", "author"]:
239
self._role_box_for(role).and_avatar_email(
240
email).update_avatar_image_from_pixbuf_loader(loader)
242
def _role_box_for(self, role):
243
""" Return the Gtk.HBox for the given role """
244
if role == "committer":
245
return self.__committer_box
247
return self.__authors_box
added
removed
avatarsbox.py
