straw/feedproperties.py

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