straw/feedproperties.py

   1 """ FeedPropertiesDialog.py
   2
   3 Provides a module for handling the properties of a feed
   4 """
   5 __copyright__ = "Copyright (c) 2002-2005 Free Software Foundation, Inc."
   6 __license__ = """
   7 Straw is free software; you can redistribute it and/or modify it under the
   8 terms of the GNU General Public License as published by the Free Software
   9 Foundation; either version 2 of the License, or (at your option) any later
  10 version.
  11
  12 Straw is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License along with
  17 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  18 Place - Suite 330, Boston, MA 02111-1307, USA. """
  19
  20
  21 import os, os.path
  22 import gettext
  23 from error import log, logparam, logtb
  24 from xml.sax import saxutils
  25 import gtk
  26 from gtk.glade import XML
  27 import gobject
  28 import time
  29
  30 import Config
  31 import SummaryParser
  32 import MVP
  33
  34 import straw.defs
  35 from straw import helpers
  36
  37 class FeedPropertyView(MVP.GladeView):
  38
  39     COLUMN_NAME = 0
  40     COLUMN_MEMBER = 1
  41     COLUMN_OBJECT = 2
  42
  43     def _initialize(self):
  44         self._feed = None
  45         self._defaults = {'title':'','url':'','username':'','password':''}
  46         self._window = self._widget.get_widget('feed_properties')
  47
  48         self._title_entry = self._widget.get_widget('title_entry')
  49         self._location_entry = self._widget.get_widget('location_entry')
  50         self._website_entry = self._widget.get_widget('website_entry')
  51         self._description_label = self._widget.get_widget('description_label')
  52         self._copyright_label = self._widget.get_widget('copyright_label')
  53
  54         self._username = self._widget.get_widget('properties_username_entry')
  55         self._password = self._widget.get_widget('properties_password_entry')
  56
  57         self._next_refresh_label = self._widget.get_widget('properties_next_refresh_label')
  58         self._previous_refresh_label = self._widget.get_widget('properties_previous_refresh_label')
  59
  60         self._restore_button = self._widget.get_widget('properties_reset_button')
  61         self._refresh_spin = self._widget.get_widget('properties_refresh_spin')
  62         self._articles_spin = self._widget.get_widget('properties_articles_spin')
  63         self._refresh_default_check = self._widget.get_widget('properties_keep_refresh_default')
  64         self._articles_default_check = self._widget.get_widget('properties_keep_articles_default')
  65
  66     def set_feed(self, feed):
  67         self._feed = feed
  68
  69     def show(self):
  70         self._initializing_window = True
  71         self.display_properties()
  72         self._window.present()
  73         self._initializing_window = False
  74
  75     def hide(self, *args):
  76         self._window.hide()
  77         self._window.destroy()
  78
  79     def _on_feed_properties_delete_event(self, *args):
  80         self.hide()
  81         return True
  82
  83     def _on_properties_close_button_clicked(self, *args):
  84         self.hide()
  85         return
  86
  87     def _on_location_button_clicked(self, *args):
  88         helpers.url_show(self._location_entry.get_text())
  89
  90     def _on_website_button_clicked(self, *args):
  91         helpers.url_show(self._website_entry.get_text())
  92
  93     def display_properties(self):
  94         self._window.set_title(_("%s Properties") % self._feed.title)
  95
  96         self._title_entry.set_text(self._feed.title)
  97         self._location_entry.set_text(self._feed.location)
  98         self._description_label.set_text(self._feed.description)
  99         self._copyright_label.set_text(self._feed.copyright)
 100
 101         self._website_entry.set_text(self._feed.link)
 102
 103         """self._defaults['title'] = self._feed.title
 104         loc, un, pw = "", "", ""#self._feed.access_info
 105         self._defaults['url'] = loc
 106         self._defaults['username'] = un
 107         self._defaults['password'] = pw
 108         self._defaults['frequency'] = self._feed.poll_frequency
 109         self._defaults['stored'] = self._feed.number_of_items_stored
 110
 111         self._title.set_text(self._feed.title)
 112         self._location.set_text(self._feed.access_info[0])
 113
 114         config = Config.get_instance()
 115         if self._feed.poll_frequency == feeds.Feed.DEFAULT:
 116             freq = config.poll_frequency
 117             fdefault = True
 118             self._refresh_keep = True
 119         else:
 120             freq = self._feed.poll_frequency
 121             fdefault = False
 122             self._refresh_keep = False
 123         self._refresh_spin.set_value(float(freq / 60))
 124         self._refresh_spin.set_sensitive(not fdefault)
 125         self._refresh_default_check.set_active(fdefault)
 126         if self._feed.number_of_items_stored == feeds.Feed.DEFAULT:
 127             nitems = config.number_of_items_stored
 128             nidefault = True
 129             self._articles_keep = True
 130         else:
 131             nitems = self._feed.number_of_items_stored
 132             nidefault = False
 133             self._articles_keep = False
 134         self._articles_spin.set_value(float(nitems))
 135         self._articles_spin.set_sensitive(not nidefault)
 136         self._articles_default_check.set_active(nidefault)
 137
 138         if un:
 139             self._username.set_text(un)
 140         if pw:
 141             self._password.set_text(pw)
 142
 143         model = self._categories_treeview.get_model()
 144         model.clear()
 145         fclist = feeds.category_list
 146         for c in fclist.user_categories:
 147             iter = model.append()
 148             model.set(iter,
 149                       self.COLUMN_NAME, c.title,
 150                       self.COLUMN_MEMBER, self._feed in c.feeds,
 151                       self.COLUMN_OBJECT, c)
 152
 153         self._previous_refresh_label.set_text(
 154             helpers.format_date(time.gmtime(self._feed.last_poll)))
 155         next = self._feed.next_refresh
 156         if next:
 157             self._next_refresh_label.set_text(
 158                 helpers.format_date(time.gmtime(next)))
 159             self._next_refresh_label.show()
 160         else:
 161             self._next_refresh_label.hide()
 162
 163         description = helpers.convert_entities(feed.channel_description.strip())
 164         if description and description != title:
 165             description = read_text(description, len(description))
 166             self._feed_info_description.set_text(helpers.convert_entities(description))
 167             self._feed_info_description.show()
 168         else:
 169             self._feed_info_description.hide()
 170
 171         copyright = helpers.convert_entities(feed.channel_copyright)
 172         if copyright:
 173             self._feed_info_copyright.set_text(copyright)
 174             self._feed_info_copyright.show()
 175         else:
 176             self._feed_info_copyright.hide()"""
 177
 178     def _load_uri(self, widget, event):
 179         helpers.url_show(widget.get_uri())
 180
 181     def restore_defaults(self):
 182         # FIXME: add frequency and number of items and the default flags
 183         self._feed.title = self._defaults['title']
 184         self._feed.access_info = (
 185             self._defaults['url'], self._defaults['username'], self._defaults['password'])
 186         self._title.set_text(self._feed.title)
 187         self._location.set_text(self._feed.location)
 188         self._username.set_text(self._defaults.get('username',''))
 189         self._password.set_text(self._defaults.get('password',''))
 190         self._refresh_default_check.set_active(self._refresh_keep)
 191         if not self._refresh_keep:
 192             self._refresh_spin.set_value(float(self._refresh_default))
 193         self._articles_default_check.set_active(self._articles_keep)
 194         if not self._articles_keep:
 195             self._articles_spin.set_value(float(self._articles_default))
 196         self._restore_button.set_sensitive(False)
 197
 198     def _on_close_button_clicked(self, *args):
 199         self.hide()
 200
 201     def _on_properties_title_entry_insert_text(self, *args):
 202         if self._initializing_window:
 203             return
 204         self._restore_button.set_sensitive(True)
 205
 206     def _on_properties_title_entry_delete_text(self, *args):
 207         if self._initializing_window:
 208             return
 209         self._restore_button.set_sensitive(True)
 210
 211     def _on_properties_title_entry_focus_out_event(self, widget, *args):
 212         self._feed.title = widget.get_text().strip()
 213
 214     def _on_properties_location_entry_insert_text(self, *args):
 215         if self._initializing_window:
 216             return
 217         self._restore_button.set_sensitive(True)
 218
 219     def _on_properties_location_entry_delete_text(self, *args):
 220         if self._initializing_window:
 221             return
 222         self._restore_button.set_sensitive(True)
 223
 224     def _on_properties_location_entry_focus_out_event(self, widget, *args):
 225         loc, username, pw = self._feed.access_info
 226         self._feed.access_info = (widget.get_text().strip(), username, pw)
 227
 228     def _on_properties_username_entry_insert_text(self, *args):
 229         if self._initializing_window:
 230             return
 231         self._restore_button.set_sensitive(True)
 232
 233     def _on_properties_username_entry_delete_text(self, *args):
 234         if self._initializing_window:
 235             return
 236         self._restore_button.set_sensitive(False)
 237
 238     def _on_properties_username_entry_focus_out_event(self, widget, *args):
 239         self._presenter.set_username(widget.get_text().strip())
 240
 241     def _on_properties_password_entry_insert_text(self, *args):
 242         if self._initializing_window:
 243             return
 244         self._restore_button.set_sensitive(True)
 245
 246     def _on_properties_password_entry_delete_text(self, *args):
 247         if self._initializing_window:
 248             return
 249         self._restore_button.set_sensitive(False)
 250
 251     def _on_properties_password_entry_focus_out_event(self, widget, *args):
 252         self._presenter.set_password(widget.get_text().strip())
 253
 254     def _on_properties_reset_button_clicked(self, *args):
 255         self.restore_defaults()
 256
 257     def _on_properties_refresh_spin_focus_out_event(self, widget, *args):
 258         widget.update()
 259         value = widget.get_value_as_int()
 260         self._presenter.set_poll_frequency(value)
 261
 262     def _on_properties_articles_spin_focus_out_event(self, widget, *args):
 263         widget.update()
 264         value = widget.get_value_as_int()
 265         self._presenter.set_items_stored(value)
 266
 267     def _on_properties_articles_spin_value_changed(self, widget, *args):
 268         if self._initializing_window:
 269             return
 270         self._restore_button.set_sensitive(True)
 271
 272     def _on_properties_refresh_spin_value_changed(self, widget, *args):
 273         if self._initializing_window:
 274             return
 275         self._restore_button.set_sensitive(True)
 276
 277     def _on_properties_keep_refresh_default_toggled(self, widget, *args):
 278         if self._initializing_window:
 279             return
 280         isactive = widget.get_active()
 281         if isactive:
 282             self._presenter.set_poll_frequency(feeds.Feed.DEFAULT)
 283             self._refresh_spin.set_value(float(Config.get_instance().poll_frequency / 60))
 284         else:
 285             self._presenter.set_poll_frequency(self._refresh_spin.get_value_as_int() * 60)
 286
 287         self._refresh_spin.set_sensitive(not isactive)
 288         self._restore_button.set_sensitive(True)
 289
 290     def _on_properties_keep_articles_default_toggled(self, widget, *args):
 291         if self._initializing_window:
 292             return
 293         isactive = widget.get_active()
 294         if isactive:
 295             self._presenter.set_items_stored(feeds.Feed.DEFAULT)
 296             self._articles_spin.set_value(float(Config.get_instance().number_of_items_stored))
 297         else:
 298             self._presenter.set_items_stored(self._articles_spin.get_value_as_int())
 299         self._articles_spin.set_sensitive(not isactive)
 300         self._restore_button.set_sensitive(True)
 301
 302
 303 class FeedPropertyPresenter(MVP.BasicPresenter):
 304
 305     TIME_INTERVAL = 60
 306
 307     def _initialize(self):
 308         self._feed = None
 309
 310     def set_feed(self, feed):
 311         self._feed = feed
 312         self._view.set_feed(self._feed)
 313
 314     def set_username(self, username):
 315         loc, uname, pw = self._feed.access_info
 316         self._feed.access_info = (loc, username, pw)
 317
 318     def set_password(self, password):
 319         loc, uname, pw = self._feed.access_info
 320         self._feed.access_info = (loc, uname, password)
 321
 322     def set_poll_frequency(self, pf):
 323         if pf != self._feed.poll_frequency:
 324             self._feed.poll_frequency = pf * FeedPropertyPresenter.TIME_INTERVAL
 325
 326     def set_items_stored(self, nitems):
 327         if nitems != self._feed.number_of_items_stored:
 328             self._feed.number_of_items_stored = nitems
 329
 330 def feed_properties_show(feed):
 331     gladefile = XML(os.path.join(straw.defs.STRAW_DATA_DIR, "feed-properties.glade"))
 332     dialog = FeedPropertyPresenter(view=FeedPropertyView(gladefile))
 333     dialog.set_feed(feed)
 334
 335     dialog.view.show()
 336
 337 def read_text(fragment, chars):
 338     """Read chars cdata characters from html fragment fragment"""
 339     parser = SummaryParser.TitleImgParser()
 340     parser.feed(fragment)
 341     text = parser.get_text(chars)
 342     parser.close()
 343     return text