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
19
from bzrlib.config import parse_username
21
from bzrlib.plugins.gtk.i18n import _i18n
22
from bzrlib.plugins.gtk.avatarproviders import (
23
AvatarProviderGravatar,
24
AvatarDownloaderWorker,
28
class Avatar(Gtk.HBox):
29
""" Author or committer avatar """
31
def __init__(self, apparent_username):
33
Gtk.HBox.__init__(self)
35
self.apparent_username = apparent_username
36
self.username, self.email = parse_username(apparent_username)
39
def __eq__(self, other):
40
return (self.apparent_username == other.apparent_username and
41
self.username == other.username and
42
self.email == other.email)
44
def show_spinner(self):
46
Replace the current content of the Avatar with a Gtk.Spinner
47
if an email address has been parsed. If not, show an Gtk.Label with
48
the translatable 'No email' text.
51
tooltip = _i18n("Retrieving avatar for %s...") % self.email
52
spinner = Gtk.Spinner()
54
self.pack_start(spinner, False, True, 0)
55
spinner.set_tooltip_text(tooltip)
56
spinner.set_size_request(20, 20)
59
no_email = Gtk.Label(label=_i18n("No email"))
60
self.pack_start(no_email, True, True, 0)
61
self.set_tooltip_text(self.apparent_username)
65
"""Replace the current content of the Avatar with the Gtk.Image """
66
if self.email and self.image:
67
self.remove(self.get_children()[0])
68
self.pack_start(self.image, True, True, 0)
69
self.image.set_tooltip_text(self.apparent_username)
73
class AvatarBox(Gtk.HBox):
74
"""HBox showing an avatar."""
76
def __init__(self, homogeneous=False, spacing=0):
77
Gtk.HBox.__init__(self, homogeneous=homogeneous, spacing=spacing)
80
self.__displaying = None
83
"""Remove current avatars from the gtk box."""
84
for child in self.get_children():
86
self.__displaying = None
88
def have_avatar(self, avatar):
89
"""Return True if this box has the specified avatar.
91
return avatar.email in self.__avatars
93
def showing(self, avatar):
94
"""Return True if the displaying avatar matches the specified one.
96
return self.__displaying and self.__displaying == avatar
98
def append_avatars_with(self, avatar):
100
Append avatars collection with the given one if not already registed
101
otherwise render it back.
102
When an avatar is added this method True, otherwise, if the avatar
103
was in the collection, return False.
105
if avatar.email and not avatar.email in self.__avatars:
106
self.__avatars[avatar.email] = avatar
107
self._new_cell_for_avatar(avatar)
110
self.and_avatar_email(avatar.email).come_back_to_gui()
113
def and_avatar_email(self, email):
115
Select the avatar from avatars collection
116
in order to apply future actions
119
if email and email in self.__avatars:
120
self.avatar = self.__avatars[email]
125
def update_avatar_image_from_pixbuf_loader(self, loader):
126
"""Replace the Gtk.Spinner with the given loader."""
128
self.avatar.image = Gtk.Image()
129
self.avatar.image.set_from_pixbuf(loader.get_pixbuf())
130
self.avatar.show_image()
131
self.__displaying = self.avatar
133
def come_back_to_gui(self):
134
"""Render back avatar in the GUI."""
136
self.pack_start(self.avatar, True, True, 0)
137
self.__displaying = self.avatar
139
self._show_no_email()
141
def _new_cell_for_avatar(self, avatar):
142
"""Create a new cell in this box with a Gtk.Spinner."""
143
avatar.show_spinner()
144
self.pack_start(avatar, True, True, 0)
146
self.__displaying = avatar
148
def _show_no_email(self):
149
"""Show a Gtk.Label with test 'No email'."""
150
no_email = Gtk.Label(label=_i18n("No email"))
151
self.pack_start(no_email, True, True, 0)
155
class AvatarsBox(Gtk.HBox):
156
"""GTK container for author and committer avatars."""
159
Gtk.HBox.__init__(self, homogeneous=False, spacing=10)
161
self.__committer_box = None
162
self.__authors_box = None
165
# If more later you want to implement more avatar providers:
166
# * Create a new class named AvatarProvider + provider_name that
167
# inherit from the AvatarProvider class.
168
# * Implement a method that return url to use in the request.
170
# For example, with Gravatar, the method return the complete url
171
# with MD5 hash of the email address and put the value in a
173
# Then create a new worker (manage them in a python dictionary).
174
provider = AvatarProviderGravatar()
175
self.__worker = AvatarDownloaderWorker(
176
provider.gravatar_id_for_email
178
# This callback method should be fired by all workers when a request
180
self.__worker.set_callback_method(self._update_avatar_from_response)
181
self.__worker.start()
183
def add(self, username, role):
184
"""Add the given username in the role box and add in the worker queue.
186
avatar = Avatar(username)
187
if (role == "author" and not self._role_box_for("committer").showing(avatar)) or role == "committer":
188
if self._role_box_for(role).append_avatars_with(avatar):
189
self.__worker.queue(avatar.email)
191
def merge(self, usernames, role):
192
"""Add avatars from a list"""
193
for username in usernames:
194
self.add(username, role)
198
Request a reset view for all boxes in order to show only avatars
199
of the selected line in the revision view screen.
201
for role in ("committer", "author"):
202
self._role_box_for(role).reset_view()
205
"""Create boxes where avatars will be displayed."""
206
# 2 Gtk.HBox: One for the committer and one for authors
208
self.__committer_box = AvatarBox()
209
self.__committer_box.set_size_request(80, 80)
210
self.pack_end(self.__committer_box, False, True, 0)
211
self.__committer_box.show()
213
self.__authors_box = AvatarBox()
214
self.pack_end(self.__authors_box, False, True, 0)
215
self.__authors_box.set_spacing(10)
216
self.__authors_box.show()
218
def _update_avatar_from_response(self, response, email):
219
"""Callback method fired by avatar worker when finished.
221
:param response: a urllib2.urlopen() return value.
222
:param email: used to identify item from self.__avatars.
224
# XXX sinzui 2011-08-01: This must be implemented in cairo
226
# # Convert downloaded image from provider to Gtk.Image
227
# loader = Gdk.GdkPixbuf.PixbufLoader()
228
# loader.write(response.read())
231
# for role in ["committer", "author"]:
232
# self._role_box_for(role).and_avatar_email(email).update_avatar_image_from_pixbuf_loader(loader)
234
def _role_box_for(self, role):
235
""" Return the Gtk.HBox for the given role """
236
if role == "committer":
237
return self.__committer_box
239
return self.__authors_box
added
removed
avatarsbox.py
