1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
# ReleaseNotesViewer.py
#
# Copyright (c) 2006 Sebastian Heinlein
#
# Author: Sebastian Heinlein <sebastian.heinlein@web.de>
#
# This modul provides an inheritance of the gtk.TextView that is
# aware of http URLs and allows to open them in a browser.
# It is based on the pygtk-demo "hypertext".
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; either version 2 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
# USA
import pygtk
import gtk
import pango
import subprocess
import os
class ReleaseNotesViewer(gtk.TextView):
def __init__(self, notes):
"""Init the ReleaseNotesViewer as an Inheritance of the gtk.TextView.
Load the notes into the buffer and make links clickable"""
# init the parent
gtk.TextView.__init__(self)
# global hovering over link state
self.hovering = False
self.first = True
# setup the buffer and signals
self.set_property("editable", False)
self.set_cursor_visible(False)
self.buffer = gtk.TextBuffer()
self.set_buffer(self.buffer)
self.buffer.set_text(notes)
self.connect("event-after", self.event_after)
self.connect("motion-notify-event", self.motion_notify_event)
self.connect("visibility-notify-event", self.visibility_notify_event)
# search for links in the notes and make them clickable
self.search_links()
def tag_link(self, start, end, url):
"""Apply the tag that marks links to the specified buffer selection"""
tag = self.buffer.create_tag(None, foreground="blue",
underline=pango.UNDERLINE_SINGLE)
tag.set_data("url", url)
self.buffer.apply_tag(tag , start, end)
def search_links(self):
"""Search for http URLs in the buffer and call the tag_link method
for each one to tag them as links"""
# start at the beginning of the buffer
iter = self.buffer.get_iter_at_offset(0)
while 1:
# search for the next URL in the buffer
ret = iter.forward_search("http://", gtk.TEXT_SEARCH_VISIBLE_ONLY,
None)
# if we reach the end break the loop
if not ret:
break
# get the position of the protocol prefix
(match_start, match_end) = ret
match_tmp = match_end.copy()
while 1:
# extend the selection to the complete URL
if match_tmp.forward_char():
text = match_end.get_text(match_tmp)
if text in (" ", ")", "]", "\n", "\t"):
break
else:
break
match_end = match_tmp.copy()
# call the tagging method for the complete URL
url = match_start.get_text(match_end)
self.tag_link(match_start, match_end, url)
# set the starting point for the next search
iter = match_end
def event_after(self, text_view, event):
"""callback for mouse click events"""
# we only react on left mouse clicks
if event.type != gtk.gdk.BUTTON_RELEASE:
return False
if event.button != 1:
return False
# try to get a selection
try:
(start, end) = self.buffer.get_selection_bounds()
except ValueError:
pass
else:
if start.get_offset() != end.get_offset():
return False
# get the iter at the mouse position
(x, y) = self.window_to_buffer_coords(gtk.TEXT_WINDOW_WIDGET,
int(event.x), int(event.y))
iter = self.get_iter_at_location(x, y)
# call open_url if an URL is assigned to the iter
tags = iter.get_tags()
for tag in tags:
url = tag.get_data("url")
if url != "":
self.open_url(url)
break
def open_url(self, url):
"""Open the specified URL in a browser"""
# Find an appropiate browser
if os.path.exists('usr/bin/gnome-open'):
command = ['gnome-open', url]
else:
command = ['x-www-browser', url]
# Avoid to run the browser as user root
if os.getuid() == 0 and os.environ.has_key('SUDO_USER'):
command = ['sudo', '-u', os.environ['SUDO_USER']] + command
subprocess.Popen(command)
def motion_notify_event(self, text_view, event):
"""callback for the mouse movement event, that calls the
check_hovering method with the mouse postition coordiantes"""
x, y = text_view.window_to_buffer_coords(gtk.TEXT_WINDOW_WIDGET,
int(event.x), int(event.y))
self.check_hovering(x, y)
self.window.get_pointer()
return False
def visibility_notify_event(self, text_view, event):
"""callback if the widgets gets visible (e.g. moves to the foreground)
that calls the check_hovering method with the mouse position
coordinates"""
(wx, wy, mod) = text_view.window.get_pointer()
(bx, by) = text_view.window_to_buffer_coords(gtk.TEXT_WINDOW_WIDGET, wx,
wy)
self.check_hovering(bx, by)
return False
def check_hovering(self, x, y):
"""Check if the mouse is above a tagged link and if yes show
a hand cursor"""
_hovering = False
# get the iter at the mouse position
iter = self.get_iter_at_location(x, y)
# set _hovering if the iter has the tag "url"
tags = iter.get_tags()
for tag in tags:
url = tag.get_data("url")
if url != "":
_hovering = True
break
# change the global hovering state
if _hovering != self.hovering or self.first == True:
self.first = False
self.hovering = _hovering
# Set the appropriate cursur icon
if self.hovering:
self.get_window(gtk.TEXT_WINDOW_TEXT).\
set_cursor(gtk.gdk.Cursor(gtk.gdk.HAND2))
else:
self.get_window(gtk.TEXT_WINDOW_TEXT).\
set_cursor(gtk.gdk.Cursor(gtk.gdk.LEFT_PTR))
|
