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 GObject
18
from gi.repository import Gtk
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
GObject.GObject.__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.name == other.name 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
if getattr(gtk, "Spinner", False):
54
spinner = Gtk.Spinner()
56
self.pack_start(spinner, False)
57
spinner.set_tooltip_text(tooltip)
58
spinner.set_size_request(20, 20)
61
spinner = Gtk.Label(label=tooltip)
62
self.pack_start(spinner, True, True, 0)
63
self.set_tooltip_text(self.apparent_username)
66
no_email = Gtk.Label(label=_i18n("No email"))
67
self.pack_start(no_email, True, True, 0)
68
self.set_tooltip_text(self.apparent_username)
72
"""Replace the current content of the Avatar with the Gtk.Image """
73
if self.email and self.image:
74
self.remove(self.get_children()[0])
75
self.pack_start(self.image, True, True, 0)
76
self.image.set_tooltip_text(self.apparent_username)
80
class AvatarBox(Gtk.HBox):
81
"""HBox showing an avatar."""
83
def __init__(self, homogeneous=False, spacing=0):
84
GObject.GObject.__init__(self, homogeneous, spacing)
87
self.__displaying = None
90
"""Remove current avatars from the gtk box."""
91
for child in self.get_children():
93
self.__displaying = None
95
def have_avatar(self, avatar):
96
"""Return True if this box has the specified avatar.
98
return avatar.email in self.__avatars
100
def showing(self, avatar):
101
"""Return True if the displaying avatar matches the specified one.
103
return self.__displaying and self.__displaying == avatar
105
def append_avatars_with(self, avatar):
107
Append avatars collection with the given one if not already registed
108
otherwise render it back.
109
When an avatar is added this method True, otherwise, if the avatar
110
was in the collection, return False.
112
if avatar.email and not avatar.email in self.__avatars:
113
self.__avatars[avatar.email] = avatar
114
self._new_cell_for_avatar(avatar)
117
self.and_avatar_email(avatar.email).come_back_to_gui()
120
def and_avatar_email(self, email):
122
Select the avatar from avatars collection
123
in order to apply future actions
126
if email and email in self.__avatars:
127
self.avatar = self.__avatars[email]
132
def update_avatar_image_from_pixbuf_loader(self, loader):
133
"""Replace the Gtk.Spinner with the given loader."""
135
self.avatar.image = Gtk.Image()
136
self.avatar.image.set_from_pixbuf(loader.get_pixbuf())
137
self.avatar.show_image()
138
self.__displaying = self.avatar
140
def come_back_to_gui(self):
141
"""Render back avatar in the GUI."""
143
self.pack_start(self.avatar, True, True, 0)
144
self.__displaying = self.avatar
146
self._show_no_email()
148
def _new_cell_for_avatar(self, avatar):
149
"""Create a new cell in this box with a Gtk.Spinner."""
150
avatar.show_spinner()
151
self.pack_start(avatar, True, True, 0)
153
self.__displaying = avatar
155
def _show_no_email(self):
156
"""Show a Gtk.Label with test 'No email'."""
157
no_email = Gtk.Label(label=_i18n("No email"))
158
self.pack_start(no_email, True, True, 0)
162
class AvatarsBox(Gtk.HBox):
163
"""GTK container for author and committer avatars."""
166
GObject.GObject.__init__(self, False, 10)
168
self.__committer_box = None
169
self.__authors_box = None
172
# If more later you want to implement more avatar providers:
173
# * Create a new class named AvatarProvider + provider_name that
174
# inherit from the AvatarProvider class.
175
# * Implement a method that return url to use in the request.
177
# For example, with Gravatar, the method return the complete url
178
# with MD5 hash of the email address and put the value in a
180
# Then create a new worker (manage them in a python dictionary).
181
provider = AvatarProviderGravatar()
182
self.__worker = AvatarDownloaderWorker(
183
provider.gravatar_id_for_email
185
# This callback method should be fired by all workers when a request
187
self.__worker.set_callback_method(self._update_avatar_from_response)
188
self.__worker.start()
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
if (role == "author" and not self._role_box_for("committer").showing(avatar)) or role == "committer":
195
if self._role_box_for(role).append_avatars_with(avatar):
196
self.__worker.queue(avatar.email)
198
def merge(self, usernames, role):
199
"""Add avatars from a list"""
200
for username in usernames:
201
self.add(username, role)
205
Request a reset view for all boxes in order to show only avatars
206
of the selected line in the revision view screen.
208
for role in ("committer", "author"):
209
self._role_box_for(role).reset_view()
212
"""Create boxes where avatars will be displayed."""
213
# 2 Gtk.HBox: One for the committer and one for authors
215
self.__committer_box = AvatarBox()
216
self.__committer_box.set_size_request(80, 80)
217
self.pack_end(self.__committer_box, False)
218
self.__committer_box.show()
220
self.__authors_box = AvatarBox()
221
self.pack_end(self.__authors_box, False)
222
self.__authors_box.set_spacing(10)
223
self.__authors_box.show()
225
def _update_avatar_from_response(self, response, email):
226
"""Callback method fired by avatar worker when finished.
228
:param response: a urllib2.urlopen() return value.
229
:param email: used to identify item from self.__avatars.
232
# Convert downloaded image from provider to Gtk.Image
233
loader = GdkPixbuf.PixbufLoader()
234
loader.write(response.read())
237
for role in ["committer", "author"]:
238
self._role_box_for(role).and_avatar_email(email).update_avatar_image_from_pixbuf_loader(loader)
240
def _role_box_for(self, role):
241
""" Return the Gtk.HBox for the given role """
242
if role == "committer":
243
return self.__committer_box
245
return self.__authors_box
added
removed
avatarsbox.py
