From 06b64b39de411a80e2fbe013c1ec52c3dc604d17 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Fri, 24 Jun 2011 20:19:18 -0600 Subject: [PATCH 01/24] ... --- src/calibre/ebooks/comic/input.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/calibre/ebooks/comic/input.py b/src/calibre/ebooks/comic/input.py index 5203e3698d..f6833ca197 100755 --- a/src/calibre/ebooks/comic/input.py +++ b/src/calibre/ebooks/comic/input.py @@ -351,7 +351,9 @@ class ComicInput(InputFormatPlugin): comics = [] with CurrentDir(tdir): if not os.path.exists('comics.txt'): - raise ValueError('%s is not a valid comic collection' + raise ValueError(( + '%s is not a valid comic collection' + ' no comics.txt was found in the file') %stream.name) raw = open('comics.txt', 'rb').read() if raw.startswith(codecs.BOM_UTF16_BE): From 10d354b15079fb247384d7bb602309a228428d19 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Fri, 24 Jun 2011 22:46:46 -0600 Subject: [PATCH 02/24] Fix renaming items via the Tag Browser broken --- src/calibre/gui2/tag_view.py | 1 - 1 file changed, 1 deletion(-) diff --git a/src/calibre/gui2/tag_view.py b/src/calibre/gui2/tag_view.py index 730c91d37f..caf9e1b95d 100644 --- a/src/calibre/gui2/tag_view.py +++ b/src/calibre/gui2/tag_view.py @@ -1493,7 +1493,6 @@ class TagsModel(QAbstractItemModel): # {{{ self.tags_view.tag_item_renamed.emit() item.tag.name = val self.rename_item_in_all_user_categories(name, key, val) - self.refresh_required.emit() self.show_item_at_path(path) return True From 5bb81ed5a51e6c0f8bd4d15c4713a57d25637602 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Fri, 24 Jun 2011 22:47:10 -0600 Subject: [PATCH 03/24] ... --- src/calibre/gui2/update.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/calibre/gui2/update.py b/src/calibre/gui2/update.py index c9a908bdf6..d0399c6cc1 100644 --- a/src/calibre/gui2/update.py +++ b/src/calibre/gui2/update.py @@ -74,7 +74,7 @@ class UpdateNotification(QDialog): 'See the new features.') + '

'+_('Update only if one of the ' 'new features or bug fixes is important to you. ' - 'If the current version works well for you, do not update.'))%( + 'If the current version works well for you, there is no need to update.'))%( __appname__, calibre_version)) self.label.setOpenExternalLinks(True) self.label.setWordWrap(True) From 2dd8ff2c44881e2c6f7e31fd28e2ddd724953aa4 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Fri, 24 Jun 2011 22:47:59 -0600 Subject: [PATCH 04/24] Do not allow users to override the builtin recipe files --- src/calibre/web/feeds/recipes/collection.py | 4 ++-- src/calibre/web/feeds/recipes/model.py | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/src/calibre/web/feeds/recipes/collection.py b/src/calibre/web/feeds/recipes/collection.py index 87a65dd9e6..13bae3a554 100644 --- a/src/calibre/web/feeds/recipes/collection.py +++ b/src/calibre/web/feeds/recipes/collection.py @@ -85,7 +85,7 @@ def serialize_builtin_recipes(): return serialize_collection(recipe_mapping) def get_builtin_recipe_collection(): - return etree.parse(P('builtin_recipes.xml')).getroot() + return etree.parse(P('builtin_recipes.xml', allow_user_override=False)).getroot() def get_custom_recipe_collection(*args): from calibre.web.feeds.recipes import compile_recipe, \ @@ -179,7 +179,7 @@ def download_builtin_recipe(urn): return br.open_novisit('http://status.calibre-ebook.com/recipe/'+urn).read() def get_builtin_recipe(urn): - with zipfile.ZipFile(P('builtin_recipes.zip'), 'r') as zf: + with zipfile.ZipFile(P('builtin_recipes.zip', allow_user_override=False), 'r') as zf: return zf.read(urn+'.recipe') def get_builtin_recipe_by_title(title, log=None, download_recipe=False): diff --git a/src/calibre/web/feeds/recipes/model.py b/src/calibre/web/feeds/recipes/model.py index 2c52c85f83..5f8d906e61 100644 --- a/src/calibre/web/feeds/recipes/model.py +++ b/src/calibre/web/feeds/recipes/model.py @@ -140,7 +140,8 @@ class RecipeModel(QAbstractItemModel, SearchQueryParser): self.builtin_recipe_collection = get_builtin_recipe_collection() self.scheduler_config = SchedulerConfig() try: - with zipfile.ZipFile(P('builtin_recipes.zip'), 'r') as zf: + with zipfile.ZipFile(P('builtin_recipes.zip', + allow_user_override=False), 'r') as zf: self.favicons = dict([(x.filename, x) for x in zf.infolist() if x.filename.endswith('.png')]) except: @@ -181,7 +182,7 @@ class RecipeModel(QAbstractItemModel, SearchQueryParser): def do_refresh(self, restrict_to_urns=set([])): self.custom_recipe_collection = get_custom_recipe_collection() - zf = P('builtin_recipes.zip') + zf = P('builtin_recipes.zip', allow_user_override=False) def factory(cls, parent, *args): args = list(args) From 30a2aa6253c696be1e82ffdb6d0e672561e7b98d Mon Sep 17 00:00:00 2001 From: Charles Haley <> Date: Sat, 25 Jun 2011 09:34:58 +0100 Subject: [PATCH 05/24] Make clicking on first letter nodes in the tag browser work better --- src/calibre/gui2/tag_view.py | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/src/calibre/gui2/tag_view.py b/src/calibre/gui2/tag_view.py index caf9e1b95d..5d6b4cc597 100644 --- a/src/calibre/gui2/tag_view.py +++ b/src/calibre/gui2/tag_view.py @@ -1686,10 +1686,19 @@ class TagsModel(QAbstractItemModel): # {{{ if self.collapse_model == 'first letter' and \ tag_item.temporary and not key.startswith('@') \ and tag_item.tag.state: - if node_searches[tag_item.tag.state] == 'true': - ans.append('%s:~^%s'%(key, tag_item.py_name)) + k = 'author_sort' if key == 'authors' else key + letters_seen = {} + for subnode in tag_item.children: + letters_seen[subnode.tag.sort[0]] = True + charclass = ''.join(letters_seen) + if k == 'author_sort': + expr = r'%s:"~(^[%s])|(&\\s*[%s])"'%(k, charclass, charclass) else: - ans.append('(not %s:~^%s )'%(key, tag_item.py_name)) + expr = r'%s:"~^[%s]"'%(k, charclass) + if node_searches[tag_item.tag.state] == 'true': + ans.append(expr) + else: + ans.append('(not ' + expr + ')') continue tag = tag_item.tag if tag.state != TAG_SEARCH_STATES['clear']: From 1341f26acd1a892a9b0e2e711bc392f9a943ee16 Mon Sep 17 00:00:00 2001 From: Charles Haley <> Date: Sat, 25 Jun 2011 09:47:33 +0100 Subject: [PATCH 06/24] Correct fix for tag browser rename exception --- src/calibre/gui2/tag_view.py | 1 + 1 file changed, 1 insertion(+) diff --git a/src/calibre/gui2/tag_view.py b/src/calibre/gui2/tag_view.py index 5d6b4cc597..d368f9c3d5 100644 --- a/src/calibre/gui2/tag_view.py +++ b/src/calibre/gui2/tag_view.py @@ -1493,6 +1493,7 @@ class TagsModel(QAbstractItemModel): # {{{ self.tags_view.tag_item_renamed.emit() item.tag.name = val self.rename_item_in_all_user_categories(name, key, val) + self.tags_view.refresh_required.emit() self.show_item_at_path(path) return True From c69fcc1d137ce4d15b592cd52426b99132dae496 Mon Sep 17 00:00:00 2001 From: Charles Haley <> Date: Sat, 25 Jun 2011 10:59:46 +0100 Subject: [PATCH 07/24] Make new days_between function return a float instead of an int. --- src/calibre/utils/formatter_functions.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/calibre/utils/formatter_functions.py b/src/calibre/utils/formatter_functions.py index 63264e6379..55bad6c7e8 100644 --- a/src/calibre/utils/formatter_functions.py +++ b/src/calibre/utils/formatter_functions.py @@ -785,7 +785,7 @@ class BuiltinDaysBetween(BuiltinFormatterFunction): except: return '' i = d1 - d2 - return str(i.days) + return str('%d.%d'%(i.days, i.seconds/8640)) builtin_add = BuiltinAdd() From bd6a14069d205258920b6d0f85e7ba9be42b0e82 Mon Sep 17 00:00:00 2001 From: Charles Haley <> Date: Sat, 25 Jun 2011 12:03:30 +0100 Subject: [PATCH 08/24] Improve positioning of tag browser after a refresh --- src/calibre/gui2/tag_view.py | 1 + 1 file changed, 1 insertion(+) diff --git a/src/calibre/gui2/tag_view.py b/src/calibre/gui2/tag_view.py index d368f9c3d5..21029da68c 100644 --- a/src/calibre/gui2/tag_view.py +++ b/src/calibre/gui2/tag_view.py @@ -1831,6 +1831,7 @@ class TagsModel(QAbstractItemModel): # {{{ if idx.isValid(): self.tags_view.setCurrentIndex(idx) self.tags_view.scrollTo(idx, position) + self.tags_view.setCurrentIndex(idx) if box: tag_item = idx.internalPointer() tag_item.boxed = True From 81283ff687ec18a078011944ff658631360282b2 Mon Sep 17 00:00:00 2001 From: Charles Haley <> Date: Sat, 25 Jun 2011 12:03:58 +0100 Subject: [PATCH 09/24] Make db2.set_metadata not issue notifies when calling set_custom --- src/calibre/library/database2.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/calibre/library/database2.py b/src/calibre/library/database2.py index a3211b3817..8b4ad47284 100644 --- a/src/calibre/library/database2.py +++ b/src/calibre/library/database2.py @@ -2012,7 +2012,7 @@ class LibraryDatabase2(LibraryDatabase, SchemaUpgrade, CustomColumns): val = mi.get(key, None) if force_changes or val is not None: doit(self.set_custom, id, val=val, extra=mi.get_extra(key), - label=user_mi[key]['label'], commit=False) + label=user_mi[key]['label'], commit=False, notify=False) if commit: self.conn.commit() if notify: From 278f3d8127193be97c3cf8d19c12f8a8da3a60fe Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Sat, 25 Jun 2011 09:23:48 -0600 Subject: [PATCH 10/24] Remove the delete library functionality from calibre --- src/calibre/gui2/actions/choose_library.py | 25 ++++++++-------------- 1 file changed, 9 insertions(+), 16 deletions(-) diff --git a/src/calibre/gui2/actions/choose_library.py b/src/calibre/gui2/actions/choose_library.py index 32460b6bec..f96a261790 100644 --- a/src/calibre/gui2/actions/choose_library.py +++ b/src/calibre/gui2/actions/choose_library.py @@ -5,7 +5,7 @@ __license__ = 'GPL v3' __copyright__ = '2010, Kovid Goyal ' __docformat__ = 'restructuredtext en' -import os, shutil +import os from functools import partial from PyQt4.Qt import QMenu, Qt, QInputDialog, QToolButton @@ -14,7 +14,7 @@ from calibre import isbytestring from calibre.constants import filesystem_encoding, iswindows from calibre.utils.config import prefs from calibre.gui2 import (gprefs, warning_dialog, Dispatcher, error_dialog, - question_dialog, info_dialog) + question_dialog, info_dialog, open_local_file) from calibre.library.database2 import LibraryDatabase2 from calibre.gui2.actions import InterfaceAction @@ -107,7 +107,7 @@ class ChooseLibraryAction(InterfaceAction): self.quick_menu_action = self.choose_menu.addMenu(self.quick_menu) self.rename_menu = QMenu(_('Rename library')) self.rename_menu_action = self.choose_menu.addMenu(self.rename_menu) - self.delete_menu = QMenu(_('Delete library')) + self.delete_menu = QMenu(_('Remove library')) self.delete_menu_action = self.choose_menu.addMenu(self.delete_menu) ac = self.create_action(spec=(_('Pick a random book'), 'catalog.png', @@ -252,22 +252,15 @@ class ChooseLibraryAction(InterfaceAction): def delete_requested(self, name, location): loc = location.replace('/', os.sep) - if not question_dialog(self.gui, _('Are you sure?'), - _('

WARNING

')+ - _('All files (not just ebooks) ' - 'from

%s

will be ' - 'permanently deleted. Are you sure?') % loc, - show_copy_button=False, default_yes=False): - return - exists = self.gui.library_view.model().db.exists_at(loc) - if exists: - try: - shutil.rmtree(loc, ignore_errors=True) - except: - pass self.stats.remove(location) self.build_menus() self.gui.iactions['Copy To Library'].build_menus() + info_dialog(self.gui, _('Library removed'), + _('The library %s has been removed from calibre. ' + 'The files remain on your computer, if you want ' + 'to delete them, you will have to do so manually.') % loc, + show=True) + open_local_file(loc) def backup_status(self, location): dirty_text = 'no' From 80025fe5d54532a248ccb8f436a535e5e12eaf34 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Sat, 25 Jun 2011 10:20:49 -0600 Subject: [PATCH 11/24] Split up Tag Browser code --- src/calibre/gui2/init.py | 2 +- src/calibre/gui2/tag_browser/__init__.py | 11 + .../{tag_view.py => tag_browser/model.py} | 1041 +---------------- src/calibre/gui2/tag_browser/ui.py | 458 ++++++++ src/calibre/gui2/tag_browser/view.py | 578 +++++++++ src/calibre/gui2/ui.py | 2 +- 6 files changed, 1067 insertions(+), 1025 deletions(-) create mode 100644 src/calibre/gui2/tag_browser/__init__.py rename src/calibre/gui2/{tag_view.py => tag_browser/model.py} (54%) create mode 100644 src/calibre/gui2/tag_browser/ui.py create mode 100644 src/calibre/gui2/tag_browser/view.py diff --git a/src/calibre/gui2/init.py b/src/calibre/gui2/init.py index 874be6832f..67b4d5edd6 100644 --- a/src/calibre/gui2/init.py +++ b/src/calibre/gui2/init.py @@ -16,7 +16,7 @@ from calibre.constants import isosx, __appname__, preferred_encoding, \ from calibre.gui2 import config, is_widescreen, gprefs from calibre.gui2.library.views import BooksView, DeviceBooksView from calibre.gui2.widgets import Splitter -from calibre.gui2.tag_view import TagBrowserWidget +from calibre.gui2.tag_browser.ui import TagBrowserWidget from calibre.gui2.book_details import BookDetails from calibre.gui2.notify import get_notifier diff --git a/src/calibre/gui2/tag_browser/__init__.py b/src/calibre/gui2/tag_browser/__init__.py new file mode 100644 index 0000000000..cc6da1e995 --- /dev/null +++ b/src/calibre/gui2/tag_browser/__init__.py @@ -0,0 +1,11 @@ +#!/usr/bin/env python +# vim:fileencoding=UTF-8:ts=4:sw=4:sta:et:sts=4:ai +from __future__ import (unicode_literals, division, absolute_import, + print_function) + +__license__ = 'GPL v3' +__copyright__ = '2011, Kovid Goyal ' +__docformat__ = 'restructuredtext en' + + + diff --git a/src/calibre/gui2/tag_view.py b/src/calibre/gui2/tag_browser/model.py similarity index 54% rename from src/calibre/gui2/tag_view.py rename to src/calibre/gui2/tag_browser/model.py index 21029da68c..7f02518b80 100644 --- a/src/calibre/gui2/tag_view.py +++ b/src/calibre/gui2/tag_browser/model.py @@ -1,596 +1,30 @@ -#!/usr/bin/env python +#!/usr/bin/env python +# vim:fileencoding=UTF-8:ts=4:sw=4:sta:et:sts=4:ai +from __future__ import (unicode_literals, division, absolute_import, + print_function) + __license__ = 'GPL v3' -__copyright__ = '2008, Kovid Goyal kovid@kovidgoyal.net' +__copyright__ = '2011, Kovid Goyal ' __docformat__ = 'restructuredtext en' -''' -Browsing book collection by tags. -''' +import traceback, cPickle, copy +from itertools import repeat, izip -import traceback, copy, cPickle +from PyQt4.Qt import (QAbstractItemModel, QIcon, QVariant, QFont, Qt, + QMimeData, QModelIndex, QTreeView) -from itertools import izip, repeat -from functools import partial - -from PyQt4.Qt import (Qt, QTreeView, QApplication, pyqtSignal, QFont, QSize, - QIcon, QPoint, QVBoxLayout, QHBoxLayout, QComboBox, QTimer, - QAbstractItemModel, QVariant, QModelIndex, QMenu, QFrame, - QWidget, QItemDelegate, QString, QLabel, QPushButton, - QShortcut, QKeySequence, SIGNAL, QMimeData, QToolButton) - -from calibre.ebooks.metadata import title_sort -from calibre.gui2 import config, NONE, gprefs -from calibre.library.field_metadata import TagsIcons, category_icon_map +from calibre.gui2 import NONE, gprefs, config, error_dialog from calibre.library.database2 import Tag from calibre.utils.config import tweaks from calibre.utils.icu import sort_key, lower, strcmp -from calibre.utils.search_query_parser import saved_searches -from calibre.utils.formatter import eval_formatter -from calibre.gui2 import error_dialog, question_dialog +from calibre.library.field_metadata import TagsIcons, category_icon_map from calibre.gui2.dialogs.confirm_delete import confirm -from calibre.gui2.dialogs.tag_categories import TagCategories -from calibre.gui2.dialogs.tag_list_editor import TagListEditor -from calibre.gui2.dialogs.edit_authors_dialog import EditAuthorsDialog -from calibre.gui2.widgets import HistoryLineEdit - -class TagDelegate(QItemDelegate): # {{{ - - def paint(self, painter, option, index): - item = index.internalPointer() - if item.type != TagTreeItem.TAG: - QItemDelegate.paint(self, painter, option, index) - return - r = option.rect - model = self.parent().model() - icon = model.data(index, Qt.DecorationRole).toPyObject() - painter.save() - if item.tag.state != 0 or not config['show_avg_rating'] or \ - item.tag.avg_rating is None: - icon.paint(painter, r, Qt.AlignLeft) - else: - painter.setOpacity(0.3) - icon.paint(painter, r, Qt.AlignLeft) - painter.setOpacity(1) - rating = item.tag.avg_rating - painter.setClipRect(r.left(), r.bottom()-int(r.height()*(rating/5.0)), - r.width(), r.height()) - icon.paint(painter, r, Qt.AlignLeft) - painter.setClipRect(r) - - # Paint the text - if item.boxed: - painter.drawRoundedRect(r.adjusted(1,1,-1,-1), 5, 5) - r.setLeft(r.left()+r.height()+3) - painter.drawText(r, Qt.AlignLeft|Qt.AlignVCenter, - model.data(index, Qt.DisplayRole).toString()) - painter.restore() - - # }}} +from calibre.utils.formatter import eval_formatter +from calibre.utils.search_query_parser import saved_searches TAG_SEARCH_STATES = {'clear': 0, 'mark_plus': 1, 'mark_plusplus': 2, 'mark_minus': 3, 'mark_minusminus': 4} -class TagsView(QTreeView): # {{{ - - refresh_required = pyqtSignal() - tags_marked = pyqtSignal(object) - edit_user_category = pyqtSignal(object) - delete_user_category = pyqtSignal(object) - del_item_from_user_cat = pyqtSignal(object, object, object) - add_item_to_user_cat = pyqtSignal(object, object, object) - add_subcategory = pyqtSignal(object) - tag_list_edit = pyqtSignal(object, object) - saved_search_edit = pyqtSignal(object) - rebuild_saved_searches = pyqtSignal() - author_sort_edit = pyqtSignal(object, object) - tag_item_renamed = pyqtSignal() - search_item_renamed = pyqtSignal() - drag_drop_finished = pyqtSignal(object) - restriction_error = pyqtSignal() - - def __init__(self, parent=None): - QTreeView.__init__(self, parent=None) - self.tag_match = None - self.disable_recounting = False - self.setUniformRowHeights(True) - self.setCursor(Qt.PointingHandCursor) - self.setIconSize(QSize(30, 30)) - self.setTabKeyNavigation(True) - self.setAlternatingRowColors(True) - self.setAnimated(True) - self.setHeaderHidden(True) - self.setItemDelegate(TagDelegate(self)) - self.made_connections = False - self.setAcceptDrops(True) - self.setDragEnabled(True) - self.setDragDropMode(self.DragDrop) - self.setDropIndicatorShown(True) - self.setAutoExpandDelay(500) - self.pane_is_visible = False - if gprefs['tags_browser_collapse_at'] == 0: - self.collapse_model = 'disable' - else: - self.collapse_model = gprefs['tags_browser_partition_method'] - self.search_icon = QIcon(I('search.png')) - self.user_category_icon = QIcon(I('tb_folder.png')) - self.delete_icon = QIcon(I('list_remove.png')) - self.rename_icon = QIcon(I('edit-undo.png')) - - def set_pane_is_visible(self, to_what): - pv = self.pane_is_visible - self.pane_is_visible = to_what - if to_what and not pv: - self.recount() - - def reread_collapse_parameters(self): - if gprefs['tags_browser_collapse_at'] == 0: - self.collapse_model = 'disable' - else: - self.collapse_model = gprefs['tags_browser_partition_method'] - self.set_new_model(self._model.get_filter_categories_by()) - - def set_database(self, db, tag_match, sort_by): - hidden_cats = db.prefs.get('tag_browser_hidden_categories', None) - self.hidden_categories = [] - # migrate from config to db prefs - if hidden_cats is None: - hidden_cats = config['tag_browser_hidden_categories'] - # strip out any non-existence field keys - for cat in hidden_cats: - if cat in db.field_metadata: - self.hidden_categories.append(cat) - db.prefs.set('tag_browser_hidden_categories', list(self.hidden_categories)) - self.hidden_categories = set(self.hidden_categories) - - old = getattr(self, '_model', None) - if old is not None: - old.break_cycles() - self._model = TagsModel(db, parent=self, - hidden_categories=self.hidden_categories, - search_restriction=None, - drag_drop_finished=self.drag_drop_finished, - collapse_model=self.collapse_model, - state_map={}) - self.pane_is_visible = True # because TagsModel.init did a recount - self.sort_by = sort_by - self.tag_match = tag_match - self.db = db - self.search_restriction = None - self.setModel(self._model) - self.setContextMenuPolicy(Qt.CustomContextMenu) - pop = config['sort_tags_by'] - self.sort_by.setCurrentIndex(self.db.CATEGORY_SORTS.index(pop)) - try: - match_pop = self.db.MATCH_TYPE.index(config['match_tags_type']) - except ValueError: - match_pop = 0 - self.tag_match.setCurrentIndex(match_pop) - if not self.made_connections: - self.clicked.connect(self.toggle) - self.customContextMenuRequested.connect(self.show_context_menu) - self.refresh_required.connect(self.recount, type=Qt.QueuedConnection) - self.sort_by.currentIndexChanged.connect(self.sort_changed) - self.tag_match.currentIndexChanged.connect(self.match_changed) - self.made_connections = True - self.refresh_signal_processed = True - db.add_listener(self.database_changed) - self.expanded.connect(self.item_expanded) - - def database_changed(self, event, ids): - if self.refresh_signal_processed: - self.refresh_signal_processed = False - self.refresh_required.emit() - - @property - def match_all(self): - return self.tag_match and self.tag_match.currentIndex() > 0 - - def sort_changed(self, pop): - config.set('sort_tags_by', self.db.CATEGORY_SORTS[pop]) - self.recount() - - def match_changed(self, pop): - try: - config.set('match_tags_type', self.db.MATCH_TYPE[pop]) - except: - pass - - def set_search_restriction(self, s): - if s: - self.search_restriction = s - else: - self.search_restriction = None - self.set_new_model() - - def mouseReleaseEvent(self, event): - # Swallow everything except leftButton so context menus work correctly - if event.button() == Qt.LeftButton: - QTreeView.mouseReleaseEvent(self, event) - - def mouseDoubleClickEvent(self, event): - # swallow these to avoid toggling and editing at the same time - pass - - @property - def search_string(self): - tokens = self._model.tokens() - joiner = ' and ' if self.match_all else ' or ' - return joiner.join(tokens) - - def toggle(self, index): - self._toggle(index, None) - - def _toggle(self, index, set_to): - ''' - set_to: if None, advance the state. Otherwise must be one of the values - in TAG_SEARCH_STATES - ''' - modifiers = int(QApplication.keyboardModifiers()) - exclusive = modifiers not in (Qt.CTRL, Qt.SHIFT) - if self._model.toggle(index, exclusive, set_to=set_to): - self.tags_marked.emit(self.search_string) - - def conditional_clear(self, search_string): - if search_string != self.search_string: - self.clear() - - def context_menu_handler(self, action=None, category=None, - key=None, index=None, search_state=None): - if not action: - return - try: - if action == 'edit_item': - self.edit(index) - return - if action == 'open_editor': - self.tag_list_edit.emit(category, key) - return - if action == 'manage_categories': - self.edit_user_category.emit(category) - return - if action == 'search': - self._toggle(index, set_to=search_state) - return - if action == 'add_to_category': - tag = index.tag - if len(index.children) > 0: - for c in index.children: - self.add_item_to_user_cat.emit(category, c.tag.original_name, - c.tag.category) - self.add_item_to_user_cat.emit(category, tag.original_name, - tag.category) - return - if action == 'add_subcategory': - self.add_subcategory.emit(key) - return - if action == 'search_category': - self._toggle(index, set_to=search_state) - return - if action == 'delete_user_category': - self.delete_user_category.emit(key) - return - if action == 'delete_search': - saved_searches().delete(key) - self.rebuild_saved_searches.emit() - return - if action == 'delete_item_from_user_category': - tag = index.tag - if len(index.children) > 0: - for c in index.children: - self.del_item_from_user_cat.emit(key, c.tag.original_name, - c.tag.category) - self.del_item_from_user_cat.emit(key, tag.original_name, tag.category) - return - if action == 'manage_searches': - self.saved_search_edit.emit(category) - return - if action == 'edit_author_sort': - self.author_sort_edit.emit(self, index) - return - - if action == 'hide': - self.hidden_categories.add(category) - elif action == 'show': - self.hidden_categories.discard(category) - elif action == 'categorization': - changed = self.collapse_model != category - self.collapse_model = category - if changed: - self.set_new_model(self._model.get_filter_categories_by()) - gprefs['tags_browser_partition_method'] = category - elif action == 'defaults': - self.hidden_categories.clear() - self.db.prefs.set('tag_browser_hidden_categories', list(self.hidden_categories)) - self.set_new_model() - except: - return - - def show_context_menu(self, point): - def display_name( tag): - if tag.category == 'search': - n = tag.name - if len(n) > 45: - n = n[:45] + '...' - return "'" + n + "'" - return tag.name - - index = self.indexAt(point) - self.context_menu = QMenu(self) - - if index.isValid(): - item = index.internalPointer() - tag = None - - if item.type == TagTreeItem.TAG: - tag_item = item - tag = item.tag - while item.type != TagTreeItem.CATEGORY: - item = item.parent - - if item.type == TagTreeItem.CATEGORY: - if not item.category_key.startswith('@'): - while item.parent != self._model.root_item: - item = item.parent - category = unicode(item.name.toString()) - key = item.category_key - # Verify that we are working with a field that we know something about - if key not in self.db.field_metadata: - return True - - # Did the user click on a leaf node? - if tag: - # If the user right-clicked on an editable item, then offer - # the possibility of renaming that item. - if tag.is_editable: - # Add the 'rename' items - self.context_menu.addAction(self.rename_icon, - _('Rename %s')%display_name(tag), - partial(self.context_menu_handler, action='edit_item', - index=index)) - if key == 'authors': - self.context_menu.addAction(_('Edit sort for %s')%display_name(tag), - partial(self.context_menu_handler, - action='edit_author_sort', index=tag.id)) - - # is_editable is also overloaded to mean 'can be added - # to a user category' - m = self.context_menu.addMenu(self.user_category_icon, - _('Add %s to user category')%display_name(tag)) - nt = self.model().category_node_tree - def add_node_tree(tree_dict, m, path): - p = path[:] - for k in sorted(tree_dict.keys(), key=sort_key): - p.append(k) - n = k[1:] if k.startswith('@') else k - m.addAction(self.user_category_icon, n, - partial(self.context_menu_handler, - 'add_to_category', - category='.'.join(p), index=tag_item)) - if len(tree_dict[k]): - tm = m.addMenu(self.user_category_icon, - _('Children of %s')%n) - add_node_tree(tree_dict[k], tm, p) - p.pop() - add_node_tree(nt, m, []) - elif key == 'search': - self.context_menu.addAction(self.rename_icon, - _('Rename %s')%display_name(tag), - partial(self.context_menu_handler, action='edit_item', - index=index)) - self.context_menu.addAction(self.delete_icon, - _('Delete search %s')%display_name(tag), - partial(self.context_menu_handler, - action='delete_search', key=tag.name)) - if key.startswith('@') and not item.is_gst: - self.context_menu.addAction(self.user_category_icon, - _('Remove %s from category %s')% - (display_name(tag), item.py_name), - partial(self.context_menu_handler, - action='delete_item_from_user_category', - key = key, index = tag_item)) - # Add the search for value items. All leaf nodes are searchable - self.context_menu.addAction(self.search_icon, - _('Search for %s')%display_name(tag), - partial(self.context_menu_handler, action='search', - search_state=TAG_SEARCH_STATES['mark_plus'], - index=index)) - self.context_menu.addAction(self.search_icon, - _('Search for everything but %s')%display_name(tag), - partial(self.context_menu_handler, action='search', - search_state=TAG_SEARCH_STATES['mark_minus'], - index=index)) - self.context_menu.addSeparator() - elif key.startswith('@') and not item.is_gst: - if item.can_be_edited: - self.context_menu.addAction(self.rename_icon, - _('Rename %s')%item.py_name, - partial(self.context_menu_handler, action='edit_item', - index=index)) - self.context_menu.addAction(self.user_category_icon, - _('Add sub-category to %s')%item.py_name, - partial(self.context_menu_handler, - action='add_subcategory', key=key)) - self.context_menu.addAction(self.delete_icon, - _('Delete user category %s')%item.py_name, - partial(self.context_menu_handler, - action='delete_user_category', key=key)) - self.context_menu.addSeparator() - # Hide/Show/Restore categories - self.context_menu.addAction(_('Hide category %s') % category, - partial(self.context_menu_handler, action='hide', - category=key)) - if self.hidden_categories: - m = self.context_menu.addMenu(_('Show category')) - for col in sorted(self.hidden_categories, - key=lambda x: sort_key(self.db.field_metadata[x]['name'])): - m.addAction(self.db.field_metadata[col]['name'], - partial(self.context_menu_handler, action='show', category=col)) - - # search by category. Some categories are not searchable, such - # as search and news - if item.tag.is_searchable: - self.context_menu.addAction(self.search_icon, - _('Search for books in category %s')%category, - partial(self.context_menu_handler, - action='search_category', - index=self._model.createIndex(item.row(), 0, item), - search_state=TAG_SEARCH_STATES['mark_plus'])) - self.context_menu.addAction(self.search_icon, - _('Search for books not in category %s')%category, - partial(self.context_menu_handler, - action='search_category', - index=self._model.createIndex(item.row(), 0, item), - search_state=TAG_SEARCH_STATES['mark_minus'])) - # Offer specific editors for tags/series/publishers/saved searches - self.context_menu.addSeparator() - if key in ['tags', 'publisher', 'series'] or \ - self.db.field_metadata[key]['is_custom']: - self.context_menu.addAction(_('Manage %s')%category, - partial(self.context_menu_handler, action='open_editor', - category=tag.original_name if tag else None, - key=key)) - elif key == 'authors': - self.context_menu.addAction(_('Manage %s')%category, - partial(self.context_menu_handler, action='edit_author_sort')) - elif key == 'search': - self.context_menu.addAction(_('Manage Saved Searches'), - partial(self.context_menu_handler, action='manage_searches', - category=tag.name if tag else None)) - - # Always show the user categories editor - self.context_menu.addSeparator() - if key.startswith('@') and \ - key[1:] in self.db.prefs.get('user_categories', {}).keys(): - self.context_menu.addAction(_('Manage User Categories'), - partial(self.context_menu_handler, action='manage_categories', - category=key[1:])) - else: - self.context_menu.addAction(_('Manage User Categories'), - partial(self.context_menu_handler, action='manage_categories', - category=None)) - - if self.hidden_categories: - if not self.context_menu.isEmpty(): - self.context_menu.addSeparator() - self.context_menu.addAction(_('Show all categories'), - partial(self.context_menu_handler, action='defaults')) - - m = self.context_menu.addMenu(_('Change sub-categorization scheme')) - da = m.addAction('Disable', - partial(self.context_menu_handler, action='categorization', category='disable')) - fla = m.addAction('By first letter', - partial(self.context_menu_handler, action='categorization', category='first letter')) - pa = m.addAction('Partition', - partial(self.context_menu_handler, action='categorization', category='partition')) - if self.collapse_model == 'disable': - da.setCheckable(True) - da.setChecked(True) - elif self.collapse_model == 'first letter': - fla.setCheckable(True) - fla.setChecked(True) - else: - pa.setCheckable(True) - pa.setChecked(True) - - if not self.context_menu.isEmpty(): - self.context_menu.popup(self.mapToGlobal(point)) - return True - - def dragMoveEvent(self, event): - QTreeView.dragMoveEvent(self, event) - self.setDropIndicatorShown(False) - index = self.indexAt(event.pos()) - if not index.isValid(): - return - src_is_tb = event.mimeData().hasFormat('application/calibre+from_tag_browser') - item = index.internalPointer() - flags = self._model.flags(index) - if item.type == TagTreeItem.TAG and flags & Qt.ItemIsDropEnabled: - self.setDropIndicatorShown(not src_is_tb) - return - if item.type == TagTreeItem.CATEGORY and not item.is_gst: - fm_dest = self.db.metadata_for_field(item.category_key) - if fm_dest['kind'] == 'user': - if src_is_tb: - if event.dropAction() == Qt.MoveAction: - data = str(event.mimeData().data('application/calibre+from_tag_browser')) - src = cPickle.loads(data) - for s in src: - if s[0] == TagTreeItem.TAG and \ - (not s[1].startswith('@') or s[2]): - return - self.setDropIndicatorShown(True) - return - md = event.mimeData() - if hasattr(md, 'column_name'): - fm_src = self.db.metadata_for_field(md.column_name) - if md.column_name in ['authors', 'publisher', 'series'] or \ - (fm_src['is_custom'] and ( - (fm_src['datatype'] in ['series', 'text', 'enumeration'] and - not fm_src['is_multiple']) or - (fm_src['datatype'] == 'composite' and - fm_src['display'].get('make_category', False)))): - self.setDropIndicatorShown(True) - - def clear(self): - if self.model(): - self.model().clear_state() - - def is_visible(self, idx): - item = idx.internalPointer() - if getattr(item, 'type', None) == TagTreeItem.TAG: - idx = idx.parent() - return self.isExpanded(idx) - - def recount(self, *args): - ''' - Rebuild the category tree, expand any categories that were expanded, - reset the search states, and reselect the current node. - ''' - if self.disable_recounting or not self.pane_is_visible: - return - self.refresh_signal_processed = True - ci = self.currentIndex() - if not ci.isValid(): - ci = self.indexAt(QPoint(10, 10)) - path = self.model().path_for_index(ci) if self.is_visible(ci) else None - expanded_categories, state_map = self.model().get_state() - self.set_new_model(state_map=state_map) - for category in expanded_categories: - self.expand(self.model().index_for_category(category)) - self._model.show_item_at_path(path) - - def item_expanded(self, idx): - ''' - Called by the expanded signal - ''' - self.setCurrentIndex(idx) - - def set_new_model(self, filter_categories_by=None, state_map={}): - ''' - There are cases where we need to rebuild the category tree without - attempting to reposition the current node. - ''' - try: - old = getattr(self, '_model', None) - if old is not None: - old.break_cycles() - self._model = TagsModel(self.db, parent=self, - hidden_categories=self.hidden_categories, - search_restriction=self.search_restriction, - drag_drop_finished=self.drag_drop_finished, - filter_categories_by=filter_categories_by, - collapse_model=self.collapse_model, - state_map=state_map) - self.setModel(self._model) - except: - # The DB must be gone. Set the model to None and hope that someone - # will call set_database later. I don't know if this in fact works. - # But perhaps a Bad Thing Happened, so print the exception - traceback.print_exc() - self._model = None - self.setModel(None) - # }}} class TagTreeItem(object): # {{{ @@ -863,6 +297,7 @@ class TagsModel(QAbstractItemModel): # {{{ self.root_item.break_cycles() self.db = self.root_item = None + # Drag'n Drop {{{ def mimeTypes(self): return ["application/calibre+from_library", 'application/calibre+from_tag_browser'] @@ -1130,6 +565,7 @@ class TagsModel(QAbstractItemModel): # {{{ set_authors=set_authors, commit=False) self.db.commit() self.drag_drop_finished.emit(ids) + # }}} def set_search_restriction(self, s): self.search_restriction = s @@ -1198,7 +634,7 @@ class TagsModel(QAbstractItemModel): # {{{ Here to trap usages of refresh in the old architecture. Can eventually be removed. ''' - print 'TagsModel: refresh called!' + print ('TagsModel: refresh called!') traceback.print_stack() return False @@ -1209,7 +645,7 @@ class TagsModel(QAbstractItemModel): # {{{ sort_by = config['sort_tags_by'] if data is None: - print '_create_node_tree: no data!' + print ('_create_node_tree: no data!') traceback.print_stack() return @@ -1868,444 +1304,3 @@ class TagsModel(QAbstractItemModel): # {{{ # }}} -class TagBrowserMixin(object): # {{{ - - def __init__(self, db): - self.library_view.model().count_changed_signal.connect(self.tags_view.recount) - self.tags_view.set_database(db, self.tag_match, self.sort_by) - self.tags_view.tags_marked.connect(self.search.set_search_string) - self.tags_view.tag_list_edit.connect(self.do_tags_list_edit) - self.tags_view.edit_user_category.connect(self.do_edit_user_categories) - self.tags_view.delete_user_category.connect(self.do_delete_user_category) - self.tags_view.del_item_from_user_cat.connect(self.do_del_item_from_user_cat) - self.tags_view.add_subcategory.connect(self.do_add_subcategory) - self.tags_view.add_item_to_user_cat.connect(self.do_add_item_to_user_cat) - self.tags_view.saved_search_edit.connect(self.do_saved_search_edit) - self.tags_view.rebuild_saved_searches.connect(self.do_rebuild_saved_searches) - self.tags_view.author_sort_edit.connect(self.do_author_sort_edit) - self.tags_view.tag_item_renamed.connect(self.do_tag_item_renamed) - self.tags_view.search_item_renamed.connect(self.saved_searches_changed) - self.tags_view.drag_drop_finished.connect(self.drag_drop_finished) - self.tags_view.restriction_error.connect(self.do_restriction_error, - type=Qt.QueuedConnection) - - for text, func, args, cat_name in ( - (_('Manage Authors'), - self.do_author_sort_edit, (self, None), 'authors'), - (_('Manage Series'), - self.do_tags_list_edit, (None, 'series'), 'series'), - (_('Manage Publishers'), - self.do_tags_list_edit, (None, 'publisher'), 'publisher'), - (_('Manage Tags'), - self.do_tags_list_edit, (None, 'tags'), 'tags'), - (_('Manage User Categories'), - self.do_edit_user_categories, (None,), 'user:'), - (_('Manage Saved Searches'), - self.do_saved_search_edit, (None,), 'search') - ): - self.manage_items_button.menu().addAction( - QIcon(I(category_icon_map[cat_name])), - text, partial(func, *args)) - - def do_restriction_error(self): - error_dialog(self.tags_view, _('Invalid search restriction'), - _('The current search restriction is invalid'), show=True) - - def do_add_subcategory(self, on_category_key, new_category_name=None): - ''' - Add a subcategory to the category 'on_category'. If new_category_name is - None, then a default name is shown and the user is offered the - opportunity to edit the name. - ''' - db = self.library_view.model().db - user_cats = db.prefs.get('user_categories', {}) - - # Ensure that the temporary name we will use is not already there - i = 0 - if new_category_name is not None: - new_name = new_category_name.replace('.', '') - else: - new_name = _('New Category').replace('.', '') - n = new_name - while True: - new_cat = on_category_key[1:] + '.' + n - if new_cat not in user_cats: - break - i += 1 - n = new_name + unicode(i) - # Add the new category - user_cats[new_cat] = [] - db.prefs.set('user_categories', user_cats) - self.tags_view.set_new_model() - m = self.tags_view.model() - idx = m.index_for_path(m.find_category_node('@' + new_cat)) - m.show_item_at_index(idx) - # Open the editor on the new item to rename it - if new_category_name is None: - self.tags_view.edit(idx) - - def do_edit_user_categories(self, on_category=None): - ''' - Open the user categories editor. - ''' - db = self.library_view.model().db - d = TagCategories(self, db, on_category) - if d.exec_() == d.Accepted: - db.prefs.set('user_categories', d.categories) - db.field_metadata.remove_user_categories() - for k in d.categories: - db.field_metadata.add_user_category('@' + k, k) - db.data.change_search_locations(db.field_metadata.get_search_terms()) - self.tags_view.set_new_model() - - def do_delete_user_category(self, category_name): - ''' - Delete the user category named category_name. Any leading '@' is removed - ''' - if category_name.startswith('@'): - category_name = category_name[1:] - db = self.library_view.model().db - user_cats = db.prefs.get('user_categories', {}) - cat_keys = sorted(user_cats.keys(), key=sort_key) - has_children = False - found = False - for k in cat_keys: - if k == category_name: - found = True - has_children = len(user_cats[k]) - elif k.startswith(category_name + '.'): - has_children = True - if not found: - return error_dialog(self.tags_view, _('Delete user category'), - _('%s is not a user category')%category_name, show=True) - if has_children: - if not question_dialog(self.tags_view, _('Delete user category'), - _('%s contains items. Do you really ' - 'want to delete it?')%category_name): - return - for k in cat_keys: - if k == category_name: - del user_cats[k] - elif k.startswith(category_name + '.'): - del user_cats[k] - db.prefs.set('user_categories', user_cats) - self.tags_view.set_new_model() - - def do_del_item_from_user_cat(self, user_cat, item_name, item_category): - ''' - Delete the item (item_name, item_category) from the user category with - key user_cat. Any leading '@' characters are removed - ''' - if user_cat.startswith('@'): - user_cat = user_cat[1:] - db = self.library_view.model().db - user_cats = db.prefs.get('user_categories', {}) - if user_cat not in user_cats: - error_dialog(self.tags_view, _('Remove category'), - _('User category %s does not exist')%user_cat, - show=True) - return - self.tags_view.model().delete_item_from_user_category(user_cat, - item_name, item_category) - self.tags_view.recount() - - def do_add_item_to_user_cat(self, dest_category, src_name, src_category): - ''' - Add the item src_name in src_category to the user category - dest_category. Any leading '@' is removed - ''' - db = self.library_view.model().db - user_cats = db.prefs.get('user_categories', {}) - - if dest_category and dest_category.startswith('@'): - dest_category = dest_category[1:] - - if dest_category not in user_cats: - return error_dialog(self.tags_view, _('Add to user category'), - _('A user category %s does not exist')%dest_category, show=True) - - # Now add the item to the destination user category - add_it = True - if src_category == 'news': - src_category = 'tags' - for tup in user_cats[dest_category]: - if src_name == tup[0] and src_category == tup[1]: - add_it = False - if add_it: - user_cats[dest_category].append([src_name, src_category, 0]) - db.prefs.set('user_categories', user_cats) - self.tags_view.recount() - - def do_tags_list_edit(self, tag, category): - ''' - Open the 'manage_X' dialog where X == category. If tag is not None, the - dialog will position the editor on that item. - ''' - db=self.library_view.model().db - if category == 'tags': - result = db.get_tags_with_ids() - key = sort_key - elif category == 'series': - result = db.get_series_with_ids() - key = lambda x:sort_key(title_sort(x)) - elif category == 'publisher': - result = db.get_publishers_with_ids() - key = sort_key - else: # should be a custom field - cc_label = None - if category in db.field_metadata: - cc_label = db.field_metadata[category]['label'] - result = db.get_custom_items_with_ids(label=cc_label) - else: - result = [] - key = sort_key - - d = TagListEditor(self, tag_to_match=tag, data=result, key=key) - d.exec_() - if d.result() == d.Accepted: - to_rename = d.to_rename # dict of new text to old id - to_delete = d.to_delete # list of ids - orig_name = d.original_names # dict of id: name - - rename_func = None - if category == 'tags': - rename_func = db.rename_tag - delete_func = db.delete_tag_using_id - elif category == 'series': - rename_func = db.rename_series - delete_func = db.delete_series_using_id - elif category == 'publisher': - rename_func = db.rename_publisher - delete_func = db.delete_publisher_using_id - else: - rename_func = partial(db.rename_custom_item, label=cc_label) - delete_func = partial(db.delete_custom_item_using_id, label=cc_label) - m = self.tags_view.model() - if rename_func: - for item in to_delete: - delete_func(item) - m.delete_item_from_all_user_categories(orig_name[item], category) - for old_id in to_rename: - rename_func(old_id, new_name=unicode(to_rename[old_id])) - m.rename_item_in_all_user_categories(orig_name[old_id], - category, unicode(to_rename[old_id])) - - # Clean up the library view - self.do_tag_item_renamed() - self.tags_view.recount() - - def do_tag_item_renamed(self): - # Clean up library view and search - # get information to redo the selection - rows = [r.row() for r in \ - self.library_view.selectionModel().selectedRows()] - m = self.library_view.model() - ids = [m.id(r) for r in rows] - - m.refresh(reset=False) - m.research() - self.library_view.select_rows(ids) - # refreshing the tags view happens at the emit()/call() site - - def do_author_sort_edit(self, parent, id, select_sort=True): - ''' - Open the manage authors dialog - ''' - db = self.library_view.model().db - editor = EditAuthorsDialog(parent, db, id, select_sort) - d = editor.exec_() - if d: - for (id, old_author, new_author, new_sort) in editor.result: - if old_author != new_author: - # The id might change if the new author already exists - id = db.rename_author(id, new_author) - db.set_sort_field_for_author(id, unicode(new_sort), - commit=False, notify=False) - db.commit() - self.library_view.model().refresh() - self.tags_view.recount() - - def drag_drop_finished(self, ids): - self.library_view.model().refresh_ids(ids) - -# }}} - -class TagBrowserWidget(QWidget): # {{{ - - def __init__(self, parent): - QWidget.__init__(self, parent) - self.parent = parent - self._layout = QVBoxLayout() - self.setLayout(self._layout) - self._layout.setContentsMargins(0,0,0,0) - - # Set up the find box & button - search_layout = QHBoxLayout() - self._layout.addLayout(search_layout) - self.item_search = HistoryLineEdit(parent) - try: - self.item_search.lineEdit().setPlaceholderText( - _('Find item in tag browser')) - except: - pass # Using Qt < 4.7 - self.item_search.setToolTip(_( - 'Search for items. This is a "contains" search; items containing the\n' - 'text anywhere in the name will be found. You can limit the search\n' - 'to particular categories using syntax similar to search. For example,\n' - 'tags:foo will find foo in any tag, but not in authors etc. Entering\n' - '*foo will filter all categories at once, showing only those items\n' - 'containing the text "foo"')) - search_layout.addWidget(self.item_search) - # Not sure if the shortcut should be translatable ... - sc = QShortcut(QKeySequence(_('ALT+f')), parent) - sc.connect(sc, SIGNAL('activated()'), self.set_focus_to_find_box) - - self.search_button = QToolButton() - self.search_button.setText(_('F&ind')) - self.search_button.setToolTip(_('Find the first/next matching item')) - search_layout.addWidget(self.search_button) - - self.expand_button = QToolButton() - self.expand_button.setText('-') - self.expand_button.setToolTip(_('Collapse all categories')) - search_layout.addWidget(self.expand_button) - search_layout.setStretch(0, 10) - search_layout.setStretch(1, 1) - search_layout.setStretch(2, 1) - - self.current_find_position = None - self.search_button.clicked.connect(self.find) - self.item_search.initialize('tag_browser_search') - self.item_search.lineEdit().returnPressed.connect(self.do_find) - self.item_search.lineEdit().textEdited.connect(self.find_text_changed) - self.item_search.activated[QString].connect(self.do_find) - self.item_search.completer().setCaseSensitivity(Qt.CaseSensitive) - - parent.tags_view = TagsView(parent) - self.tags_view = parent.tags_view - self.expand_button.clicked.connect(self.tags_view.collapseAll) - self._layout.addWidget(parent.tags_view) - - # Now the floating 'not found' box - l = QLabel(self.tags_view) - self.not_found_label = l - l.setFrameStyle(QFrame.StyledPanel) - l.setAutoFillBackground(True) - l.setText('

'+_('No More Matches.

Click Find again to go to first match')) - l.setAlignment(Qt.AlignVCenter) - l.setWordWrap(True) - l.resize(l.sizeHint()) - l.move(10,20) - l.setVisible(False) - self.not_found_label_timer = QTimer() - self.not_found_label_timer.setSingleShot(True) - self.not_found_label_timer.timeout.connect(self.not_found_label_timer_event, - type=Qt.QueuedConnection) - - parent.sort_by = QComboBox(parent) - # Must be in the same order as db2.CATEGORY_SORTS - for x in (_('Sort by name'), _('Sort by popularity'), - _('Sort by average rating')): - parent.sort_by.addItem(x) - parent.sort_by.setToolTip( - _('Set the sort order for entries in the Tag Browser')) - parent.sort_by.setStatusTip(parent.sort_by.toolTip()) - parent.sort_by.setCurrentIndex(0) - self._layout.addWidget(parent.sort_by) - - # Must be in the same order as db2.MATCH_TYPE - parent.tag_match = QComboBox(parent) - for x in (_('Match any'), _('Match all')): - parent.tag_match.addItem(x) - parent.tag_match.setCurrentIndex(0) - self._layout.addWidget(parent.tag_match) - parent.tag_match.setToolTip( - _('When selecting multiple entries in the Tag Browser ' - 'match any or all of them')) - parent.tag_match.setStatusTip(parent.tag_match.toolTip()) - - - l = parent.manage_items_button = QPushButton(self) - l.setStyleSheet('QPushButton {text-align: left; }') - l.setText(_('Manage authors, tags, etc')) - l.setToolTip(_('All of these category_managers are available by right-clicking ' - 'on items in the tag browser above')) - l.m = QMenu() - l.setMenu(l.m) - self._layout.addWidget(l) - - # self.leak_test_timer = QTimer(self) - # self.leak_test_timer.timeout.connect(self.test_for_leak) - # self.leak_test_timer.start(5000) - - def set_pane_is_visible(self, to_what): - self.tags_view.set_pane_is_visible(to_what) - - def find_text_changed(self, str): - self.current_find_position = None - - def set_focus_to_find_box(self): - self.item_search.setFocus() - self.item_search.lineEdit().selectAll() - - def do_find(self, str=None): - self.current_find_position = None - self.find() - - def find(self): - model = self.tags_view.model() - model.clear_boxed() - txt = unicode(self.item_search.currentText()).strip() - - if txt.startswith('*'): - self.tags_view.set_new_model(filter_categories_by=txt[1:]) - self.current_find_position = None - return - if model.get_filter_categories_by(): - self.tags_view.set_new_model(filter_categories_by=None) - self.current_find_position = None - model = self.tags_view.model() - - if not txt: - return - - self.item_search.lineEdit().blockSignals(True) - self.search_button.setFocus(True) - self.item_search.lineEdit().blockSignals(False) - - key = None - colon = txt.rfind(':') if len(txt) > 2 else 0 - if colon > 0: - key = self.parent.library_view.model().db.\ - field_metadata.search_term_to_field_key(txt[:colon]) - txt = txt[colon+1:] - - self.current_find_position = \ - model.find_item_node(key, txt, self.current_find_position) - if self.current_find_position: - model.show_item_at_path(self.current_find_position, box=True) - elif self.item_search.text(): - self.not_found_label.setVisible(True) - if self.tags_view.verticalScrollBar().isVisible(): - sbw = self.tags_view.verticalScrollBar().width() - else: - sbw = 0 - width = self.width() - 8 - sbw - height = self.not_found_label.heightForWidth(width) + 20 - self.not_found_label.resize(width, height) - self.not_found_label.move(4, 10) - self.not_found_label_timer.start(2000) - - def not_found_label_timer_event(self): - self.not_found_label.setVisible(False) - - def test_for_leak(self): - from calibre.utils.mem import memory - import gc - before = memory() - self.tags_view.recount() - for i in xrange(3): gc.collect() - print 'Used memory:', memory(before)/(1024.), 'KB' - -# }}} - diff --git a/src/calibre/gui2/tag_browser/ui.py b/src/calibre/gui2/tag_browser/ui.py new file mode 100644 index 0000000000..f7f724b118 --- /dev/null +++ b/src/calibre/gui2/tag_browser/ui.py @@ -0,0 +1,458 @@ +#!/usr/bin/env python +# vim:fileencoding=UTF-8:ts=4:sw=4:sta:et:sts=4:ai +from __future__ import (unicode_literals, division, absolute_import, + print_function) + +__license__ = 'GPL v3' +__copyright__ = '2011, Kovid Goyal ' +__docformat__ = 'restructuredtext en' + +from functools import partial + +from PyQt4.Qt import (Qt, QIcon, QWidget, QHBoxLayout, QVBoxLayout, QShortcut, + QKeySequence, QToolButton, QString, QLabel, QFrame, QTimer, QComboBox, + QMenu, QPushButton) + +from calibre.gui2 import error_dialog, question_dialog +from calibre.gui2.widgets import HistoryLineEdit +from calibre.library.field_metadata import category_icon_map +from calibre.utils.icu import sort_key +from calibre.gui2.tag_browser.view import TagsView +from calibre.ebooks.metadata import title_sort +from calibre.gui2.dialogs.tag_categories import TagCategories +from calibre.gui2.dialogs.tag_list_editor import TagListEditor +from calibre.gui2.dialogs.edit_authors_dialog import EditAuthorsDialog + +class TagBrowserMixin(object): # {{{ + + def __init__(self, db): + self.library_view.model().count_changed_signal.connect(self.tags_view.recount) + self.tags_view.set_database(db, self.tag_match, self.sort_by) + self.tags_view.tags_marked.connect(self.search.set_search_string) + self.tags_view.tag_list_edit.connect(self.do_tags_list_edit) + self.tags_view.edit_user_category.connect(self.do_edit_user_categories) + self.tags_view.delete_user_category.connect(self.do_delete_user_category) + self.tags_view.del_item_from_user_cat.connect(self.do_del_item_from_user_cat) + self.tags_view.add_subcategory.connect(self.do_add_subcategory) + self.tags_view.add_item_to_user_cat.connect(self.do_add_item_to_user_cat) + self.tags_view.saved_search_edit.connect(self.do_saved_search_edit) + self.tags_view.rebuild_saved_searches.connect(self.do_rebuild_saved_searches) + self.tags_view.author_sort_edit.connect(self.do_author_sort_edit) + self.tags_view.tag_item_renamed.connect(self.do_tag_item_renamed) + self.tags_view.search_item_renamed.connect(self.saved_searches_changed) + self.tags_view.drag_drop_finished.connect(self.drag_drop_finished) + self.tags_view.restriction_error.connect(self.do_restriction_error, + type=Qt.QueuedConnection) + + for text, func, args, cat_name in ( + (_('Manage Authors'), + self.do_author_sort_edit, (self, None), 'authors'), + (_('Manage Series'), + self.do_tags_list_edit, (None, 'series'), 'series'), + (_('Manage Publishers'), + self.do_tags_list_edit, (None, 'publisher'), 'publisher'), + (_('Manage Tags'), + self.do_tags_list_edit, (None, 'tags'), 'tags'), + (_('Manage User Categories'), + self.do_edit_user_categories, (None,), 'user:'), + (_('Manage Saved Searches'), + self.do_saved_search_edit, (None,), 'search') + ): + self.manage_items_button.menu().addAction( + QIcon(I(category_icon_map[cat_name])), + text, partial(func, *args)) + + def do_restriction_error(self): + error_dialog(self.tags_view, _('Invalid search restriction'), + _('The current search restriction is invalid'), show=True) + + def do_add_subcategory(self, on_category_key, new_category_name=None): + ''' + Add a subcategory to the category 'on_category'. If new_category_name is + None, then a default name is shown and the user is offered the + opportunity to edit the name. + ''' + db = self.library_view.model().db + user_cats = db.prefs.get('user_categories', {}) + + # Ensure that the temporary name we will use is not already there + i = 0 + if new_category_name is not None: + new_name = new_category_name.replace('.', '') + else: + new_name = _('New Category').replace('.', '') + n = new_name + while True: + new_cat = on_category_key[1:] + '.' + n + if new_cat not in user_cats: + break + i += 1 + n = new_name + unicode(i) + # Add the new category + user_cats[new_cat] = [] + db.prefs.set('user_categories', user_cats) + self.tags_view.set_new_model() + m = self.tags_view.model() + idx = m.index_for_path(m.find_category_node('@' + new_cat)) + m.show_item_at_index(idx) + # Open the editor on the new item to rename it + if new_category_name is None: + self.tags_view.edit(idx) + + def do_edit_user_categories(self, on_category=None): + ''' + Open the user categories editor. + ''' + db = self.library_view.model().db + d = TagCategories(self, db, on_category) + if d.exec_() == d.Accepted: + db.prefs.set('user_categories', d.categories) + db.field_metadata.remove_user_categories() + for k in d.categories: + db.field_metadata.add_user_category('@' + k, k) + db.data.change_search_locations(db.field_metadata.get_search_terms()) + self.tags_view.set_new_model() + + def do_delete_user_category(self, category_name): + ''' + Delete the user category named category_name. Any leading '@' is removed + ''' + if category_name.startswith('@'): + category_name = category_name[1:] + db = self.library_view.model().db + user_cats = db.prefs.get('user_categories', {}) + cat_keys = sorted(user_cats.keys(), key=sort_key) + has_children = False + found = False + for k in cat_keys: + if k == category_name: + found = True + has_children = len(user_cats[k]) + elif k.startswith(category_name + '.'): + has_children = True + if not found: + return error_dialog(self.tags_view, _('Delete user category'), + _('%s is not a user category')%category_name, show=True) + if has_children: + if not question_dialog(self.tags_view, _('Delete user category'), + _('%s contains items. Do you really ' + 'want to delete it?')%category_name): + return + for k in cat_keys: + if k == category_name: + del user_cats[k] + elif k.startswith(category_name + '.'): + del user_cats[k] + db.prefs.set('user_categories', user_cats) + self.tags_view.set_new_model() + + def do_del_item_from_user_cat(self, user_cat, item_name, item_category): + ''' + Delete the item (item_name, item_category) from the user category with + key user_cat. Any leading '@' characters are removed + ''' + if user_cat.startswith('@'): + user_cat = user_cat[1:] + db = self.library_view.model().db + user_cats = db.prefs.get('user_categories', {}) + if user_cat not in user_cats: + error_dialog(self.tags_view, _('Remove category'), + _('User category %s does not exist')%user_cat, + show=True) + return + self.tags_view.model().delete_item_from_user_category(user_cat, + item_name, item_category) + self.tags_view.recount() + + def do_add_item_to_user_cat(self, dest_category, src_name, src_category): + ''' + Add the item src_name in src_category to the user category + dest_category. Any leading '@' is removed + ''' + db = self.library_view.model().db + user_cats = db.prefs.get('user_categories', {}) + + if dest_category and dest_category.startswith('@'): + dest_category = dest_category[1:] + + if dest_category not in user_cats: + return error_dialog(self.tags_view, _('Add to user category'), + _('A user category %s does not exist')%dest_category, show=True) + + # Now add the item to the destination user category + add_it = True + if src_category == 'news': + src_category = 'tags' + for tup in user_cats[dest_category]: + if src_name == tup[0] and src_category == tup[1]: + add_it = False + if add_it: + user_cats[dest_category].append([src_name, src_category, 0]) + db.prefs.set('user_categories', user_cats) + self.tags_view.recount() + + def do_tags_list_edit(self, tag, category): + ''' + Open the 'manage_X' dialog where X == category. If tag is not None, the + dialog will position the editor on that item. + ''' + db=self.library_view.model().db + if category == 'tags': + result = db.get_tags_with_ids() + key = sort_key + elif category == 'series': + result = db.get_series_with_ids() + key = lambda x:sort_key(title_sort(x)) + elif category == 'publisher': + result = db.get_publishers_with_ids() + key = sort_key + else: # should be a custom field + cc_label = None + if category in db.field_metadata: + cc_label = db.field_metadata[category]['label'] + result = db.get_custom_items_with_ids(label=cc_label) + else: + result = [] + key = sort_key + + d = TagListEditor(self, tag_to_match=tag, data=result, key=key) + d.exec_() + if d.result() == d.Accepted: + to_rename = d.to_rename # dict of new text to old id + to_delete = d.to_delete # list of ids + orig_name = d.original_names # dict of id: name + + rename_func = None + if category == 'tags': + rename_func = db.rename_tag + delete_func = db.delete_tag_using_id + elif category == 'series': + rename_func = db.rename_series + delete_func = db.delete_series_using_id + elif category == 'publisher': + rename_func = db.rename_publisher + delete_func = db.delete_publisher_using_id + else: + rename_func = partial(db.rename_custom_item, label=cc_label) + delete_func = partial(db.delete_custom_item_using_id, label=cc_label) + m = self.tags_view.model() + if rename_func: + for item in to_delete: + delete_func(item) + m.delete_item_from_all_user_categories(orig_name[item], category) + for old_id in to_rename: + rename_func(old_id, new_name=unicode(to_rename[old_id])) + m.rename_item_in_all_user_categories(orig_name[old_id], + category, unicode(to_rename[old_id])) + + # Clean up the library view + self.do_tag_item_renamed() + self.tags_view.recount() + + def do_tag_item_renamed(self): + # Clean up library view and search + # get information to redo the selection + rows = [r.row() for r in \ + self.library_view.selectionModel().selectedRows()] + m = self.library_view.model() + ids = [m.id(r) for r in rows] + + m.refresh(reset=False) + m.research() + self.library_view.select_rows(ids) + # refreshing the tags view happens at the emit()/call() site + + def do_author_sort_edit(self, parent, id, select_sort=True): + ''' + Open the manage authors dialog + ''' + db = self.library_view.model().db + editor = EditAuthorsDialog(parent, db, id, select_sort) + d = editor.exec_() + if d: + for (id, old_author, new_author, new_sort) in editor.result: + if old_author != new_author: + # The id might change if the new author already exists + id = db.rename_author(id, new_author) + db.set_sort_field_for_author(id, unicode(new_sort), + commit=False, notify=False) + db.commit() + self.library_view.model().refresh() + self.tags_view.recount() + + def drag_drop_finished(self, ids): + self.library_view.model().refresh_ids(ids) + +# }}} + +class TagBrowserWidget(QWidget): # {{{ + + def __init__(self, parent): + QWidget.__init__(self, parent) + self.parent = parent + self._layout = QVBoxLayout() + self.setLayout(self._layout) + self._layout.setContentsMargins(0,0,0,0) + + # Set up the find box & button + search_layout = QHBoxLayout() + self._layout.addLayout(search_layout) + self.item_search = HistoryLineEdit(parent) + try: + self.item_search.lineEdit().setPlaceholderText( + _('Find item in tag browser')) + except: + pass # Using Qt < 4.7 + self.item_search.setToolTip(_( + 'Search for items. This is a "contains" search; items containing the\n' + 'text anywhere in the name will be found. You can limit the search\n' + 'to particular categories using syntax similar to search. For example,\n' + 'tags:foo will find foo in any tag, but not in authors etc. Entering\n' + '*foo will filter all categories at once, showing only those items\n' + 'containing the text "foo"')) + search_layout.addWidget(self.item_search) + # Not sure if the shortcut should be translatable ... + sc = QShortcut(QKeySequence(_('ALT+f')), parent) + sc.activated.connect(self.set_focus_to_find_box) + + self.search_button = QToolButton() + self.search_button.setText(_('F&ind')) + self.search_button.setToolTip(_('Find the first/next matching item')) + search_layout.addWidget(self.search_button) + + self.expand_button = QToolButton() + self.expand_button.setText('-') + self.expand_button.setToolTip(_('Collapse all categories')) + search_layout.addWidget(self.expand_button) + search_layout.setStretch(0, 10) + search_layout.setStretch(1, 1) + search_layout.setStretch(2, 1) + + self.current_find_position = None + self.search_button.clicked.connect(self.find) + self.item_search.initialize('tag_browser_search') + self.item_search.lineEdit().returnPressed.connect(self.do_find) + self.item_search.lineEdit().textEdited.connect(self.find_text_changed) + self.item_search.activated[QString].connect(self.do_find) + self.item_search.completer().setCaseSensitivity(Qt.CaseSensitive) + + parent.tags_view = TagsView(parent) + self.tags_view = parent.tags_view + self.expand_button.clicked.connect(self.tags_view.collapseAll) + self._layout.addWidget(parent.tags_view) + + # Now the floating 'not found' box + l = QLabel(self.tags_view) + self.not_found_label = l + l.setFrameStyle(QFrame.StyledPanel) + l.setAutoFillBackground(True) + l.setText('

'+_('No More Matches.

Click Find again to go to first match')) + l.setAlignment(Qt.AlignVCenter) + l.setWordWrap(True) + l.resize(l.sizeHint()) + l.move(10,20) + l.setVisible(False) + self.not_found_label_timer = QTimer() + self.not_found_label_timer.setSingleShot(True) + self.not_found_label_timer.timeout.connect(self.not_found_label_timer_event, + type=Qt.QueuedConnection) + + parent.sort_by = QComboBox(parent) + # Must be in the same order as db2.CATEGORY_SORTS + for x in (_('Sort by name'), _('Sort by popularity'), + _('Sort by average rating')): + parent.sort_by.addItem(x) + parent.sort_by.setToolTip( + _('Set the sort order for entries in the Tag Browser')) + parent.sort_by.setStatusTip(parent.sort_by.toolTip()) + parent.sort_by.setCurrentIndex(0) + self._layout.addWidget(parent.sort_by) + + # Must be in the same order as db2.MATCH_TYPE + parent.tag_match = QComboBox(parent) + for x in (_('Match any'), _('Match all')): + parent.tag_match.addItem(x) + parent.tag_match.setCurrentIndex(0) + self._layout.addWidget(parent.tag_match) + parent.tag_match.setToolTip( + _('When selecting multiple entries in the Tag Browser ' + 'match any or all of them')) + parent.tag_match.setStatusTip(parent.tag_match.toolTip()) + + + l = parent.manage_items_button = QPushButton(self) + l.setStyleSheet('QPushButton {text-align: left; }') + l.setText(_('Manage authors, tags, etc')) + l.setToolTip(_('All of these category_managers are available by right-clicking ' + 'on items in the tag browser above')) + l.m = QMenu() + l.setMenu(l.m) + self._layout.addWidget(l) + + # self.leak_test_timer = QTimer(self) + # self.leak_test_timer.timeout.connect(self.test_for_leak) + # self.leak_test_timer.start(5000) + + def set_pane_is_visible(self, to_what): + self.tags_view.set_pane_is_visible(to_what) + + def find_text_changed(self, str): + self.current_find_position = None + + def set_focus_to_find_box(self): + self.item_search.setFocus() + self.item_search.lineEdit().selectAll() + + def do_find(self, str=None): + self.current_find_position = None + self.find() + + def find(self): + model = self.tags_view.model() + model.clear_boxed() + txt = unicode(self.item_search.currentText()).strip() + + if txt.startswith('*'): + self.tags_view.set_new_model(filter_categories_by=txt[1:]) + self.current_find_position = None + return + if model.get_filter_categories_by(): + self.tags_view.set_new_model(filter_categories_by=None) + self.current_find_position = None + model = self.tags_view.model() + + if not txt: + return + + self.item_search.lineEdit().blockSignals(True) + self.search_button.setFocus(True) + self.item_search.lineEdit().blockSignals(False) + + key = None + colon = txt.rfind(':') if len(txt) > 2 else 0 + if colon > 0: + key = self.parent.library_view.model().db.\ + field_metadata.search_term_to_field_key(txt[:colon]) + txt = txt[colon+1:] + + self.current_find_position = \ + model.find_item_node(key, txt, self.current_find_position) + if self.current_find_position: + model.show_item_at_path(self.current_find_position, box=True) + elif self.item_search.text(): + self.not_found_label.setVisible(True) + if self.tags_view.verticalScrollBar().isVisible(): + sbw = self.tags_view.verticalScrollBar().width() + else: + sbw = 0 + width = self.width() - 8 - sbw + height = self.not_found_label.heightForWidth(width) + 20 + self.not_found_label.resize(width, height) + self.not_found_label.move(4, 10) + self.not_found_label_timer.start(2000) + + def not_found_label_timer_event(self): + self.not_found_label.setVisible(False) + +# }}} + diff --git a/src/calibre/gui2/tag_browser/view.py b/src/calibre/gui2/tag_browser/view.py new file mode 100644 index 0000000000..79ab1448bf --- /dev/null +++ b/src/calibre/gui2/tag_browser/view.py @@ -0,0 +1,578 @@ +#!/usr/bin/env python +# vim:fileencoding=UTF-8:ts=4:sw=4:sta:et:sts=4:ai +from __future__ import (unicode_literals, division, absolute_import, + print_function) + +__license__ = 'GPL v3' +__copyright__ = '2011, Kovid Goyal ' +__docformat__ = 'restructuredtext en' + +import cPickle, traceback +from functools import partial + +from PyQt4.Qt import (QItemDelegate, Qt, QTreeView, pyqtSignal, QSize, QIcon, + QApplication, QMenu, QPoint) + +from calibre.gui2.tag_browser.model import (TagTreeItem, TAG_SEARCH_STATES, + TagsModel) +from calibre.gui2 import config, gprefs +from calibre.utils.search_query_parser import saved_searches +from calibre.utils.icu import sort_key + +class TagDelegate(QItemDelegate): # {{{ + + def paint(self, painter, option, index): + item = index.internalPointer() + if item.type != TagTreeItem.TAG: + QItemDelegate.paint(self, painter, option, index) + return + r = option.rect + model = self.parent().model() + icon = model.data(index, Qt.DecorationRole).toPyObject() + painter.save() + if item.tag.state != 0 or not config['show_avg_rating'] or \ + item.tag.avg_rating is None: + icon.paint(painter, r, Qt.AlignLeft) + else: + painter.setOpacity(0.3) + icon.paint(painter, r, Qt.AlignLeft) + painter.setOpacity(1) + rating = item.tag.avg_rating + painter.setClipRect(r.left(), r.bottom()-int(r.height()*(rating/5.0)), + r.width(), r.height()) + icon.paint(painter, r, Qt.AlignLeft) + painter.setClipRect(r) + + # Paint the text + if item.boxed: + painter.drawRoundedRect(r.adjusted(1,1,-1,-1), 5, 5) + r.setLeft(r.left()+r.height()+3) + painter.drawText(r, Qt.AlignLeft|Qt.AlignVCenter, + model.data(index, Qt.DisplayRole).toString()) + painter.restore() + + # }}} + +class TagsView(QTreeView): # {{{ + + refresh_required = pyqtSignal() + tags_marked = pyqtSignal(object) + edit_user_category = pyqtSignal(object) + delete_user_category = pyqtSignal(object) + del_item_from_user_cat = pyqtSignal(object, object, object) + add_item_to_user_cat = pyqtSignal(object, object, object) + add_subcategory = pyqtSignal(object) + tag_list_edit = pyqtSignal(object, object) + saved_search_edit = pyqtSignal(object) + rebuild_saved_searches = pyqtSignal() + author_sort_edit = pyqtSignal(object, object) + tag_item_renamed = pyqtSignal() + search_item_renamed = pyqtSignal() + drag_drop_finished = pyqtSignal(object) + restriction_error = pyqtSignal() + + def __init__(self, parent=None): + QTreeView.__init__(self, parent=None) + self.tag_match = None + self.disable_recounting = False + self.setUniformRowHeights(True) + self.setCursor(Qt.PointingHandCursor) + self.setIconSize(QSize(30, 30)) + self.setTabKeyNavigation(True) + self.setAlternatingRowColors(True) + self.setAnimated(True) + self.setHeaderHidden(True) + self.setItemDelegate(TagDelegate(self)) + self.made_connections = False + self.setAcceptDrops(True) + self.setDragEnabled(True) + self.setDragDropMode(self.DragDrop) + self.setDropIndicatorShown(True) + self.setAutoExpandDelay(500) + self.pane_is_visible = False + if gprefs['tags_browser_collapse_at'] == 0: + self.collapse_model = 'disable' + else: + self.collapse_model = gprefs['tags_browser_partition_method'] + self.search_icon = QIcon(I('search.png')) + self.user_category_icon = QIcon(I('tb_folder.png')) + self.delete_icon = QIcon(I('list_remove.png')) + self.rename_icon = QIcon(I('edit-undo.png')) + + def set_pane_is_visible(self, to_what): + pv = self.pane_is_visible + self.pane_is_visible = to_what + if to_what and not pv: + self.recount() + + def reread_collapse_parameters(self): + if gprefs['tags_browser_collapse_at'] == 0: + self.collapse_model = 'disable' + else: + self.collapse_model = gprefs['tags_browser_partition_method'] + self.set_new_model(self._model.get_filter_categories_by()) + + def set_database(self, db, tag_match, sort_by): + hidden_cats = db.prefs.get('tag_browser_hidden_categories', None) + self.hidden_categories = [] + # migrate from config to db prefs + if hidden_cats is None: + hidden_cats = config['tag_browser_hidden_categories'] + # strip out any non-existence field keys + for cat in hidden_cats: + if cat in db.field_metadata: + self.hidden_categories.append(cat) + db.prefs.set('tag_browser_hidden_categories', list(self.hidden_categories)) + self.hidden_categories = set(self.hidden_categories) + + old = getattr(self, '_model', None) + if old is not None: + old.break_cycles() + self._model = TagsModel(db, parent=self, + hidden_categories=self.hidden_categories, + search_restriction=None, + drag_drop_finished=self.drag_drop_finished, + collapse_model=self.collapse_model, + state_map={}) + self.pane_is_visible = True # because TagsModel.init did a recount + self.sort_by = sort_by + self.tag_match = tag_match + self.db = db + self.search_restriction = None + self.setModel(self._model) + self.setContextMenuPolicy(Qt.CustomContextMenu) + pop = config['sort_tags_by'] + self.sort_by.setCurrentIndex(self.db.CATEGORY_SORTS.index(pop)) + try: + match_pop = self.db.MATCH_TYPE.index(config['match_tags_type']) + except ValueError: + match_pop = 0 + self.tag_match.setCurrentIndex(match_pop) + if not self.made_connections: + self.clicked.connect(self.toggle) + self.customContextMenuRequested.connect(self.show_context_menu) + self.refresh_required.connect(self.recount, type=Qt.QueuedConnection) + self.sort_by.currentIndexChanged.connect(self.sort_changed) + self.tag_match.currentIndexChanged.connect(self.match_changed) + self.made_connections = True + self.refresh_signal_processed = True + db.add_listener(self.database_changed) + self.expanded.connect(self.item_expanded) + + def database_changed(self, event, ids): + if self.refresh_signal_processed: + self.refresh_signal_processed = False + self.refresh_required.emit() + + @property + def match_all(self): + return self.tag_match and self.tag_match.currentIndex() > 0 + + def sort_changed(self, pop): + config.set('sort_tags_by', self.db.CATEGORY_SORTS[pop]) + self.recount() + + def match_changed(self, pop): + try: + config.set('match_tags_type', self.db.MATCH_TYPE[pop]) + except: + pass + + def set_search_restriction(self, s): + if s: + self.search_restriction = s + else: + self.search_restriction = None + self.set_new_model() + + def mouseReleaseEvent(self, event): + # Swallow everything except leftButton so context menus work correctly + if event.button() == Qt.LeftButton: + QTreeView.mouseReleaseEvent(self, event) + + def mouseDoubleClickEvent(self, event): + # swallow these to avoid toggling and editing at the same time + pass + + @property + def search_string(self): + tokens = self._model.tokens() + joiner = ' and ' if self.match_all else ' or ' + return joiner.join(tokens) + + def toggle(self, index): + self._toggle(index, None) + + def _toggle(self, index, set_to): + ''' + set_to: if None, advance the state. Otherwise must be one of the values + in TAG_SEARCH_STATES + ''' + modifiers = int(QApplication.keyboardModifiers()) + exclusive = modifiers not in (Qt.CTRL, Qt.SHIFT) + if self._model.toggle(index, exclusive, set_to=set_to): + self.tags_marked.emit(self.search_string) + + def conditional_clear(self, search_string): + if search_string != self.search_string: + self.clear() + + def context_menu_handler(self, action=None, category=None, + key=None, index=None, search_state=None): + if not action: + return + try: + if action == 'edit_item': + self.edit(index) + return + if action == 'open_editor': + self.tag_list_edit.emit(category, key) + return + if action == 'manage_categories': + self.edit_user_category.emit(category) + return + if action == 'search': + self._toggle(index, set_to=search_state) + return + if action == 'add_to_category': + tag = index.tag + if len(index.children) > 0: + for c in index.children: + self.add_item_to_user_cat.emit(category, c.tag.original_name, + c.tag.category) + self.add_item_to_user_cat.emit(category, tag.original_name, + tag.category) + return + if action == 'add_subcategory': + self.add_subcategory.emit(key) + return + if action == 'search_category': + self._toggle(index, set_to=search_state) + return + if action == 'delete_user_category': + self.delete_user_category.emit(key) + return + if action == 'delete_search': + saved_searches().delete(key) + self.rebuild_saved_searches.emit() + return + if action == 'delete_item_from_user_category': + tag = index.tag + if len(index.children) > 0: + for c in index.children: + self.del_item_from_user_cat.emit(key, c.tag.original_name, + c.tag.category) + self.del_item_from_user_cat.emit(key, tag.original_name, tag.category) + return + if action == 'manage_searches': + self.saved_search_edit.emit(category) + return + if action == 'edit_author_sort': + self.author_sort_edit.emit(self, index) + return + + if action == 'hide': + self.hidden_categories.add(category) + elif action == 'show': + self.hidden_categories.discard(category) + elif action == 'categorization': + changed = self.collapse_model != category + self.collapse_model = category + if changed: + self.set_new_model(self._model.get_filter_categories_by()) + gprefs['tags_browser_partition_method'] = category + elif action == 'defaults': + self.hidden_categories.clear() + self.db.prefs.set('tag_browser_hidden_categories', list(self.hidden_categories)) + self.set_new_model() + except: + return + + def show_context_menu(self, point): + def display_name( tag): + if tag.category == 'search': + n = tag.name + if len(n) > 45: + n = n[:45] + '...' + return "'" + n + "'" + return tag.name + + index = self.indexAt(point) + self.context_menu = QMenu(self) + + if index.isValid(): + item = index.internalPointer() + tag = None + + if item.type == TagTreeItem.TAG: + tag_item = item + tag = item.tag + while item.type != TagTreeItem.CATEGORY: + item = item.parent + + if item.type == TagTreeItem.CATEGORY: + if not item.category_key.startswith('@'): + while item.parent != self._model.root_item: + item = item.parent + category = unicode(item.name.toString()) + key = item.category_key + # Verify that we are working with a field that we know something about + if key not in self.db.field_metadata: + return True + + # Did the user click on a leaf node? + if tag: + # If the user right-clicked on an editable item, then offer + # the possibility of renaming that item. + if tag.is_editable: + # Add the 'rename' items + self.context_menu.addAction(self.rename_icon, + _('Rename %s')%display_name(tag), + partial(self.context_menu_handler, action='edit_item', + index=index)) + if key == 'authors': + self.context_menu.addAction(_('Edit sort for %s')%display_name(tag), + partial(self.context_menu_handler, + action='edit_author_sort', index=tag.id)) + + # is_editable is also overloaded to mean 'can be added + # to a user category' + m = self.context_menu.addMenu(self.user_category_icon, + _('Add %s to user category')%display_name(tag)) + nt = self.model().category_node_tree + def add_node_tree(tree_dict, m, path): + p = path[:] + for k in sorted(tree_dict.keys(), key=sort_key): + p.append(k) + n = k[1:] if k.startswith('@') else k + m.addAction(self.user_category_icon, n, + partial(self.context_menu_handler, + 'add_to_category', + category='.'.join(p), index=tag_item)) + if len(tree_dict[k]): + tm = m.addMenu(self.user_category_icon, + _('Children of %s')%n) + add_node_tree(tree_dict[k], tm, p) + p.pop() + add_node_tree(nt, m, []) + elif key == 'search': + self.context_menu.addAction(self.rename_icon, + _('Rename %s')%display_name(tag), + partial(self.context_menu_handler, action='edit_item', + index=index)) + self.context_menu.addAction(self.delete_icon, + _('Delete search %s')%display_name(tag), + partial(self.context_menu_handler, + action='delete_search', key=tag.name)) + if key.startswith('@') and not item.is_gst: + self.context_menu.addAction(self.user_category_icon, + _('Remove %s from category %s')% + (display_name(tag), item.py_name), + partial(self.context_menu_handler, + action='delete_item_from_user_category', + key = key, index = tag_item)) + # Add the search for value items. All leaf nodes are searchable + self.context_menu.addAction(self.search_icon, + _('Search for %s')%display_name(tag), + partial(self.context_menu_handler, action='search', + search_state=TAG_SEARCH_STATES['mark_plus'], + index=index)) + self.context_menu.addAction(self.search_icon, + _('Search for everything but %s')%display_name(tag), + partial(self.context_menu_handler, action='search', + search_state=TAG_SEARCH_STATES['mark_minus'], + index=index)) + self.context_menu.addSeparator() + elif key.startswith('@') and not item.is_gst: + if item.can_be_edited: + self.context_menu.addAction(self.rename_icon, + _('Rename %s')%item.py_name, + partial(self.context_menu_handler, action='edit_item', + index=index)) + self.context_menu.addAction(self.user_category_icon, + _('Add sub-category to %s')%item.py_name, + partial(self.context_menu_handler, + action='add_subcategory', key=key)) + self.context_menu.addAction(self.delete_icon, + _('Delete user category %s')%item.py_name, + partial(self.context_menu_handler, + action='delete_user_category', key=key)) + self.context_menu.addSeparator() + # Hide/Show/Restore categories + self.context_menu.addAction(_('Hide category %s') % category, + partial(self.context_menu_handler, action='hide', + category=key)) + if self.hidden_categories: + m = self.context_menu.addMenu(_('Show category')) + for col in sorted(self.hidden_categories, + key=lambda x: sort_key(self.db.field_metadata[x]['name'])): + m.addAction(self.db.field_metadata[col]['name'], + partial(self.context_menu_handler, action='show', category=col)) + + # search by category. Some categories are not searchable, such + # as search and news + if item.tag.is_searchable: + self.context_menu.addAction(self.search_icon, + _('Search for books in category %s')%category, + partial(self.context_menu_handler, + action='search_category', + index=self._model.createIndex(item.row(), 0, item), + search_state=TAG_SEARCH_STATES['mark_plus'])) + self.context_menu.addAction(self.search_icon, + _('Search for books not in category %s')%category, + partial(self.context_menu_handler, + action='search_category', + index=self._model.createIndex(item.row(), 0, item), + search_state=TAG_SEARCH_STATES['mark_minus'])) + # Offer specific editors for tags/series/publishers/saved searches + self.context_menu.addSeparator() + if key in ['tags', 'publisher', 'series'] or \ + self.db.field_metadata[key]['is_custom']: + self.context_menu.addAction(_('Manage %s')%category, + partial(self.context_menu_handler, action='open_editor', + category=tag.original_name if tag else None, + key=key)) + elif key == 'authors': + self.context_menu.addAction(_('Manage %s')%category, + partial(self.context_menu_handler, action='edit_author_sort')) + elif key == 'search': + self.context_menu.addAction(_('Manage Saved Searches'), + partial(self.context_menu_handler, action='manage_searches', + category=tag.name if tag else None)) + + # Always show the user categories editor + self.context_menu.addSeparator() + if key.startswith('@') and \ + key[1:] in self.db.prefs.get('user_categories', {}).keys(): + self.context_menu.addAction(_('Manage User Categories'), + partial(self.context_menu_handler, action='manage_categories', + category=key[1:])) + else: + self.context_menu.addAction(_('Manage User Categories'), + partial(self.context_menu_handler, action='manage_categories', + category=None)) + + if self.hidden_categories: + if not self.context_menu.isEmpty(): + self.context_menu.addSeparator() + self.context_menu.addAction(_('Show all categories'), + partial(self.context_menu_handler, action='defaults')) + + m = self.context_menu.addMenu(_('Change sub-categorization scheme')) + da = m.addAction('Disable', + partial(self.context_menu_handler, action='categorization', category='disable')) + fla = m.addAction('By first letter', + partial(self.context_menu_handler, action='categorization', category='first letter')) + pa = m.addAction('Partition', + partial(self.context_menu_handler, action='categorization', category='partition')) + if self.collapse_model == 'disable': + da.setCheckable(True) + da.setChecked(True) + elif self.collapse_model == 'first letter': + fla.setCheckable(True) + fla.setChecked(True) + else: + pa.setCheckable(True) + pa.setChecked(True) + + if not self.context_menu.isEmpty(): + self.context_menu.popup(self.mapToGlobal(point)) + return True + + def dragMoveEvent(self, event): + QTreeView.dragMoveEvent(self, event) + self.setDropIndicatorShown(False) + index = self.indexAt(event.pos()) + if not index.isValid(): + return + src_is_tb = event.mimeData().hasFormat('application/calibre+from_tag_browser') + item = index.internalPointer() + flags = self._model.flags(index) + if item.type == TagTreeItem.TAG and flags & Qt.ItemIsDropEnabled: + self.setDropIndicatorShown(not src_is_tb) + return + if item.type == TagTreeItem.CATEGORY and not item.is_gst: + fm_dest = self.db.metadata_for_field(item.category_key) + if fm_dest['kind'] == 'user': + if src_is_tb: + if event.dropAction() == Qt.MoveAction: + data = str(event.mimeData().data('application/calibre+from_tag_browser')) + src = cPickle.loads(data) + for s in src: + if s[0] == TagTreeItem.TAG and \ + (not s[1].startswith('@') or s[2]): + return + self.setDropIndicatorShown(True) + return + md = event.mimeData() + if hasattr(md, 'column_name'): + fm_src = self.db.metadata_for_field(md.column_name) + if md.column_name in ['authors', 'publisher', 'series'] or \ + (fm_src['is_custom'] and ( + (fm_src['datatype'] in ['series', 'text', 'enumeration'] and + not fm_src['is_multiple']) or + (fm_src['datatype'] == 'composite' and + fm_src['display'].get('make_category', False)))): + self.setDropIndicatorShown(True) + + def clear(self): + if self.model(): + self.model().clear_state() + + def is_visible(self, idx): + item = idx.internalPointer() + if getattr(item, 'type', None) == TagTreeItem.TAG: + idx = idx.parent() + return self.isExpanded(idx) + + def recount(self, *args): + ''' + Rebuild the category tree, expand any categories that were expanded, + reset the search states, and reselect the current node. + ''' + if self.disable_recounting or not self.pane_is_visible: + return + self.refresh_signal_processed = True + ci = self.currentIndex() + if not ci.isValid(): + ci = self.indexAt(QPoint(10, 10)) + path = self.model().path_for_index(ci) if self.is_visible(ci) else None + expanded_categories, state_map = self.model().get_state() + self.set_new_model(state_map=state_map) + for category in expanded_categories: + self.expand(self.model().index_for_category(category)) + self._model.show_item_at_path(path) + + def item_expanded(self, idx): + ''' + Called by the expanded signal + ''' + self.setCurrentIndex(idx) + + def set_new_model(self, filter_categories_by=None, state_map={}): + ''' + There are cases where we need to rebuild the category tree without + attempting to reposition the current node. + ''' + try: + old = getattr(self, '_model', None) + if old is not None: + old.break_cycles() + self._model = TagsModel(self.db, parent=self, + hidden_categories=self.hidden_categories, + search_restriction=self.search_restriction, + drag_drop_finished=self.drag_drop_finished, + filter_categories_by=filter_categories_by, + collapse_model=self.collapse_model, + state_map=state_map) + self.setModel(self._model) + except: + # The DB must be gone. Set the model to None and hope that someone + # will call set_database later. I don't know if this in fact works. + # But perhaps a Bad Thing Happened, so print the exception + traceback.print_exc() + self._model = None + self.setModel(None) + # }}} + + diff --git a/src/calibre/gui2/ui.py b/src/calibre/gui2/ui.py index cf9f6ee610..5007d343ce 100644 --- a/src/calibre/gui2/ui.py +++ b/src/calibre/gui2/ui.py @@ -39,7 +39,7 @@ from calibre.gui2.jobs import JobManager, JobsDialog, JobsButton from calibre.gui2.init import LibraryViewMixin, LayoutMixin from calibre.gui2.search_box import SearchBoxMixin, SavedSearchBoxMixin from calibre.gui2.search_restriction_mixin import SearchRestrictionMixin -from calibre.gui2.tag_view import TagBrowserMixin +from calibre.gui2.tag_browser.ui import TagBrowserMixin class Listener(Thread): # {{{ From 4e1cafbce9de6a8dfa50095d6cdf5c140f22a619 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Sat, 25 Jun 2011 11:31:55 -0600 Subject: [PATCH 12/24] Tag Browser: Replace the use of internalPointer() with internalId() --- src/calibre/gui2/tag_browser/model.py | 66 +++++++++++++++++---------- src/calibre/gui2/tag_browser/view.py | 8 ++-- 2 files changed, 46 insertions(+), 28 deletions(-) diff --git a/src/calibre/gui2/tag_browser/model.py b/src/calibre/gui2/tag_browser/model.py index 7f02518b80..16beefc995 100644 --- a/src/calibre/gui2/tag_browser/model.py +++ b/src/calibre/gui2/tag_browser/model.py @@ -25,7 +25,6 @@ from calibre.utils.search_query_parser import saved_searches TAG_SEARCH_STATES = {'clear': 0, 'mark_plus': 1, 'mark_plusplus': 2, 'mark_minus': 3, 'mark_minusminus': 4} - class TagTreeItem(object): # {{{ CATEGORY = 0 @@ -201,6 +200,7 @@ class TagsModel(QAbstractItemModel): # {{{ filter_categories_by=None, collapse_model='disable', state_map={}): QAbstractItemModel.__init__(self, parent) + self.node_map = {} # must do this here because 'QPixmap: Must construct a QApplication # before a QPaintDevice'. The ':' at the end avoids polluting either of @@ -228,7 +228,7 @@ class TagsModel(QAbstractItemModel): # {{{ data = self._get_category_nodes(config['sort_tags_by']) gst = db.prefs.get('grouped_search_terms', {}) - self.root_item = TagTreeItem(icon_map=self.icon_state_map) + self.root_item = self.create_node(icon_map=self.icon_state_map) self.category_nodes = [] last_category_node = None @@ -261,7 +261,7 @@ class TagsModel(QAbstractItemModel): # {{{ for i,p in enumerate(path_parts): path += p if path not in category_node_map: - node = TagTreeItem(parent=last_category_node, + node = self.create_node(parent=last_category_node, data=p[1:] if i == 0 else p, category_icon=self.category_icon_map[key], tooltip=tt if path == key else path, @@ -282,7 +282,7 @@ class TagsModel(QAbstractItemModel): # {{{ tree_root = tree_root[p] path += '.' else: - node = TagTreeItem(parent=self.root_item, + node = self.create_node(parent=self.root_item, data=self.categories[key], category_icon=self.category_icon_map[key], tooltip=tt, category_key=key, @@ -296,6 +296,9 @@ class TagsModel(QAbstractItemModel): # {{{ def break_cycles(self): self.root_item.break_cycles() self.db = self.root_item = None + self.node_map = {} + #traceback.print_stack() + #print # Drag'n Drop {{{ def mimeTypes(self): @@ -307,7 +310,7 @@ class TagsModel(QAbstractItemModel): # {{{ for idx in indexes: if idx.isValid(): # get some useful serializable data - node = idx.internalPointer() + node = self.get_node(idx) path = self.path_for_index(idx) if node.type == TagTreeItem.CATEGORY: d = (node.type, node.py_name, node.category_key) @@ -340,7 +343,7 @@ class TagsModel(QAbstractItemModel): # {{{ def do_drop_from_tag_browser(self, md, action, row, column, parent): if not parent.isValid(): return False - dest = parent.internalPointer() + dest = self.get_node(parent) if dest.type != TagTreeItem.CATEGORY: return False if not md.hasFormat('application/calibre+from_tag_browser'): @@ -418,7 +421,8 @@ class TagsModel(QAbstractItemModel): # {{{ node = self.index_for_path(path) if node: copied = process_source_node(user_cats, src_parent, src_parent_is_gst, - is_uc, dest_key, node.internalPointer()) + is_uc, dest_key, + self.get_node(node)) self.db.prefs.set('user_categories', user_cats) self.tags_view.recount() @@ -435,7 +439,7 @@ class TagsModel(QAbstractItemModel): # {{{ path[-1] = p - 1 idx = m.index_for_path(path) self.tags_view.setExpanded(idx, True) - if idx.internalPointer().type == TagTreeItem.TAG: + if self.get_node(idx).type == TagTreeItem.TAG: m.show_item_at_index(idx, box=True) else: m.show_item_at_index(idx) @@ -638,6 +642,20 @@ class TagsModel(QAbstractItemModel): # {{{ traceback.print_stack() return False + def create_node(self, *args, **kwargs): + node = TagTreeItem(*args, **kwargs) + self.node_map[id(node)] = node + return node + + def get_node(self, idx): + ans = self.node_map.get(idx.internalId(), self.root_item) + return ans + + def createIndex(self, row, column, internal_pointer=None): + idx = QAbstractItemModel.createIndex(self, row, column, + id(internal_pointer)) + return idx + def _create_node_tree(self, data, state_map): ''' Called by __init__. Do not directly call this method. @@ -666,7 +684,7 @@ class TagsModel(QAbstractItemModel): # {{{ def process_one_node(category, state_map): # {{{ collapse_letter = None category_index = self.createIndex(category.row(), 0, category) - category_node = category_index.internalPointer() + category_node = category key = category_node.category_key if key not in data: return @@ -733,7 +751,7 @@ class TagsModel(QAbstractItemModel): # {{{ name = eval_formatter.safe_format(collapse_template, d, 'TAG_VIEW', None) self.beginInsertRows(category_index, 999998, 999999) #len(data[key])-1) - sub_cat = TagTreeItem(parent=category, data = name, + sub_cat = self.create_node(parent=category, data = name, tooltip = None, temporary=True, category_icon = category_node.icon, category_key=category_node.category_key, @@ -744,7 +762,7 @@ class TagsModel(QAbstractItemModel): # {{{ cl = cl_list[idx] if cl != collapse_letter: collapse_letter = cl - sub_cat = TagTreeItem(parent=category, + sub_cat = self.create_node(parent=category, data = collapse_letter, category_icon = category_node.icon, tooltip = None, temporary=True, @@ -767,7 +785,7 @@ class TagsModel(QAbstractItemModel): # {{{ key not in self.db.prefs.get('categories_using_hierarchy', []) or len(components) == 1): self.beginInsertRows(category_index, 999998, 999999) - n = TagTreeItem(parent=node_parent, data=tag, tooltip=tt, + n = self.create_node(parent=node_parent, data=tag, tooltip=tt, icon_map=self.icon_state_map) if tag.id_set is not None: n.id_set |= tag.id_set @@ -803,7 +821,7 @@ class TagsModel(QAbstractItemModel): # {{{ '5state' if t.category != 'search' else '3state' t.name = comp self.beginInsertRows(category_index, 999998, 999999) - node_parent = TagTreeItem(parent=node_parent, data=t, + node_parent = self.create_node(parent=node_parent, data=t, tooltip=tt, icon_map=self.icon_state_map) child_map[(comp,tag.category)] = node_parent self.endInsertRows() @@ -837,7 +855,7 @@ class TagsModel(QAbstractItemModel): # {{{ def data(self, index, role): if not index.isValid(): return NONE - item = index.internalPointer() + item = self.get_node(index) return item.data(role) def setData(self, index, value, role=Qt.EditRole): @@ -852,7 +870,7 @@ class TagsModel(QAbstractItemModel): # {{{ error_dialog(self.tags_view, _('Item is blank'), _('An item cannot be set to nothing. Delete it instead.')).exec_() return False - item = index.internalPointer() + item = self.get_node(index) if item.type == TagTreeItem.CATEGORY and item.category_key.startswith('@'): if val.find('.') >= 0: error_dialog(self.tags_view, _('Rename user category'), @@ -1022,7 +1040,7 @@ class TagsModel(QAbstractItemModel): # {{{ if not parent.isValid(): parent_item = self.root_item else: - parent_item = parent.internalPointer() + parent_item = self.get_node(parent) try: child_item = parent_item.children[row] @@ -1036,7 +1054,7 @@ class TagsModel(QAbstractItemModel): # {{{ if not index.isValid(): return QModelIndex() - child_item = index.internalPointer() + child_item = self.get_node(index) parent_item = getattr(child_item, 'parent', None) if parent_item is self.root_item or parent_item is None: @@ -1052,7 +1070,7 @@ class TagsModel(QAbstractItemModel): # {{{ if not parent.isValid(): parent_item = self.root_item else: - parent_item = parent.internalPointer() + parent_item = self.get_node(parent) return len(parent_item.children) @@ -1083,7 +1101,7 @@ class TagsModel(QAbstractItemModel): # {{{ set_to: None => advance the state, otherwise a value from TAG_SEARCH_STATES ''' if not index.isValid(): return False - item = index.internalPointer() + item = self.get_node(index) item.toggle(set_to=set_to) if exclusive: self.reset_all_states(except_=item.tag) @@ -1212,10 +1230,10 @@ class TagsModel(QAbstractItemModel): # {{{ return False if path[depth] > start_path[depth]: start_path = path - my_key = category_index.internalPointer().category_key + my_key = self.get_node(category_index).category_key for j in xrange(self.rowCount(category_index)): tag_index = self.index(j, 0, category_index) - tag_item = tag_index.internalPointer() + tag_item = self.get_node(tag_index) if tag_item.type == TagTreeItem.CATEGORY: if process_level(depth+1, tag_index, start_path): return True @@ -1240,7 +1258,7 @@ class TagsModel(QAbstractItemModel): # {{{ for i in xrange(self.rowCount(parent)): idx = self.index(i, 0, parent) - node = idx.internalPointer() + node = self.get_node(idx) if node.type == TagTreeItem.CATEGORY: ckey = node.category_key if strcmp(ckey, key) == 0: @@ -1269,7 +1287,7 @@ class TagsModel(QAbstractItemModel): # {{{ self.tags_view.scrollTo(idx, position) self.tags_view.setCurrentIndex(idx) if box: - tag_item = idx.internalPointer() + tag_item = self.get_node(idx) tag_item.boxed = True self.dataChanged.emit(idx, idx) @@ -1287,7 +1305,7 @@ class TagsModel(QAbstractItemModel): # {{{ def process_level(category_index): for j in xrange(self.rowCount(category_index)): tag_index = self.index(j, 0, category_index) - tag_item = tag_index.internalPointer() + tag_item = self.get_node(tag_index) if tag_item.boxed: tag_item.boxed = False self.dataChanged.emit(tag_index, tag_index) diff --git a/src/calibre/gui2/tag_browser/view.py b/src/calibre/gui2/tag_browser/view.py index 79ab1448bf..0cafcd2b63 100644 --- a/src/calibre/gui2/tag_browser/view.py +++ b/src/calibre/gui2/tag_browser/view.py @@ -22,7 +22,7 @@ from calibre.utils.icu import sort_key class TagDelegate(QItemDelegate): # {{{ def paint(self, painter, option, index): - item = index.internalPointer() + item = index.data(Qt.UserRole).toPyObject() if item.type != TagTreeItem.TAG: QItemDelegate.paint(self, painter, option, index) return @@ -301,7 +301,7 @@ class TagsView(QTreeView): # {{{ self.context_menu = QMenu(self) if index.isValid(): - item = index.internalPointer() + item = index.data(Qt.UserRole).toPyObject() tag = None if item.type == TagTreeItem.TAG: @@ -486,7 +486,7 @@ class TagsView(QTreeView): # {{{ if not index.isValid(): return src_is_tb = event.mimeData().hasFormat('application/calibre+from_tag_browser') - item = index.internalPointer() + item = index.data(Qt.UserRole).toPyObject() flags = self._model.flags(index) if item.type == TagTreeItem.TAG and flags & Qt.ItemIsDropEnabled: self.setDropIndicatorShown(not src_is_tb) @@ -520,7 +520,7 @@ class TagsView(QTreeView): # {{{ self.model().clear_state() def is_visible(self, idx): - item = idx.internalPointer() + item = idx.data(Qt.UserRole).toPyObject() if getattr(item, 'type', None) == TagTreeItem.TAG: idx = idx.parent() return self.isExpanded(idx) From 3873c2ad71ee6ea17ab393aebe9bd88e80daaf7a Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Sat, 25 Jun 2011 11:39:40 -0600 Subject: [PATCH 13/24] ... --- src/calibre/gui2/update.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/calibre/gui2/update.py b/src/calibre/gui2/update.py index d0399c6cc1..9d4d4def75 100644 --- a/src/calibre/gui2/update.py +++ b/src/calibre/gui2/update.py @@ -72,9 +72,7 @@ class UpdateNotification(QDialog): self.label = QLabel(('

'+ _('%s has been updated to version %s. ' 'See the new features.') + '

'+_('Update only if one of the ' - 'new features or bug fixes is important to you. ' - 'If the current version works well for you, there is no need to update.'))%( + '">new features.'))%( __appname__, calibre_version)) self.label.setOpenExternalLinks(True) self.label.setWordWrap(True) From bc48b5117a185a61217d8a847ab9ed78f421eb3f Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Sat, 25 Jun 2011 12:17:13 -0600 Subject: [PATCH 14/24] Remove pointless beginInsertRows/endInsertRows calls --- src/calibre/gui2/tag_browser/model.py | 7 ------- 1 file changed, 7 deletions(-) diff --git a/src/calibre/gui2/tag_browser/model.py b/src/calibre/gui2/tag_browser/model.py index 16beefc995..4022db4fd8 100644 --- a/src/calibre/gui2/tag_browser/model.py +++ b/src/calibre/gui2/tag_browser/model.py @@ -683,7 +683,6 @@ class TagsModel(QAbstractItemModel): # {{{ def process_one_node(category, state_map): # {{{ collapse_letter = None - category_index = self.createIndex(category.row(), 0, category) category_node = category key = category_node.category_key if key not in data: @@ -750,14 +749,12 @@ class TagsModel(QAbstractItemModel): # {{{ d['last'] = data[key][cat_len-1] name = eval_formatter.safe_format(collapse_template, d, 'TAG_VIEW', None) - self.beginInsertRows(category_index, 999998, 999999) #len(data[key])-1) sub_cat = self.create_node(parent=category, data = name, tooltip = None, temporary=True, category_icon = category_node.icon, category_key=category_node.category_key, icon_map=self.icon_state_map) sub_cat.tag.is_searchable = False - self.endInsertRows() else: # by 'first letter' cl = cl_list[idx] if cl != collapse_letter: @@ -784,13 +781,11 @@ class TagsModel(QAbstractItemModel): # {{{ key in ['authors', 'publisher', 'news', 'formats', 'rating'] or key not in self.db.prefs.get('categories_using_hierarchy', []) or len(components) == 1): - self.beginInsertRows(category_index, 999998, 999999) n = self.create_node(parent=node_parent, data=tag, tooltip=tt, icon_map=self.icon_state_map) if tag.id_set is not None: n.id_set |= tag.id_set category_child_map[tag.name, tag.category] = n - self.endInsertRows() else: for i,comp in enumerate(components): if i == 0: @@ -820,11 +815,9 @@ class TagsModel(QAbstractItemModel): # {{{ t.is_hierarchical = \ '5state' if t.category != 'search' else '3state' t.name = comp - self.beginInsertRows(category_index, 999998, 999999) node_parent = self.create_node(parent=node_parent, data=t, tooltip=tt, icon_map=self.icon_state_map) child_map[(comp,tag.category)] = node_parent - self.endInsertRows() # This id_set must not be None node_parent.id_set |= tag.id_set return From 4931d2d41f40842016a22f4938f63d00b8aac5bf Mon Sep 17 00:00:00 2001 From: John Schember Date: Sat, 25 Jun 2011 16:23:59 -0400 Subject: [PATCH 15/24] Fix Bug #801888: PalmDoc compression cannot compress empty string. --- src/calibre/ebooks/compression/palmdoc.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/calibre/ebooks/compression/palmdoc.py b/src/calibre/ebooks/compression/palmdoc.py index 90dabcb5a8..6069777fab 100644 --- a/src/calibre/ebooks/compression/palmdoc.py +++ b/src/calibre/ebooks/compression/palmdoc.py @@ -17,6 +17,8 @@ def decompress_doc(data): return cPalmdoc.decompress(data) def compress_doc(data): + if not data: + return u'' return cPalmdoc.compress(data) def test(): From 8ae7d310e8c9a92cd2555f9022843084108228ae Mon Sep 17 00:00:00 2001 From: John Schember Date: Sun, 26 Jun 2011 10:32:17 -0400 Subject: [PATCH 16/24] Store: OpenSearch based store base class. OpenSearch module added. Make some OPDS store use the new OpenSearchStore class. --- src/calibre/gui2/store/archive_org_plugin.py | 81 +- src/calibre/gui2/store/opensearch_store.py | 72 + .../gui2/store/pragmatic_bookshelf_plugin.py | 80 +- src/calibre/gui2/store/search_result.py | 1 + src/calibre/utils/opensearch/__init__.py | 4 + src/calibre/utils/opensearch/client.py | 39 + src/calibre/utils/opensearch/description.py | 127 + src/calibre/utils/opensearch/osfeedparser.py | 2837 +++++++++++++++++ src/calibre/utils/opensearch/query.py | 66 + src/calibre/utils/opensearch/results.py | 131 + src/calibre/utils/opensearch/url.py | 8 + 11 files changed, 3311 insertions(+), 135 deletions(-) create mode 100644 src/calibre/gui2/store/opensearch_store.py create mode 100644 src/calibre/utils/opensearch/__init__.py create mode 100644 src/calibre/utils/opensearch/client.py create mode 100644 src/calibre/utils/opensearch/description.py create mode 100644 src/calibre/utils/opensearch/osfeedparser.py create mode 100644 src/calibre/utils/opensearch/query.py create mode 100644 src/calibre/utils/opensearch/results.py create mode 100644 src/calibre/utils/opensearch/url.py diff --git a/src/calibre/gui2/store/archive_org_plugin.py b/src/calibre/gui2/store/archive_org_plugin.py index e8e96b3839..944b7aeba1 100644 --- a/src/calibre/gui2/store/archive_org_plugin.py +++ b/src/calibre/gui2/store/archive_org_plugin.py @@ -6,84 +6,35 @@ __license__ = 'GPL 3' __copyright__ = '2011, John Schember ' __docformat__ = 'restructuredtext en' -import urllib from contextlib import closing from lxml import html -from PyQt4.Qt import QUrl - -from calibre import browser, url_slash_cleaner -from calibre.gui2 import open_url -from calibre.gui2.store import StorePlugin +from calibre import browser from calibre.gui2.store.basic_config import BasicStoreConfig +from calibre.gui2.store.opensearch_store import OpenSearchStore from calibre.gui2.store.search_result import SearchResult -from calibre.gui2.store.web_store_dialog import WebStoreDialog -class ArchiveOrgStore(BasicStoreConfig, StorePlugin): - - def open(self, parent=None, detail_item=None, external=False): - url = 'http://www.archive.org/details/texts' - - if detail_item: - detail_item = url_slash_cleaner('http://www.archive.org' + detail_item) - - if external or self.config.get('open_external', False): - open_url(QUrl(url_slash_cleaner(detail_item if detail_item else url))) - else: - d = WebStoreDialog(self.gui, url, parent, detail_item) - d.setWindowTitle(self.name) - d.set_tags(self.config.get('tags', '')) - d.exec_() +class ArchiveOrgStore(BasicStoreConfig, OpenSearchStore): + open_search_url = 'http://bookserver.archive.org/catalog/opensearch.xml' + web_url = 'http://www.archive.org/details/texts' + + # http://bookserver.archive.org/catalog/ + def search(self, query, max_results=10, timeout=60): - query = query + ' AND mediatype:texts' - url = 'http://www.archive.org/search.php?query=' + urllib.quote(query) - - br = browser() - - counter = max_results - with closing(br.open(url, timeout=timeout)) as f: - doc = html.fromstring(f.read()) - for data in doc.xpath('//td[@class="hitCell"]'): - if counter <= 0: - break - - id = ''.join(data.xpath('.//a[@class="titleLink"]/@href')) - if not id: - continue - - title = ''.join(data.xpath('.//a[@class="titleLink"]//text()')) - authors = data.xpath('.//text()') - if not authors: - continue - author = None - for a in authors: - if '-' in a: - author = a.replace('-', ' ').strip() - if author: - break - if not author: - continue - - counter -= 1 - - s = SearchResult() - s.title = title.strip() - s.author = author.strip() - s.price = '$0.00' - s.detail_item = id.strip() - s.drm = SearchResult.DRM_UNLOCKED - - yield s - + for s in OpenSearchStore.search(self, query, max_results, timeout): + s.detail_item = 'http://www.archive.org/details/' + s.detail_item.split(':')[-1] + s.price = '$0.00' + s.drm = SearchResult.DRM_UNLOCKED + yield s +''' def get_details(self, search_result, timeout): - url = url_slash_cleaner('http://www.archive.org' + search_result.detail_item) - br = browser() - with closing(br.open(url, timeout=timeout)) as nf: + with closing(br.open(search_result.detail_item, timeout=timeout)) as nf: idata = html.fromstring(nf.read()) formats = ', '.join(idata.xpath('//p[@id="dl" and @class="content"]//a/text()')) search_result.formats = formats.upper() return True +''' diff --git a/src/calibre/gui2/store/opensearch_store.py b/src/calibre/gui2/store/opensearch_store.py new file mode 100644 index 0000000000..f473608309 --- /dev/null +++ b/src/calibre/gui2/store/opensearch_store.py @@ -0,0 +1,72 @@ +# -*- coding: utf-8 -*- + +from __future__ import (unicode_literals, division, absolute_import, print_function) + +__license__ = 'GPL 3' +__copyright__ = '2011, John Schember ' +__docformat__ = 'restructuredtext en' + +import mimetypes +import urllib + +from PyQt4.Qt import QUrl + +from calibre.gui2 import open_url +from calibre.gui2.store import StorePlugin +from calibre.gui2.store.search_result import SearchResult +from calibre.gui2.store.web_store_dialog import WebStoreDialog +from calibre.utils.opensearch import Client + +class OpenSearchStore(StorePlugin): + + open_search_url = '' + web_url = '' + + def open(self, parent=None, detail_item=None, external=False): + if external or self.config.get('open_external', False): + open_url(QUrl(detail_item if detail_item else self.url)) + else: + d = WebStoreDialog(self.gui, self.url, parent, detail_item) + d.setWindowTitle(self.name) + d.set_tags(self.config.get('tags', '')) + d.exec_() + + def search(self, query, max_results=10, timeout=60): + if not hasattr(self, 'open_search_url'): + return + + client = Client(self.open_search_url) + results = client.search(urllib.quote_plus(query), max_results) + + counter = max_results + for r in results: + if counter <= 0: + break + counter -= 1 + + s = SearchResult() + + s.detail_item = r.get('id', '') + + links = r.get('links', None) + for l in links: + if l.get('rel', None): + if l['rel'] == u'http://opds-spec.org/image/thumbnail': + s.cover_url = l.get('href', '') + elif l['rel'] == u'http://opds-spec.org/acquisition/buy': + s.detail_item = l.get('href', s.detail_item) + elif l['rel'] == u'http://opds-spec.org/acquisition': + s.downloads.append((l.get('type', ''), l.get('href', ''))) + + formats = [] + for mime, url in s.downloads: + ext = mimetypes.guess_extension(mime) + if ext: + formats.append(ext[1:]) + s.formats = ', '.join(formats) + + s.title = r.get('title', '') + s.author = r.get('author', '') + s.price = r.get('price', '') + + yield s diff --git a/src/calibre/gui2/store/pragmatic_bookshelf_plugin.py b/src/calibre/gui2/store/pragmatic_bookshelf_plugin.py index f3803bbcea..671186ba87 100644 --- a/src/calibre/gui2/store/pragmatic_bookshelf_plugin.py +++ b/src/calibre/gui2/store/pragmatic_bookshelf_plugin.py @@ -6,79 +6,19 @@ __license__ = 'GPL 3' __copyright__ = '2011, John Schember ' __docformat__ = 'restructuredtext en' -import urllib -from contextlib import closing - -from lxml import html - -from PyQt4.Qt import QUrl - -from calibre import browser, url_slash_cleaner -from calibre.gui2 import open_url -from calibre.gui2.store import StorePlugin from calibre.gui2.store.basic_config import BasicStoreConfig +from calibre.gui2.store.opensearch_store import OpenSearchStore from calibre.gui2.store.search_result import SearchResult -from calibre.gui2.store.web_store_dialog import WebStoreDialog -class PragmaticBookshelfStore(BasicStoreConfig, StorePlugin): +class PragmaticBookshelfStore(BasicStoreConfig, OpenSearchStore): - def open(self, parent=None, detail_item=None, external=False): - url = 'http://pragprog.com/' - - if external or self.config.get('open_external', False): - open_url(QUrl(url_slash_cleaner(detail_item if detail_item else url))) - else: - d = WebStoreDialog(self.gui, url, parent, detail_item) - d.setWindowTitle(self.name) - d.set_tags(self.config.get('tags', '')) - d.exec_() + open_search_url = 'http://pragprog.com/catalog/search-description' + web_url = 'http://pragprog.com/' + + # http://pragprog.com/catalog.opds def search(self, query, max_results=10, timeout=60): - ''' - OPDS based search. - - We really should get the catelog from http://pragprog.com/catalog.opds - and look for the application/opensearchdescription+xml entry. - Then get the opensearch description to get the search url and - format. However, we are going to be lazy and hard code it. - ''' - url = 'http://pragprog.com/catalog/search?q=' + urllib.quote_plus(query) - - br = browser() - - counter = max_results - with closing(br.open(url, timeout=timeout)) as f: - # Use html instead of etree as html allows us - # to ignore the namespace easily. - doc = html.fromstring(f.read()) - for data in doc.xpath('//entry'): - if counter <= 0: - break - - id = ''.join(data.xpath('.//link[@rel="http://opds-spec.org/acquisition/buy"]/@href')) - if not id: - continue - - price = ''.join(data.xpath('.//price/@currencycode')).strip() - price += ' ' - price += ''.join(data.xpath('.//price/text()')).strip() - if not price.strip(): - continue - - cover_url = ''.join(data.xpath('.//link[@rel="http://opds-spec.org/cover"]/@href')) - - title = ''.join(data.xpath('.//title/text()')) - author = ''.join(data.xpath('.//author//text()')) - - counter -= 1 - - s = SearchResult() - s.cover_url = cover_url - s.title = title.strip() - s.author = author.strip() - s.price = price.strip() - s.detail_item = id.strip() - s.drm = SearchResult.DRM_UNLOCKED - s.formats = 'EPUB, PDF, MOBI' - - yield s + for s in OpenSearchStore.search(self, query, max_results, timeout): + s.drm = SearchResult.DRM_UNLOCKED + s.formats = 'EPUB, PDF, MOBI' + yield s diff --git a/src/calibre/gui2/store/search_result.py b/src/calibre/gui2/store/search_result.py index 7d6ac5acad..bbe5b83c38 100644 --- a/src/calibre/gui2/store/search_result.py +++ b/src/calibre/gui2/store/search_result.py @@ -22,6 +22,7 @@ class SearchResult(object): self.detail_item = '' self.drm = None self.formats = '' + self.downloads = [] self.affiliate = False self.plugin_author = '' diff --git a/src/calibre/utils/opensearch/__init__.py b/src/calibre/utils/opensearch/__init__.py new file mode 100644 index 0000000000..f2d51febc4 --- /dev/null +++ b/src/calibre/utils/opensearch/__init__.py @@ -0,0 +1,4 @@ +from description import Description +from query import Query +from client import Client +from results import Results diff --git a/src/calibre/utils/opensearch/client.py b/src/calibre/utils/opensearch/client.py new file mode 100644 index 0000000000..434e921568 --- /dev/null +++ b/src/calibre/utils/opensearch/client.py @@ -0,0 +1,39 @@ +from description import Description +from query import Query +from results import Results + +class Client: + + """This is the class you'll probably want to be using. You simply + pass the constructor the url for the service description file and + issue a search and get back results as an iterable Results object. + + The neat thing about a Results object is that it will seamlessly + handle fetching more results from the opensearch server when it can... + so you just need to iterate and can let the paging be taken care of + for you. + + from opensearch import Client + client = Client(description_url) + results = client.search("computer") + for result in results: + print result.title + """ + + def __init__(self, url, agent="python-opensearch "): + self.agent = agent + self.description = Description(url, self.agent) + + def search(self, search_terms, page_size=25): + """Perform a search and get back a results object + """ + url = self.description.get_best_template() + query = Query(url) + + # set up initial values + query.searchTerms = search_terms + query.count = page_size + + # run the results + return Results(query, agent=self.agent) + diff --git a/src/calibre/utils/opensearch/description.py b/src/calibre/utils/opensearch/description.py new file mode 100644 index 0000000000..d486e615df --- /dev/null +++ b/src/calibre/utils/opensearch/description.py @@ -0,0 +1,127 @@ +from urllib2 import urlopen, Request +from xml.dom.minidom import parse +from url import URL + +class Description: + """A class for representing OpenSearch Description files. + """ + + def __init__(self, url="", agent=""): + """The constructor which may pass an optional url to load from. + + d = Description("http://www.example.com/description") + """ + self.agent = agent + if url: + self.load(url) + + + def load(self, url): + """For loading up a description object from a url. Normally + you'll probably just want to pass a URL into the constructor. + """ + req = Request(url, headers={'User-Agent':self.agent}) + self.dom = parse(urlopen(req)) + + # version 1.1 has repeating Url elements + self.urls = self._get_urls() + + # this is version 1.0 specific + self.url = self._get_element_text('Url') + self.format = self._get_element_text('Format') + + self.shortname = self._get_element_text('ShortName') + self.longname = self._get_element_text('LongName') + self.description = self._get_element_text('Description') + self.image = self._get_element_text('Image') + self.samplesearch = self._get_element_text('SampleSearch') + self.developer = self._get_element_text('Developer') + self.contact = self._get_element_text('Contact') + self.attribution = self._get_element_text('Attribution') + self.syndicationright = self._get_element_text('SyndicationRight') + + tag_text = self._get_element_text('Tags') + if tag_text != None: + self.tags = tag_text.split(" ") + + if self._get_element_text('AdultContent') == 'true': + self.adultcontent = True + else: + self.adultcontent = False + + def get_url_by_type(self, type): + """Walks available urls and returns them by type. Only + appropriate in opensearch v1.1 where there can be multiple + query targets. Returns none if no such type is found. + + url = description.get_url_by_type('application/rss+xml') + """ + for url in self.urls: + if url.type == type: + return url + return None + + def get_best_template(self): + """OK, best is a value judgement, but so be it. You'll get + back either the atom, rss or first template available. This + method handles the main difference between opensearch v1.0 and v1.1 + """ + # version 1.0 + if self.url: + return self.url + + # atom + if self.get_url_by_type('application/atom+xml'): + return self.get_url_by_type('application/atom+xml').template + + # rss + if self.get_url_by_type('application/rss+xml'): + return self.get_url_by_type('application/rss+xml').template + + # other possible rss type + if self.get_url_by_type('text/xml'): + return self.get_url_by_Type('text/xml').template + + # otherwise just the first one + if len(self.urls) > 0: + return self.urls[0].template + + # out of luck + return Nil + + + # these are internal methods for querying xml + + def _get_element_text(self, tag): + elements = self._get_elements(tag) + if not elements: + return None + return self._get_text(elements[0].childNodes) + + def _get_attribute_text(self, tag, attribute): + elements = self._get_elements(tag) + if not elements: + return '' + return elements[0].getAttribute('template') + + def _get_elements(self, tag): + return self.dom.getElementsByTagName(tag) + + def _get_text(self, nodes): + text = '' + for node in nodes: + if node.nodeType == node.TEXT_NODE: + text += node.data + return text.strip() + + def _get_urls(self): + urls = [] + for element in self._get_elements('Url'): + template = element.getAttribute('template') + type = element.getAttribute('type') + if template and type: + url = URL() + url.template = template + url.type = type + urls.append(url) + return urls diff --git a/src/calibre/utils/opensearch/osfeedparser.py b/src/calibre/utils/opensearch/osfeedparser.py new file mode 100644 index 0000000000..364de2b26c --- /dev/null +++ b/src/calibre/utils/opensearch/osfeedparser.py @@ -0,0 +1,2837 @@ +#!/usr/bin/env python +"""Universal feed parser + +Handles RSS 0.9x, RSS 1.0, RSS 2.0, CDF, Atom 0.3, and Atom 1.0 feeds + +Visit http://feedparser.org/ for the latest version +Visit http://feedparser.org/docs/ for the latest documentation + +Required: Python 2.1 or later +Recommended: Python 2.3 or later +Recommended: CJKCodecs and iconv_codec +""" + +__version__ = "4.0.2"# + "$Revision: 1.88 $"[11:15] + "-cvs" +__license__ = """Copyright (c) 2002-2005, Mark Pilgrim, All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE.""" +__author__ = "Mark Pilgrim " +__contributors__ = ["Jason Diamond ", + "John Beimler ", + "Fazal Majid ", + "Aaron Swartz ", + "Kevin Marks "] +_debug = 0 + +# HTTP "User-Agent" header to send to servers when downloading feeds. +# If you are embedding feedparser in a larger application, you should +# change this to your application name and URL. +# Changed by John Schember +from calibre import random_user_agent +USER_AGENT = random_user_agent() + +# HTTP "Accept" header to send to servers when downloading feeds. If you don't +# want to send an Accept header, set this to None. +ACCEPT_HEADER = "application/atom+xml,application/rdf+xml,application/rss+xml,application/x-netcdf,application/xml;q=0.9,text/xml;q=0.2,*/*;q=0.1" + +# List of preferred XML parsers, by SAX driver name. These will be tried first, +# but if they're not installed, Python will keep searching through its own list +# of pre-installed parsers until it finds one that supports everything we need. +PREFERRED_XML_PARSERS = ["drv_libxml2"] + +# If you want feedparser to automatically run HTML markup through HTML Tidy, set +# this to 1. Requires mxTidy +# or utidylib . +TIDY_MARKUP = 0 + +# List of Python interfaces for HTML Tidy, in order of preference. Only useful +# if TIDY_MARKUP = 1 +PREFERRED_TIDY_INTERFACES = ["uTidy", "mxTidy"] + +# ---------- required modules (should come with any Python distribution) ---------- +import sgmllib, re, sys, copy, urlparse, time, rfc822, types, cgi +try: + from cStringIO import StringIO as _StringIO +except: + from StringIO import StringIO as _StringIO + +# ---------- optional modules (feedparser will work without these, but with reduced functionality) ---------- + +# gzip is included with most Python distributions, but may not be available if you compiled your own +try: + import gzip +except: + gzip = None +try: + import zlib +except: + zlib = None + +# timeoutsocket allows feedparser to time out rather than hang forever on ultra-slow servers. +# Python 2.3 now has this functionality available in the standard socket library, so under +# 2.3 or later you don't need to install anything. In fact, under Python 2.4, timeoutsocket +# write all sorts of crazy errors to stderr while running my unit tests, so it's probably +# outlived its usefulness. +import socket +if hasattr(socket, 'setdefaulttimeout'): + socket.setdefaulttimeout(20) +else: + try: + import timeoutsocket # http://www.timo-tasi.org/python/timeoutsocket.py + timeoutsocket.setDefaultSocketTimeout(20) + except ImportError: + pass +import urllib, urllib2 + +# If a real XML parser is available, feedparser will attempt to use it. feedparser has +# been tested with the built-in SAX parser, PyXML, and libxml2. On platforms where the +# Python distribution does not come with an XML parser (such as Mac OS X 10.2 and some +# versions of FreeBSD), feedparser will quietly fall back on regex-based parsing. +try: + import xml.sax + xml.sax.make_parser(PREFERRED_XML_PARSERS) # test for valid parsers + from xml.sax.saxutils import escape as _xmlescape + _XML_AVAILABLE = 1 +except: + _XML_AVAILABLE = 0 + def _xmlescape(data): + data = data.replace('&', '&') + data = data.replace('>', '>') + data = data.replace('<', '<') + return data + +# base64 support for Atom feeds that contain embedded binary data +try: + import base64, binascii +except: + base64 = binascii = None + +# cjkcodecs and iconv_codec provide support for more character encodings. +# Both are available from http://cjkpython.i18n.org/ +try: + import cjkcodecs.aliases +except: + pass +try: + import iconv_codec +except: + pass + +# ---------- don't touch these ---------- +class ThingsNobodyCaresAboutButMe(Exception): pass +class CharacterEncodingOverride(ThingsNobodyCaresAboutButMe): pass +class CharacterEncodingUnknown(ThingsNobodyCaresAboutButMe): pass +class NonXMLContentType(ThingsNobodyCaresAboutButMe): pass +class UndeclaredNamespace(Exception): pass + +sgmllib.tagfind = re.compile('[a-zA-Z][-_.:a-zA-Z0-9]*') +sgmllib.special = re.compile('' % (tag, ''.join([' %s="%s"' % t for t in attrs])), escape=0) + + # match namespaces + if tag.find(':') <> -1: + prefix, suffix = tag.split(':', 1) + else: + prefix, suffix = '', tag + prefix = self.namespacemap.get(prefix, prefix) + if prefix: + prefix = prefix + '_' + + # special hack for better tracking of empty textinput/image elements in illformed feeds + if (not prefix) and tag not in ('title', 'link', 'description', 'name'): + self.intextinput = 0 + if (not prefix) and tag not in ('title', 'link', 'description', 'url', 'href', 'width', 'height'): + self.inimage = 0 + + # call special handler (if defined) or default handler + methodname = '_start_' + prefix + suffix + try: + method = getattr(self, methodname) + return method(attrsD) + except AttributeError: + return self.push(prefix + suffix, 1) + + def unknown_endtag(self, tag): + if _debug: sys.stderr.write('end %s\n' % tag) + # match namespaces + if tag.find(':') <> -1: + prefix, suffix = tag.split(':', 1) + else: + prefix, suffix = '', tag + prefix = self.namespacemap.get(prefix, prefix) + if prefix: + prefix = prefix + '_' + + # call special handler (if defined) or default handler + methodname = '_end_' + prefix + suffix + try: + method = getattr(self, methodname) + method() + except AttributeError: + self.pop(prefix + suffix) + + # track inline content + if self.incontent and self.contentparams.has_key('type') and not self.contentparams.get('type', 'xml').endswith('xml'): + # element declared itself as escaped markup, but it isn't really + self.contentparams['type'] = 'application/xhtml+xml' + if self.incontent and self.contentparams.get('type') == 'application/xhtml+xml': + tag = tag.split(':')[-1] + self.handle_data('' % tag, escape=0) + + # track xml:base and xml:lang going out of scope + if self.basestack: + self.basestack.pop() + if self.basestack and self.basestack[-1]: + self.baseuri = self.basestack[-1] + if self.langstack: + self.langstack.pop() + if self.langstack: # and (self.langstack[-1] is not None): + self.lang = self.langstack[-1] + + def handle_charref(self, ref): + # called for each character reference, e.g. for ' ', ref will be '160' + if not self.elementstack: return + ref = ref.lower() + if ref in ('34', '38', '39', '60', '62', 'x22', 'x26', 'x27', 'x3c', 'x3e'): + text = '&#%s;' % ref + else: + if ref[0] == 'x': + c = int(ref[1:], 16) + else: + c = int(ref) + text = unichr(c).encode('utf-8') + self.elementstack[-1][2].append(text) + + def handle_entityref(self, ref): + # called for each entity reference, e.g. for '©', ref will be 'copy' + if not self.elementstack: return + if _debug: sys.stderr.write('entering handle_entityref with %s\n' % ref) + if ref in ('lt', 'gt', 'quot', 'amp', 'apos'): + text = '&%s;' % ref + else: + # entity resolution graciously donated by Aaron Swartz + def name2cp(k): + import htmlentitydefs + if hasattr(htmlentitydefs, 'name2codepoint'): # requires Python 2.3 + return htmlentitydefs.name2codepoint[k] + k = htmlentitydefs.entitydefs[k] + if k.startswith('&#') and k.endswith(';'): + return int(k[2:-1]) # not in latin-1 + return ord(k) + try: name2cp(ref) + except KeyError: text = '&%s;' % ref + else: text = unichr(name2cp(ref)).encode('utf-8') + self.elementstack[-1][2].append(text) + + def handle_data(self, text, escape=1): + # called for each block of plain text, i.e. outside of any tag and + # not containing any character or entity references + if not self.elementstack: return + if escape and self.contentparams.get('type') == 'application/xhtml+xml': + text = _xmlescape(text) + self.elementstack[-1][2].append(text) + + def handle_comment(self, text): + # called for each comment, e.g. + pass + + def handle_pi(self, text): + # called for each processing instruction, e.g. + pass + + def handle_decl(self, text): + pass + + def parse_declaration(self, i): + # override internal declaration handler to handle CDATA blocks + if _debug: sys.stderr.write('entering parse_declaration\n') + if self.rawdata[i:i+9] == '', i) + if k == -1: k = len(self.rawdata) + self.handle_data(_xmlescape(self.rawdata[i+9:k]), 0) + return k+3 + else: + k = self.rawdata.find('>', i) + return k+1 + + def mapContentType(self, contentType): + contentType = contentType.lower() + if contentType == 'text': + contentType = 'text/plain' + elif contentType == 'html': + contentType = 'text/html' + elif contentType == 'xhtml': + contentType = 'application/xhtml+xml' + return contentType + + def trackNamespace(self, prefix, uri): + loweruri = uri.lower() + if (prefix, loweruri) == (None, 'http://my.netscape.com/rdf/simple/0.9/') and not self.version: + self.version = 'rss090' + if loweruri == 'http://purl.org/rss/1.0/' and not self.version: + self.version = 'rss10' + if loweruri == 'http://www.w3.org/2005/atom' and not self.version: + self.version = 'atom10' + if loweruri.find('backend.userland.com/rss') <> -1: + # match any backend.userland.com namespace + uri = 'http://backend.userland.com/rss' + loweruri = uri + if self._matchnamespaces.has_key(loweruri): + self.namespacemap[prefix] = self._matchnamespaces[loweruri] + self.namespacesInUse[self._matchnamespaces[loweruri]] = uri + else: + self.namespacesInUse[prefix or ''] = uri + + def resolveURI(self, uri): + return _urljoin(self.baseuri or '', uri) + + def decodeEntities(self, element, data): + return data + + def push(self, element, expectingText): + self.elementstack.append([element, expectingText, []]) + + def pop(self, element, stripWhitespace=1): + if not self.elementstack: return + if self.elementstack[-1][0] != element: return + + element, expectingText, pieces = self.elementstack.pop() + output = ''.join(pieces) + if stripWhitespace: + output = output.strip() + if not expectingText: return output + + # decode base64 content + if base64 and self.contentparams.get('base64', 0): + try: + output = base64.decodestring(output) + except binascii.Error: + pass + except binascii.Incomplete: + pass + + # resolve relative URIs + if (element in self.can_be_relative_uri) and output: + output = self.resolveURI(output) + + # decode entities within embedded markup + if not self.contentparams.get('base64', 0): + output = self.decodeEntities(element, output) + + # remove temporary cruft from contentparams + try: + del self.contentparams['mode'] + except KeyError: + pass + try: + del self.contentparams['base64'] + except KeyError: + pass + + # resolve relative URIs within embedded markup + if self.mapContentType(self.contentparams.get('type', 'text/html')) in self.html_types: + if element in self.can_contain_relative_uris: + output = _resolveRelativeURIs(output, self.baseuri, self.encoding) + + # sanitize embedded markup + if self.mapContentType(self.contentparams.get('type', 'text/html')) in self.html_types: + if element in self.can_contain_dangerous_markup: + output = _sanitizeHTML(output, self.encoding) + + if self.encoding and type(output) != type(u''): + try: + output = unicode(output, self.encoding) + except: + pass + + # categories/tags/keywords/whatever are handled in _end_category + if element == 'category': + return output + + # store output in appropriate place(s) + if self.inentry and not self.insource: + if element == 'content': + self.entries[-1].setdefault(element, []) + contentparams = copy.deepcopy(self.contentparams) + contentparams['value'] = output + self.entries[-1][element].append(contentparams) + elif element == 'link': + self.entries[-1][element] = output + if output: + self.entries[-1]['links'][-1]['href'] = output + else: + if element == 'description': + element = 'summary' + self.entries[-1][element] = output + if self.incontent: + contentparams = copy.deepcopy(self.contentparams) + contentparams['value'] = output + self.entries[-1][element + '_detail'] = contentparams + elif (self.infeed or self.insource) and (not self.intextinput) and (not self.inimage): + context = self._getContext() + if element == 'description': + element = 'subtitle' + context[element] = output + if element == 'link': + context['links'][-1]['href'] = output + elif self.incontent: + contentparams = copy.deepcopy(self.contentparams) + contentparams['value'] = output + context[element + '_detail'] = contentparams + return output + + def pushContent(self, tag, attrsD, defaultContentType, expectingText): + self.incontent += 1 + self.contentparams = FeedParserDict({ + 'type': self.mapContentType(attrsD.get('type', defaultContentType)), + 'language': self.lang, + 'base': self.baseuri}) + self.contentparams['base64'] = self._isBase64(attrsD, self.contentparams) + self.push(tag, expectingText) + + def popContent(self, tag): + value = self.pop(tag) + self.incontent -= 1 + self.contentparams.clear() + return value + + def _mapToStandardPrefix(self, name): + colonpos = name.find(':') + if colonpos <> -1: + prefix = name[:colonpos] + suffix = name[colonpos+1:] + prefix = self.namespacemap.get(prefix, prefix) + name = prefix + ':' + suffix + return name + + def _getAttribute(self, attrsD, name): + return attrsD.get(self._mapToStandardPrefix(name)) + + def _isBase64(self, attrsD, contentparams): + if attrsD.get('mode', '') == 'base64': + return 1 + if self.contentparams['type'].startswith('text/'): + return 0 + if self.contentparams['type'].endswith('+xml'): + return 0 + if self.contentparams['type'].endswith('/xml'): + return 0 + return 1 + + def _itsAnHrefDamnIt(self, attrsD): + href = attrsD.get('url', attrsD.get('uri', attrsD.get('href', None))) + if href: + try: + del attrsD['url'] + except KeyError: + pass + try: + del attrsD['uri'] + except KeyError: + pass + attrsD['href'] = href + return attrsD + + def _save(self, key, value): + context = self._getContext() + context.setdefault(key, value) + + def _start_rss(self, attrsD): + versionmap = {'0.91': 'rss091u', + '0.92': 'rss092', + '0.93': 'rss093', + '0.94': 'rss094'} + if not self.version: + attr_version = attrsD.get('version', '') + version = versionmap.get(attr_version) + if version: + self.version = version + elif attr_version.startswith('2.'): + self.version = 'rss20' + else: + self.version = 'rss' + + def _start_dlhottitles(self, attrsD): + self.version = 'hotrss' + + def _start_channel(self, attrsD): + self.infeed = 1 + self._cdf_common(attrsD) + _start_feedinfo = _start_channel + + def _cdf_common(self, attrsD): + if attrsD.has_key('lastmod'): + self._start_modified({}) + self.elementstack[-1][-1] = attrsD['lastmod'] + self._end_modified() + if attrsD.has_key('href'): + self._start_link({}) + self.elementstack[-1][-1] = attrsD['href'] + self._end_link() + + def _start_feed(self, attrsD): + self.infeed = 1 + versionmap = {'0.1': 'atom01', + '0.2': 'atom02', + '0.3': 'atom03'} + if not self.version: + attr_version = attrsD.get('version') + version = versionmap.get(attr_version) + if version: + self.version = version + else: + self.version = 'atom' + + def _end_channel(self): + self.infeed = 0 + _end_feed = _end_channel + + def _start_image(self, attrsD): + self.inimage = 1 + self.push('image', 0) + context = self._getContext() + context.setdefault('image', FeedParserDict()) + + def _end_image(self): + self.pop('image') + self.inimage = 0 + + def _start_textinput(self, attrsD): + self.intextinput = 1 + self.push('textinput', 0) + context = self._getContext() + context.setdefault('textinput', FeedParserDict()) + _start_textInput = _start_textinput + + def _end_textinput(self): + self.pop('textinput') + self.intextinput = 0 + _end_textInput = _end_textinput + + def _start_author(self, attrsD): + self.inauthor = 1 + self.push('author', 1) + _start_managingeditor = _start_author + _start_dc_author = _start_author + _start_dc_creator = _start_author + _start_itunes_author = _start_author + + def _end_author(self): + self.pop('author') + self.inauthor = 0 + self._sync_author_detail() + _end_managingeditor = _end_author + _end_dc_author = _end_author + _end_dc_creator = _end_author + _end_itunes_author = _end_author + + def _start_itunes_owner(self, attrsD): + self.inpublisher = 1 + self.push('publisher', 0) + + def _end_itunes_owner(self): + self.pop('publisher') + self.inpublisher = 0 + self._sync_author_detail('publisher') + + def _start_contributor(self, attrsD): + self.incontributor = 1 + context = self._getContext() + context.setdefault('contributors', []) + context['contributors'].append(FeedParserDict()) + self.push('contributor', 0) + + def _end_contributor(self): + self.pop('contributor') + self.incontributor = 0 + + def _start_dc_contributor(self, attrsD): + self.incontributor = 1 + context = self._getContext() + context.setdefault('contributors', []) + context['contributors'].append(FeedParserDict()) + self.push('name', 0) + + def _end_dc_contributor(self): + self._end_name() + self.incontributor = 0 + + def _start_name(self, attrsD): + self.push('name', 0) + _start_itunes_name = _start_name + + def _end_name(self): + value = self.pop('name') + if self.inpublisher: + self._save_author('name', value, 'publisher') + elif self.inauthor: + self._save_author('name', value) + elif self.incontributor: + self._save_contributor('name', value) + elif self.intextinput: + context = self._getContext() + context['textinput']['name'] = value + _end_itunes_name = _end_name + + def _start_width(self, attrsD): + self.push('width', 0) + + def _end_width(self): + value = self.pop('width') + try: + value = int(value) + except: + value = 0 + if self.inimage: + context = self._getContext() + context['image']['width'] = value + + def _start_height(self, attrsD): + self.push('height', 0) + + def _end_height(self): + value = self.pop('height') + try: + value = int(value) + except: + value = 0 + if self.inimage: + context = self._getContext() + context['image']['height'] = value + + def _start_url(self, attrsD): + self.push('href', 1) + _start_homepage = _start_url + _start_uri = _start_url + + def _end_url(self): + value = self.pop('href') + if self.inauthor: + self._save_author('href', value) + elif self.incontributor: + self._save_contributor('href', value) + elif self.inimage: + context = self._getContext() + context['image']['href'] = value + elif self.intextinput: + context = self._getContext() + context['textinput']['link'] = value + _end_homepage = _end_url + _end_uri = _end_url + + def _start_email(self, attrsD): + self.push('email', 0) + _start_itunes_email = _start_email + + def _end_email(self): + value = self.pop('email') + if self.inpublisher: + self._save_author('email', value, 'publisher') + elif self.inauthor: + self._save_author('email', value) + elif self.incontributor: + self._save_contributor('email', value) + _end_itunes_email = _end_email + + def _getContext(self): + if self.insource: + context = self.sourcedata + elif self.inentry: + context = self.entries[-1] + else: + context = self.feeddata + return context + + def _save_author(self, key, value, prefix='author'): + context = self._getContext() + context.setdefault(prefix + '_detail', FeedParserDict()) + context[prefix + '_detail'][key] = value + self._sync_author_detail() + + def _save_contributor(self, key, value): + context = self._getContext() + context.setdefault('contributors', [FeedParserDict()]) + context['contributors'][-1][key] = value + + def _sync_author_detail(self, key='author'): + context = self._getContext() + detail = context.get('%s_detail' % key) + if detail: + name = detail.get('name') + email = detail.get('email') + if name and email: + context[key] = '%s (%s)' % (name, email) + elif name: + context[key] = name + elif email: + context[key] = email + else: + author = context.get(key) + if not author: return + emailmatch = re.search(r'''(([a-zA-Z0-9\_\-\.\+]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?))''', author) + if not emailmatch: return + email = emailmatch.group(0) + # probably a better way to do the following, but it passes all the tests + author = author.replace(email, '') + author = author.replace('()', '') + author = author.strip() + if author and (author[0] == '('): + author = author[1:] + if author and (author[-1] == ')'): + author = author[:-1] + author = author.strip() + context.setdefault('%s_detail' % key, FeedParserDict()) + context['%s_detail' % key]['name'] = author + context['%s_detail' % key]['email'] = email + + def _start_subtitle(self, attrsD): + self.pushContent('subtitle', attrsD, 'text/plain', 1) + _start_tagline = _start_subtitle + _start_itunes_subtitle = _start_subtitle + + def _end_subtitle(self): + self.popContent('subtitle') + _end_tagline = _end_subtitle + _end_itunes_subtitle = _end_subtitle + + def _start_rights(self, attrsD): + self.pushContent('rights', attrsD, 'text/plain', 1) + _start_dc_rights = _start_rights + _start_copyright = _start_rights + + def _end_rights(self): + self.popContent('rights') + _end_dc_rights = _end_rights + _end_copyright = _end_rights + + def _start_item(self, attrsD): + self.entries.append(FeedParserDict()) + self.push('item', 0) + self.inentry = 1 + self.guidislink = 0 + id = self._getAttribute(attrsD, 'rdf:about') + if id: + context = self._getContext() + context['id'] = id + self._cdf_common(attrsD) + _start_entry = _start_item + _start_product = _start_item + + def _end_item(self): + self.pop('item') + self.inentry = 0 + _end_entry = _end_item + + def _start_dc_language(self, attrsD): + self.push('language', 1) + _start_language = _start_dc_language + + def _end_dc_language(self): + self.lang = self.pop('language') + _end_language = _end_dc_language + + def _start_dc_publisher(self, attrsD): + self.push('publisher', 1) + _start_webmaster = _start_dc_publisher + + def _end_dc_publisher(self): + self.pop('publisher') + self._sync_author_detail('publisher') + _end_webmaster = _end_dc_publisher + + def _start_published(self, attrsD): + self.push('published', 1) + _start_dcterms_issued = _start_published + _start_issued = _start_published + + def _end_published(self): + value = self.pop('published') + self._save('published_parsed', _parse_date(value)) + _end_dcterms_issued = _end_published + _end_issued = _end_published + + def _start_updated(self, attrsD): + self.push('updated', 1) + _start_modified = _start_updated + _start_dcterms_modified = _start_updated + _start_pubdate = _start_updated + _start_dc_date = _start_updated + + def _end_updated(self): + value = self.pop('updated') + parsed_value = _parse_date(value) + self._save('updated_parsed', parsed_value) + _end_modified = _end_updated + _end_dcterms_modified = _end_updated + _end_pubdate = _end_updated + _end_dc_date = _end_updated + + def _start_created(self, attrsD): + self.push('created', 1) + _start_dcterms_created = _start_created + + def _end_created(self): + value = self.pop('created') + self._save('created_parsed', _parse_date(value)) + _end_dcterms_created = _end_created + + def _start_expirationdate(self, attrsD): + self.push('expired', 1) + + def _end_expirationdate(self): + self._save('expired_parsed', _parse_date(self.pop('expired'))) + + def _start_cc_license(self, attrsD): + self.push('license', 1) + value = self._getAttribute(attrsD, 'rdf:resource') + if value: + self.elementstack[-1][2].append(value) + self.pop('license') + + def _start_creativecommons_license(self, attrsD): + self.push('license', 1) + + def _end_creativecommons_license(self): + self.pop('license') + + def _addTag(self, term, scheme, label): + context = self._getContext() + tags = context.setdefault('tags', []) + if (not term) and (not scheme) and (not label): return + value = FeedParserDict({'term': term, 'scheme': scheme, 'label': label}) + if value not in tags: + tags.append(FeedParserDict({'term': term, 'scheme': scheme, 'label': label})) + + def _start_category(self, attrsD): + if _debug: sys.stderr.write('entering _start_category with %s\n' % repr(attrsD)) + term = attrsD.get('term') + scheme = attrsD.get('scheme', attrsD.get('domain')) + label = attrsD.get('label') + self._addTag(term, scheme, label) + self.push('category', 1) + _start_dc_subject = _start_category + _start_keywords = _start_category + + def _end_itunes_keywords(self): + for term in self.pop('itunes_keywords').split(): + self._addTag(term, 'http://www.itunes.com/', None) + + def _start_itunes_category(self, attrsD): + self._addTag(attrsD.get('text'), 'http://www.itunes.com/', None) + self.push('category', 1) + + def _end_category(self): + value = self.pop('category') + if not value: return + context = self._getContext() + tags = context['tags'] + if value and len(tags) and not tags[-1]['term']: + tags[-1]['term'] = value + else: + self._addTag(value, None, None) + _end_dc_subject = _end_category + _end_keywords = _end_category + _end_itunes_category = _end_category + + def _start_cloud(self, attrsD): + self._getContext()['cloud'] = FeedParserDict(attrsD) + + def _start_link(self, attrsD): + attrsD.setdefault('rel', 'alternate') + attrsD.setdefault('type', 'text/html') + attrsD = self._itsAnHrefDamnIt(attrsD) + if attrsD.has_key('href'): + attrsD['href'] = self.resolveURI(attrsD['href']) + expectingText = self.infeed or self.inentry or self.insource + context = self._getContext() + context.setdefault('links', []) + context['links'].append(FeedParserDict(attrsD)) + if attrsD['rel'] == 'enclosure': + self._start_enclosure(attrsD) + if attrsD.has_key('href'): + expectingText = 0 + if (attrsD.get('rel') == 'alternate') and (self.mapContentType(attrsD.get('type')) in self.html_types): + context['link'] = attrsD['href'] + else: + self.push('link', expectingText) + _start_producturl = _start_link + + def _end_link(self): + value = self.pop('link') + context = self._getContext() + if self.intextinput: + context['textinput']['link'] = value + if self.inimage: + context['image']['link'] = value + _end_producturl = _end_link + + def _start_guid(self, attrsD): + self.guidislink = (attrsD.get('ispermalink', 'true') == 'true') + self.push('id', 1) + + def _end_guid(self): + value = self.pop('id') + self._save('guidislink', self.guidislink and not self._getContext().has_key('link')) + if self.guidislink: + # guid acts as link, but only if 'ispermalink' is not present or is 'true', + # and only if the item doesn't already have a link element + self._save('link', value) + + def _start_title(self, attrsD): + self.pushContent('title', attrsD, 'text/plain', self.infeed or self.inentry or self.insource) + _start_dc_title = _start_title + _start_media_title = _start_title + + def _end_title(self): + value = self.popContent('title') + context = self._getContext() + if self.intextinput: + context['textinput']['title'] = value + elif self.inimage: + context['image']['title'] = value + _end_dc_title = _end_title + _end_media_title = _end_title + + def _start_description(self, attrsD): + context = self._getContext() + if context.has_key('summary'): + self._summaryKey = 'content' + self._start_content(attrsD) + else: + self.pushContent('description', attrsD, 'text/html', self.infeed or self.inentry or self.insource) + + def _start_abstract(self, attrsD): + self.pushContent('description', attrsD, 'text/plain', self.infeed or self.inentry or self.insource) + + def _end_description(self): + if self._summaryKey == 'content': + self._end_content() + else: + value = self.popContent('description') + context = self._getContext() + if self.intextinput: + context['textinput']['description'] = value + elif self.inimage: + context['image']['description'] = value + self._summaryKey = None + _end_abstract = _end_description + + def _start_info(self, attrsD): + self.pushContent('info', attrsD, 'text/plain', 1) + _start_feedburner_browserfriendly = _start_info + + def _end_info(self): + self.popContent('info') + _end_feedburner_browserfriendly = _end_info + + def _start_generator(self, attrsD): + if attrsD: + attrsD = self._itsAnHrefDamnIt(attrsD) + if attrsD.has_key('href'): + attrsD['href'] = self.resolveURI(attrsD['href']) + self._getContext()['generator_detail'] = FeedParserDict(attrsD) + self.push('generator', 1) + + def _end_generator(self): + value = self.pop('generator') + context = self._getContext() + if context.has_key('generator_detail'): + context['generator_detail']['name'] = value + + def _start_admin_generatoragent(self, attrsD): + self.push('generator', 1) + value = self._getAttribute(attrsD, 'rdf:resource') + if value: + self.elementstack[-1][2].append(value) + self.pop('generator') + self._getContext()['generator_detail'] = FeedParserDict({'href': value}) + + def _start_admin_errorreportsto(self, attrsD): + self.push('errorreportsto', 1) + value = self._getAttribute(attrsD, 'rdf:resource') + if value: + self.elementstack[-1][2].append(value) + self.pop('errorreportsto') + + def _start_summary(self, attrsD): + context = self._getContext() + if context.has_key('summary'): + self._summaryKey = 'content' + self._start_content(attrsD) + else: + self._summaryKey = 'summary' + self.pushContent(self._summaryKey, attrsD, 'text/plain', 1) + _start_itunes_summary = _start_summary + + def _end_summary(self): + if self._summaryKey == 'content': + self._end_content() + else: + self.popContent(self._summaryKey or 'summary') + self._summaryKey = None + _end_itunes_summary = _end_summary + + def _start_enclosure(self, attrsD): + attrsD = self._itsAnHrefDamnIt(attrsD) + self._getContext().setdefault('enclosures', []).append(FeedParserDict(attrsD)) + href = attrsD.get('href') + if href: + context = self._getContext() + if not context.get('id'): + context['id'] = href + + def _start_source(self, attrsD): + self.insource = 1 + + def _end_source(self): + self.insource = 0 + self._getContext()['source'] = copy.deepcopy(self.sourcedata) + self.sourcedata.clear() + + def _start_content(self, attrsD): + self.pushContent('content', attrsD, 'text/plain', 1) + src = attrsD.get('src') + if src: + self.contentparams['src'] = src + self.push('content', 1) + + def _start_prodlink(self, attrsD): + self.pushContent('content', attrsD, 'text/html', 1) + + def _start_body(self, attrsD): + self.pushContent('content', attrsD, 'application/xhtml+xml', 1) + _start_xhtml_body = _start_body + + def _start_content_encoded(self, attrsD): + self.pushContent('content', attrsD, 'text/html', 1) + _start_fullitem = _start_content_encoded + + def _end_content(self): + copyToDescription = self.mapContentType(self.contentparams.get('type')) in (['text/plain'] + self.html_types) + value = self.popContent('content') + if copyToDescription: + self._save('description', value) + _end_body = _end_content + _end_xhtml_body = _end_content + _end_content_encoded = _end_content + _end_fullitem = _end_content + _end_prodlink = _end_content + + def _start_itunes_image(self, attrsD): + self.push('itunes_image', 0) + self._getContext()['image'] = FeedParserDict({'href': attrsD.get('href')}) + _start_itunes_link = _start_itunes_image + + def _end_itunes_block(self): + value = self.pop('itunes_block', 0) + self._getContext()['itunes_block'] = (value == 'yes') and 1 or 0 + + def _end_itunes_explicit(self): + value = self.pop('itunes_explicit', 0) + self._getContext()['itunes_explicit'] = (value == 'yes') and 1 or 0 + +if _XML_AVAILABLE: + class _StrictFeedParser(_FeedParserMixin, xml.sax.handler.ContentHandler): + def __init__(self, baseuri, baselang, encoding): + if _debug: sys.stderr.write('trying StrictFeedParser\n') + xml.sax.handler.ContentHandler.__init__(self) + _FeedParserMixin.__init__(self, baseuri, baselang, encoding) + self.bozo = 0 + self.exc = None + + def startPrefixMapping(self, prefix, uri): + self.trackNamespace(prefix, uri) + + def startElementNS(self, name, qname, attrs): + namespace, localname = name + lowernamespace = str(namespace or '').lower() + if lowernamespace.find('backend.userland.com/rss') <> -1: + # match any backend.userland.com namespace + namespace = 'http://backend.userland.com/rss' + lowernamespace = namespace + if qname and qname.find(':') > 0: + givenprefix = qname.split(':')[0] + else: + givenprefix = None + prefix = self._matchnamespaces.get(lowernamespace, givenprefix) + if givenprefix and (prefix == None or (prefix == '' and lowernamespace == '')) and not self.namespacesInUse.has_key(givenprefix): + raise UndeclaredNamespace, "'%s' is not associated with a namespace" % givenprefix + if prefix: + localname = prefix + ':' + localname + localname = str(localname).lower() + if _debug: sys.stderr.write('startElementNS: qname = %s, namespace = %s, givenprefix = %s, prefix = %s, attrs = %s, localname = %s\n' % (qname, namespace, givenprefix, prefix, attrs.items(), localname)) + + # qname implementation is horribly broken in Python 2.1 (it + # doesn't report any), and slightly broken in Python 2.2 (it + # doesn't report the xml: namespace). So we match up namespaces + # with a known list first, and then possibly override them with + # the qnames the SAX parser gives us (if indeed it gives us any + # at all). Thanks to MatejC for helping me test this and + # tirelessly telling me that it didn't work yet. + attrsD = {} + for (namespace, attrlocalname), attrvalue in attrs._attrs.items(): + lowernamespace = (namespace or '').lower() + prefix = self._matchnamespaces.get(lowernamespace, '') + if prefix: + attrlocalname = prefix + ':' + attrlocalname + attrsD[str(attrlocalname).lower()] = attrvalue + for qname in attrs.getQNames(): + attrsD[str(qname).lower()] = attrs.getValueByQName(qname) + self.unknown_starttag(localname, attrsD.items()) + + def characters(self, text): + self.handle_data(text) + + def endElementNS(self, name, qname): + namespace, localname = name + lowernamespace = str(namespace or '').lower() + if qname and qname.find(':') > 0: + givenprefix = qname.split(':')[0] + else: + givenprefix = '' + prefix = self._matchnamespaces.get(lowernamespace, givenprefix) + if prefix: + localname = prefix + ':' + localname + localname = str(localname).lower() + self.unknown_endtag(localname) + + def error(self, exc): + self.bozo = 1 + self.exc = exc + + def fatalError(self, exc): + self.error(exc) + raise exc + +class _BaseHTMLProcessor(sgmllib.SGMLParser): + elements_no_end_tag = ['area', 'base', 'basefont', 'br', 'col', 'frame', 'hr', + 'img', 'input', 'isindex', 'link', 'meta', 'param'] + + def __init__(self, encoding): + self.encoding = encoding + if _debug: sys.stderr.write('entering BaseHTMLProcessor, encoding=%s\n' % self.encoding) + sgmllib.SGMLParser.__init__(self) + + def reset(self): + self.pieces = [] + sgmllib.SGMLParser.reset(self) + + def _shorttag_replace(self, match): + tag = match.group(1) + if tag in self.elements_no_end_tag: + return '<' + tag + ' />' + else: + return '<' + tag + '>' + + def feed(self, data): + data = re.compile(r'', self._shorttag_replace, data) + data = data.replace(''', "'") + data = data.replace('"', '"') + if self.encoding and type(data) == type(u''): + data = data.encode(self.encoding) + sgmllib.SGMLParser.feed(self, data) + + def normalize_attrs(self, attrs): + # utility method to be called by descendants + attrs = [(k.lower(), v) for k, v in attrs] + attrs = [(k, k in ('rel', 'type') and v.lower() or v) for k, v in attrs] + return attrs + + def unknown_starttag(self, tag, attrs): + # called for each start tag + # attrs is a list of (attr, value) tuples + # e.g. for 

, tag='pre', attrs=[('class', 'screen')]
+        if _debug: sys.stderr.write('_BaseHTMLProcessor, unknown_starttag, tag=%s\n' % tag)
+        uattrs = []
+        # thanks to Kevin Marks for this breathtaking hack to deal with (valid) high-bit attribute values in UTF-8 feeds
+        for key, value in attrs:
+            if type(value) != type(u''):
+                value = unicode(value, self.encoding)
+            uattrs.append((unicode(key, self.encoding), value))
+        strattrs = u''.join([u' %s="%s"' % (key, value) for key, value in uattrs]).encode(self.encoding)
+        if tag in self.elements_no_end_tag:
+            self.pieces.append('<%(tag)s%(strattrs)s />' % locals())
+        else:
+            self.pieces.append('<%(tag)s%(strattrs)s>' % locals())
+
+    def unknown_endtag(self, tag):
+        # called for each end tag, e.g. for
, tag will be 'pre' + # Reconstruct the original end tag. + if tag not in self.elements_no_end_tag: + self.pieces.append("" % locals()) + + def handle_charref(self, ref): + # called for each character reference, e.g. for ' ', ref will be '160' + # Reconstruct the original character reference. + self.pieces.append('&#%(ref)s;' % locals()) + + def handle_entityref(self, ref): + # called for each entity reference, e.g. for '©', ref will be 'copy' + # Reconstruct the original entity reference. + self.pieces.append('&%(ref)s;' % locals()) + + def handle_data(self, text): + # called for each block of plain text, i.e. outside of any tag and + # not containing any character or entity references + # Store the original text verbatim. + if _debug: sys.stderr.write('_BaseHTMLProcessor, handle_text, text=%s\n' % text) + self.pieces.append(text) + + def handle_comment(self, text): + # called for each HTML comment, e.g. + # Reconstruct the original comment. + self.pieces.append('' % locals()) + + def handle_pi(self, text): + # called for each processing instruction, e.g. + # Reconstruct original processing instruction. + self.pieces.append('' % locals()) + + def handle_decl(self, text): + # called for the DOCTYPE, if present, e.g. + # + # Reconstruct original DOCTYPE + self.pieces.append('' % locals()) + + _new_declname_match = re.compile(r'[a-zA-Z][-_.a-zA-Z0-9:]*\s*').match + def _scan_name(self, i, declstartpos): + rawdata = self.rawdata + n = len(rawdata) + if i == n: + return None, -1 + m = self._new_declname_match(rawdata, i) + if m: + s = m.group() + name = s.strip() + if (i + len(s)) == n: + return None, -1 # end of buffer + return name.lower(), m.end() + else: + self.handle_data(rawdata) +# self.updatepos(declstartpos, i) + return None, -1 + + def output(self): + '''Return processed HTML as a single string''' + return ''.join([str(p) for p in self.pieces]) + +class _LooseFeedParser(_FeedParserMixin, _BaseHTMLProcessor): + def __init__(self, baseuri, baselang, encoding): + sgmllib.SGMLParser.__init__(self) + _FeedParserMixin.__init__(self, baseuri, baselang, encoding) + + def decodeEntities(self, element, data): + data = data.replace('<', '<') + data = data.replace('<', '<') + data = data.replace('>', '>') + data = data.replace('>', '>') + data = data.replace('&', '&') + data = data.replace('&', '&') + data = data.replace('"', '"') + data = data.replace('"', '"') + data = data.replace(''', ''') + data = data.replace(''', ''') + if self.contentparams.has_key('type') and not self.contentparams.get('type', 'xml').endswith('xml'): + data = data.replace('<', '<') + data = data.replace('>', '>') + data = data.replace('&', '&') + data = data.replace('"', '"') + data = data.replace(''', "'") + return data + +class _RelativeURIResolver(_BaseHTMLProcessor): + relative_uris = [('a', 'href'), + ('applet', 'codebase'), + ('area', 'href'), + ('blockquote', 'cite'), + ('body', 'background'), + ('del', 'cite'), + ('form', 'action'), + ('frame', 'longdesc'), + ('frame', 'src'), + ('iframe', 'longdesc'), + ('iframe', 'src'), + ('head', 'profile'), + ('img', 'longdesc'), + ('img', 'src'), + ('img', 'usemap'), + ('input', 'src'), + ('input', 'usemap'), + ('ins', 'cite'), + ('link', 'href'), + ('object', 'classid'), + ('object', 'codebase'), + ('object', 'data'), + ('object', 'usemap'), + ('q', 'cite'), + ('script', 'src')] + + def __init__(self, baseuri, encoding): + _BaseHTMLProcessor.__init__(self, encoding) + self.baseuri = baseuri + + def resolveURI(self, uri): + return _urljoin(self.baseuri, uri) + + def unknown_starttag(self, tag, attrs): + attrs = self.normalize_attrs(attrs) + attrs = [(key, ((tag, key) in self.relative_uris) and self.resolveURI(value) or value) for key, value in attrs] + _BaseHTMLProcessor.unknown_starttag(self, tag, attrs) + +def _resolveRelativeURIs(htmlSource, baseURI, encoding): + if _debug: sys.stderr.write('entering _resolveRelativeURIs\n') + p = _RelativeURIResolver(baseURI, encoding) + p.feed(htmlSource) + return p.output() + +class _HTMLSanitizer(_BaseHTMLProcessor): + acceptable_elements = ['a', 'abbr', 'acronym', 'address', 'area', 'b', 'big', + 'blockquote', 'br', 'button', 'caption', 'center', 'cite', 'code', 'col', + 'colgroup', 'dd', 'del', 'dfn', 'dir', 'div', 'dl', 'dt', 'em', 'fieldset', + 'font', 'form', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'input', + 'ins', 'kbd', 'label', 'legend', 'li', 'map', 'menu', 'ol', 'optgroup', + 'option', 'p', 'pre', 'q', 's', 'samp', 'select', 'small', 'span', 'strike', + 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'textarea', 'tfoot', 'th', + 'thead', 'tr', 'tt', 'u', 'ul', 'var'] + + acceptable_attributes = ['abbr', 'accept', 'accept-charset', 'accesskey', + 'action', 'align', 'alt', 'axis', 'border', 'cellpadding', 'cellspacing', + 'char', 'charoff', 'charset', 'checked', 'cite', 'class', 'clear', 'cols', + 'colspan', 'color', 'compact', 'coords', 'datetime', 'dir', 'disabled', + 'enctype', 'for', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', + 'id', 'ismap', 'label', 'lang', 'longdesc', 'maxlength', 'media', 'method', + 'multiple', 'name', 'nohref', 'noshade', 'nowrap', 'prompt', 'readonly', + 'rel', 'rev', 'rows', 'rowspan', 'rules', 'scope', 'selected', 'shape', 'size', + 'span', 'src', 'start', 'summary', 'tabindex', 'target', 'title', 'type', + 'usemap', 'valign', 'value', 'vspace', 'width'] + + unacceptable_elements_with_end_tag = ['script', 'applet'] + + def reset(self): + _BaseHTMLProcessor.reset(self) + self.unacceptablestack = 0 + + def unknown_starttag(self, tag, attrs): + if not tag in self.acceptable_elements: + if tag in self.unacceptable_elements_with_end_tag: + self.unacceptablestack += 1 + return + attrs = self.normalize_attrs(attrs) + attrs = [(key, value) for key, value in attrs if key in self.acceptable_attributes] + _BaseHTMLProcessor.unknown_starttag(self, tag, attrs) + + def unknown_endtag(self, tag): + if not tag in self.acceptable_elements: + if tag in self.unacceptable_elements_with_end_tag: + self.unacceptablestack -= 1 + return + _BaseHTMLProcessor.unknown_endtag(self, tag) + + def handle_pi(self, text): + pass + + def handle_decl(self, text): + pass + + def handle_data(self, text): + if not self.unacceptablestack: + _BaseHTMLProcessor.handle_data(self, text) + +def _sanitizeHTML(htmlSource, encoding): + p = _HTMLSanitizer(encoding) + p.feed(htmlSource) + data = p.output() + if TIDY_MARKUP: + # loop through list of preferred Tidy interfaces looking for one that's installed, + # then set up a common _tidy function to wrap the interface-specific API. + _tidy = None + for tidy_interface in PREFERRED_TIDY_INTERFACES: + try: + if tidy_interface == "uTidy": + from tidy import parseString as _utidy + def _tidy(data, **kwargs): + return str(_utidy(data, **kwargs)) + break + elif tidy_interface == "mxTidy": + from mx.Tidy import Tidy as _mxtidy + def _tidy(data, **kwargs): + nerrors, nwarnings, data, errordata = _mxtidy.tidy(data, **kwargs) + return data + break + except: + pass + if _tidy: + utf8 = type(data) == type(u'') + if utf8: + data = data.encode('utf-8') + data = _tidy(data, output_xhtml=1, numeric_entities=1, wrap=0, char_encoding="utf8") + if utf8: + data = unicode(data, 'utf-8') + if data.count(''): + data = data.split('>', 1)[1] + if data.count('= '2.3.3' + assert base64 != None + user, passw = base64.decodestring(req.headers['Authorization'].split(' ')[1]).split(':') + realm = re.findall('realm="([^"]*)"', headers['WWW-Authenticate'])[0] + self.add_password(realm, host, user, passw) + retry = self.http_error_auth_reqed('www-authenticate', host, req, headers) + self.reset_retry_count() + return retry + except: + return self.http_error_default(req, fp, code, msg, headers) + +def _open_resource(url_file_stream_or_string, etag, modified, agent, referrer, handlers): + """URL, filename, or string --> stream + + This function lets you define parsers that take any input source + (URL, pathname to local or network file, or actual data as a string) + and deal with it in a uniform manner. Returned object is guaranteed + to have all the basic stdio read methods (read, readline, readlines). + Just .close() the object when you're done with it. + + If the etag argument is supplied, it will be used as the value of an + If-None-Match request header. + + If the modified argument is supplied, it must be a tuple of 9 integers + as returned by gmtime() in the standard Python time module. This MUST + be in GMT (Greenwich Mean Time). The formatted date/time will be used + as the value of an If-Modified-Since request header. + + If the agent argument is supplied, it will be used as the value of a + User-Agent request header. + + If the referrer argument is supplied, it will be used as the value of a + Referer[sic] request header. + + If handlers is supplied, it is a list of handlers used to build a + urllib2 opener. + """ + + if hasattr(url_file_stream_or_string, 'read'): + return url_file_stream_or_string + + if url_file_stream_or_string == '-': + return sys.stdin + + if urlparse.urlparse(url_file_stream_or_string)[0] in ('http', 'https', 'ftp'): + if not agent: + agent = USER_AGENT + # test for inline user:password for basic auth + auth = None + if base64: + urltype, rest = urllib.splittype(url_file_stream_or_string) + realhost, rest = urllib.splithost(rest) + if realhost: + user_passwd, realhost = urllib.splituser(realhost) + if user_passwd: + url_file_stream_or_string = '%s://%s%s' % (urltype, realhost, rest) + auth = base64.encodestring(user_passwd).strip() + # try to open with urllib2 (to use optional headers) + request = urllib2.Request(url_file_stream_or_string) + request.add_header('User-Agent', agent) + if etag: + request.add_header('If-None-Match', etag) + if modified: + # format into an RFC 1123-compliant timestamp. We can't use + # time.strftime() since the %a and %b directives can be affected + # by the current locale, but RFC 2616 states that dates must be + # in English. + short_weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'] + months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'] + request.add_header('If-Modified-Since', '%s, %02d %s %04d %02d:%02d:%02d GMT' % (short_weekdays[modified[6]], modified[2], months[modified[1] - 1], modified[0], modified[3], modified[4], modified[5])) + if referrer: + request.add_header('Referer', referrer) + if gzip and zlib: + request.add_header('Accept-encoding', 'gzip, deflate') + elif gzip: + request.add_header('Accept-encoding', 'gzip') + elif zlib: + request.add_header('Accept-encoding', 'deflate') + else: + request.add_header('Accept-encoding', '') + if auth: + request.add_header('Authorization', 'Basic %s' % auth) + if ACCEPT_HEADER: + request.add_header('Accept', ACCEPT_HEADER) + request.add_header('A-IM', 'feed') # RFC 3229 support + opener = apply(urllib2.build_opener, tuple([_FeedURLHandler()] + handlers)) + opener.addheaders = [] # RMK - must clear so we only send our custom User-Agent + try: + return opener.open(request) + finally: + opener.close() # JohnD + + # try to open with native open function (if url_file_stream_or_string is a filename) + try: + return open(url_file_stream_or_string) + except: + pass + + # treat url_file_stream_or_string as string + return _StringIO(str(url_file_stream_or_string)) + +_date_handlers = [] +def registerDateHandler(func): + '''Register a date handler function (takes string, returns 9-tuple date in GMT)''' + _date_handlers.insert(0, func) + +# ISO-8601 date parsing routines written by Fazal Majid. +# The ISO 8601 standard is very convoluted and irregular - a full ISO 8601 +# parser is beyond the scope of feedparser and would be a worthwhile addition +# to the Python library. +# A single regular expression cannot parse ISO 8601 date formats into groups +# as the standard is highly irregular (for instance is 030104 2003-01-04 or +# 0301-04-01), so we use templates instead. +# Please note the order in templates is significant because we need a +# greedy match. +_iso8601_tmpl = ['YYYY-?MM-?DD', 'YYYY-MM', 'YYYY-?OOO', + 'YY-?MM-?DD', 'YY-?OOO', 'YYYY', + '-YY-?MM', '-OOO', '-YY', + '--MM-?DD', '--MM', + '---DD', + 'CC', ''] +_iso8601_re = [ + tmpl.replace( + 'YYYY', r'(?P\d{4})').replace( + 'YY', r'(?P\d\d)').replace( + 'MM', r'(?P[01]\d)').replace( + 'DD', r'(?P[0123]\d)').replace( + 'OOO', r'(?P[0123]\d\d)').replace( + 'CC', r'(?P\d\d$)') + + r'(T?(?P\d{2}):(?P\d{2})' + + r'(:(?P\d{2}))?' + + r'(?P[+-](?P\d{2})(:(?P\d{2}))?|Z)?)?' + for tmpl in _iso8601_tmpl] +del tmpl +_iso8601_matches = [re.compile(regex).match for regex in _iso8601_re] +del regex +def _parse_date_iso8601(dateString): + '''Parse a variety of ISO-8601-compatible formats like 20040105''' + m = None + for _iso8601_match in _iso8601_matches: + m = _iso8601_match(dateString) + if m: break + if not m: return + if m.span() == (0, 0): return + params = m.groupdict() + ordinal = params.get('ordinal', 0) + if ordinal: + ordinal = int(ordinal) + else: + ordinal = 0 + year = params.get('year', '--') + if not year or year == '--': + year = time.gmtime()[0] + elif len(year) == 2: + # ISO 8601 assumes current century, i.e. 93 -> 2093, NOT 1993 + year = 100 * int(time.gmtime()[0] / 100) + int(year) + else: + year = int(year) + month = params.get('month', '-') + if not month or month == '-': + # ordinals are NOT normalized by mktime, we simulate them + # by setting month=1, day=ordinal + if ordinal: + month = 1 + else: + month = time.gmtime()[1] + month = int(month) + day = params.get('day', 0) + if not day: + # see above + if ordinal: + day = ordinal + elif params.get('century', 0) or \ + params.get('year', 0) or params.get('month', 0): + day = 1 + else: + day = time.gmtime()[2] + else: + day = int(day) + # special case of the century - is the first year of the 21st century + # 2000 or 2001 ? The debate goes on... + if 'century' in params.keys(): + year = (int(params['century']) - 1) * 100 + 1 + # in ISO 8601 most fields are optional + for field in ['hour', 'minute', 'second', 'tzhour', 'tzmin']: + if not params.get(field, None): + params[field] = 0 + hour = int(params.get('hour', 0)) + minute = int(params.get('minute', 0)) + second = int(params.get('second', 0)) + # weekday is normalized by mktime(), we can ignore it + weekday = 0 + # daylight savings is complex, but not needed for feedparser's purposes + # as time zones, if specified, include mention of whether it is active + # (e.g. PST vs. PDT, CET). Using -1 is implementation-dependent and + # and most implementations have DST bugs + daylight_savings_flag = 0 + tm = [year, month, day, hour, minute, second, weekday, + ordinal, daylight_savings_flag] + # ISO 8601 time zone adjustments + tz = params.get('tz') + if tz and tz != 'Z': + if tz[0] == '-': + tm[3] += int(params.get('tzhour', 0)) + tm[4] += int(params.get('tzmin', 0)) + elif tz[0] == '+': + tm[3] -= int(params.get('tzhour', 0)) + tm[4] -= int(params.get('tzmin', 0)) + else: + return None + # Python's time.mktime() is a wrapper around the ANSI C mktime(3c) + # which is guaranteed to normalize d/m/y/h/m/s. + # Many implementations have bugs, but we'll pretend they don't. + return time.localtime(time.mktime(tm)) +registerDateHandler(_parse_date_iso8601) + +# 8-bit date handling routines written by ytrewq1. +_korean_year = u'\ub144' # b3e2 in euc-kr +_korean_month = u'\uc6d4' # bff9 in euc-kr +_korean_day = u'\uc77c' # c0cf in euc-kr +_korean_am = u'\uc624\uc804' # bfc0 c0fc in euc-kr +_korean_pm = u'\uc624\ud6c4' # bfc0 c8c4 in euc-kr + +_korean_onblog_date_re = \ + re.compile('(\d{4})%s\s+(\d{2})%s\s+(\d{2})%s\s+(\d{2}):(\d{2}):(\d{2})' % \ + (_korean_year, _korean_month, _korean_day)) +_korean_nate_date_re = \ + re.compile(u'(\d{4})-(\d{2})-(\d{2})\s+(%s|%s)\s+(\d{,2}):(\d{,2}):(\d{,2})' % \ + (_korean_am, _korean_pm)) +def _parse_date_onblog(dateString): + '''Parse a string according to the OnBlog 8-bit date format''' + m = _korean_onblog_date_re.match(dateString) + if not m: return + w3dtfdate = '%(year)s-%(month)s-%(day)sT%(hour)s:%(minute)s:%(second)s%(zonediff)s' % \ + {'year': m.group(1), 'month': m.group(2), 'day': m.group(3),\ + 'hour': m.group(4), 'minute': m.group(5), 'second': m.group(6),\ + 'zonediff': '+09:00'} + if _debug: sys.stderr.write('OnBlog date parsed as: %s\n' % w3dtfdate) + return _parse_date_w3dtf(w3dtfdate) +registerDateHandler(_parse_date_onblog) + +def _parse_date_nate(dateString): + '''Parse a string according to the Nate 8-bit date format''' + m = _korean_nate_date_re.match(dateString) + if not m: return + hour = int(m.group(5)) + ampm = m.group(4) + if (ampm == _korean_pm): + hour += 12 + hour = str(hour) + if len(hour) == 1: + hour = '0' + hour + w3dtfdate = '%(year)s-%(month)s-%(day)sT%(hour)s:%(minute)s:%(second)s%(zonediff)s' % \ + {'year': m.group(1), 'month': m.group(2), 'day': m.group(3),\ + 'hour': hour, 'minute': m.group(6), 'second': m.group(7),\ + 'zonediff': '+09:00'} + if _debug: sys.stderr.write('Nate date parsed as: %s\n' % w3dtfdate) + return _parse_date_w3dtf(w3dtfdate) +registerDateHandler(_parse_date_nate) + +_mssql_date_re = \ + re.compile('(\d{4})-(\d{2})-(\d{2})\s+(\d{2}):(\d{2}):(\d{2})(\.\d+)?') +def _parse_date_mssql(dateString): + '''Parse a string according to the MS SQL date format''' + m = _mssql_date_re.match(dateString) + if not m: return + w3dtfdate = '%(year)s-%(month)s-%(day)sT%(hour)s:%(minute)s:%(second)s%(zonediff)s' % \ + {'year': m.group(1), 'month': m.group(2), 'day': m.group(3),\ + 'hour': m.group(4), 'minute': m.group(5), 'second': m.group(6),\ + 'zonediff': '+09:00'} + if _debug: sys.stderr.write('MS SQL date parsed as: %s\n' % w3dtfdate) + return _parse_date_w3dtf(w3dtfdate) +registerDateHandler(_parse_date_mssql) + +# Unicode strings for Greek date strings +_greek_months = \ + { \ + u'\u0399\u03b1\u03bd': u'Jan', # c9e1ed in iso-8859-7 + u'\u03a6\u03b5\u03b2': u'Feb', # d6e5e2 in iso-8859-7 + u'\u039c\u03ac\u03ce': u'Mar', # ccdcfe in iso-8859-7 + u'\u039c\u03b1\u03ce': u'Mar', # cce1fe in iso-8859-7 + u'\u0391\u03c0\u03c1': u'Apr', # c1f0f1 in iso-8859-7 + u'\u039c\u03ac\u03b9': u'May', # ccdce9 in iso-8859-7 + u'\u039c\u03b1\u03ca': u'May', # cce1fa in iso-8859-7 + u'\u039c\u03b1\u03b9': u'May', # cce1e9 in iso-8859-7 + u'\u0399\u03bf\u03cd\u03bd': u'Jun', # c9effded in iso-8859-7 + u'\u0399\u03bf\u03bd': u'Jun', # c9efed in iso-8859-7 + u'\u0399\u03bf\u03cd\u03bb': u'Jul', # c9effdeb in iso-8859-7 + u'\u0399\u03bf\u03bb': u'Jul', # c9f9eb in iso-8859-7 + u'\u0391\u03cd\u03b3': u'Aug', # c1fde3 in iso-8859-7 + u'\u0391\u03c5\u03b3': u'Aug', # c1f5e3 in iso-8859-7 + u'\u03a3\u03b5\u03c0': u'Sep', # d3e5f0 in iso-8859-7 + u'\u039f\u03ba\u03c4': u'Oct', # cfeaf4 in iso-8859-7 + u'\u039d\u03bf\u03ad': u'Nov', # cdefdd in iso-8859-7 + u'\u039d\u03bf\u03b5': u'Nov', # cdefe5 in iso-8859-7 + u'\u0394\u03b5\u03ba': u'Dec', # c4e5ea in iso-8859-7 + } + +_greek_wdays = \ + { \ + u'\u039a\u03c5\u03c1': u'Sun', # caf5f1 in iso-8859-7 + u'\u0394\u03b5\u03c5': u'Mon', # c4e5f5 in iso-8859-7 + u'\u03a4\u03c1\u03b9': u'Tue', # d4f1e9 in iso-8859-7 + u'\u03a4\u03b5\u03c4': u'Wed', # d4e5f4 in iso-8859-7 + u'\u03a0\u03b5\u03bc': u'Thu', # d0e5ec in iso-8859-7 + u'\u03a0\u03b1\u03c1': u'Fri', # d0e1f1 in iso-8859-7 + u'\u03a3\u03b1\u03b2': u'Sat', # d3e1e2 in iso-8859-7 + } + +_greek_date_format_re = \ + re.compile(u'([^,]+),\s+(\d{2})\s+([^\s]+)\s+(\d{4})\s+(\d{2}):(\d{2}):(\d{2})\s+([^\s]+)') + +def _parse_date_greek(dateString): + '''Parse a string according to a Greek 8-bit date format.''' + m = _greek_date_format_re.match(dateString) + if not m: return + try: + wday = _greek_wdays[m.group(1)] + month = _greek_months[m.group(3)] + except: + return + rfc822date = '%(wday)s, %(day)s %(month)s %(year)s %(hour)s:%(minute)s:%(second)s %(zonediff)s' % \ + {'wday': wday, 'day': m.group(2), 'month': month, 'year': m.group(4),\ + 'hour': m.group(5), 'minute': m.group(6), 'second': m.group(7),\ + 'zonediff': m.group(8)} + if _debug: sys.stderr.write('Greek date parsed as: %s\n' % rfc822date) + return _parse_date_rfc822(rfc822date) +registerDateHandler(_parse_date_greek) + +# Unicode strings for Hungarian date strings +_hungarian_months = \ + { \ + u'janu\u00e1r': u'01', # e1 in iso-8859-2 + u'febru\u00e1ri': u'02', # e1 in iso-8859-2 + u'm\u00e1rcius': u'03', # e1 in iso-8859-2 + u'\u00e1prilis': u'04', # e1 in iso-8859-2 + u'm\u00e1ujus': u'05', # e1 in iso-8859-2 + u'j\u00fanius': u'06', # fa in iso-8859-2 + u'j\u00falius': u'07', # fa in iso-8859-2 + u'augusztus': u'08', + u'szeptember': u'09', + u'okt\u00f3ber': u'10', # f3 in iso-8859-2 + u'november': u'11', + u'december': u'12', + } + +_hungarian_date_format_re = \ + re.compile(u'(\d{4})-([^-]+)-(\d{,2})T(\d{,2}):(\d{2})((\+|-)(\d{,2}:\d{2}))') + +def _parse_date_hungarian(dateString): + '''Parse a string according to a Hungarian 8-bit date format.''' + m = _hungarian_date_format_re.match(dateString) + if not m: return + try: + month = _hungarian_months[m.group(2)] + day = m.group(3) + if len(day) == 1: + day = '0' + day + hour = m.group(4) + if len(hour) == 1: + hour = '0' + hour + except: + return + w3dtfdate = '%(year)s-%(month)s-%(day)sT%(hour)s:%(minute)s%(zonediff)s' % \ + {'year': m.group(1), 'month': month, 'day': day,\ + 'hour': hour, 'minute': m.group(5),\ + 'zonediff': m.group(6)} + if _debug: sys.stderr.write('Hungarian date parsed as: %s\n' % w3dtfdate) + return _parse_date_w3dtf(w3dtfdate) +registerDateHandler(_parse_date_hungarian) + +# W3DTF-style date parsing adapted from PyXML xml.utils.iso8601, written by +# Drake and licensed under the Python license. Removed all range checking +# for month, day, hour, minute, and second, since mktime will normalize +# these later +def _parse_date_w3dtf(dateString): + def __extract_date(m): + year = int(m.group('year')) + if year < 100: + year = 100 * int(time.gmtime()[0] / 100) + int(year) + if year < 1000: + return 0, 0, 0 + julian = m.group('julian') + if julian: + julian = int(julian) + month = julian / 30 + 1 + day = julian % 30 + 1 + jday = None + while jday != julian: + t = time.mktime((year, month, day, 0, 0, 0, 0, 0, 0)) + jday = time.gmtime(t)[-2] + diff = abs(jday - julian) + if jday > julian: + if diff < day: + day = day - diff + else: + month = month - 1 + day = 31 + elif jday < julian: + if day + diff < 28: + day = day + diff + else: + month = month + 1 + return year, month, day + month = m.group('month') + day = 1 + if month is None: + month = 1 + else: + month = int(month) + day = m.group('day') + if day: + day = int(day) + else: + day = 1 + return year, month, day + + def __extract_time(m): + if not m: + return 0, 0, 0 + hours = m.group('hours') + if not hours: + return 0, 0, 0 + hours = int(hours) + minutes = int(m.group('minutes')) + seconds = m.group('seconds') + if seconds: + seconds = int(seconds) + else: + seconds = 0 + return hours, minutes, seconds + + def __extract_tzd(m): + '''Return the Time Zone Designator as an offset in seconds from UTC.''' + if not m: + return 0 + tzd = m.group('tzd') + if not tzd: + return 0 + if tzd == 'Z': + return 0 + hours = int(m.group('tzdhours')) + minutes = m.group('tzdminutes') + if minutes: + minutes = int(minutes) + else: + minutes = 0 + offset = (hours*60 + minutes) * 60 + if tzd[0] == '+': + return -offset + return offset + + __date_re = ('(?P\d\d\d\d)' + '(?:(?P-|)' + '(?:(?P\d\d\d)' + '|(?P\d\d)(?:(?P=dsep)(?P\d\d))?))?') + __tzd_re = '(?P[-+](?P\d\d)(?::?(?P\d\d))|Z)' + __tzd_rx = re.compile(__tzd_re) + __time_re = ('(?P\d\d)(?P:|)(?P\d\d)' + '(?:(?P=tsep)(?P\d\d(?:[.,]\d+)?))?' + + __tzd_re) + __datetime_re = '%s(?:T%s)?' % (__date_re, __time_re) + __datetime_rx = re.compile(__datetime_re) + m = __datetime_rx.match(dateString) + if (m is None) or (m.group() != dateString): return + gmt = __extract_date(m) + __extract_time(m) + (0, 0, 0) + if gmt[0] == 0: return + return time.gmtime(time.mktime(gmt) + __extract_tzd(m) - time.timezone) +registerDateHandler(_parse_date_w3dtf) + +def _parse_date_rfc822(dateString): + '''Parse an RFC822, RFC1123, RFC2822, or asctime-style date''' + data = dateString.split() + if data[0][-1] in (',', '.') or data[0].lower() in rfc822._daynames: + del data[0] + if len(data) == 4: + s = data[3] + i = s.find('+') + if i > 0: + data[3:] = [s[:i], s[i+1:]] + else: + data.append('') + dateString = " ".join(data) + if len(data) < 5: + dateString += ' 00:00:00 GMT' + tm = rfc822.parsedate_tz(dateString) + if tm: + return time.gmtime(rfc822.mktime_tz(tm)) +# rfc822.py defines several time zones, but we define some extra ones. +# 'ET' is equivalent to 'EST', etc. +_additional_timezones = {'AT': -400, 'ET': -500, 'CT': -600, 'MT': -700, 'PT': -800} +rfc822._timezones.update(_additional_timezones) +registerDateHandler(_parse_date_rfc822) + +def _parse_date(dateString): + '''Parses a variety of date formats into a 9-tuple in GMT''' + for handler in _date_handlers: + try: + date9tuple = handler(dateString) + if not date9tuple: continue + if len(date9tuple) != 9: + if _debug: sys.stderr.write('date handler function must return 9-tuple\n') + raise ValueError + map(int, date9tuple) + return date9tuple + except Exception, e: + if _debug: sys.stderr.write('%s raised %s\n' % (handler.__name__, repr(e))) + pass + return None + +def _getCharacterEncoding(http_headers, xml_data): + '''Get the character encoding of the XML document + + http_headers is a dictionary + xml_data is a raw string (not Unicode) + + This is so much trickier than it sounds, it's not even funny. + According to RFC 3023 ('XML Media Types'), if the HTTP Content-Type + is application/xml, application/*+xml, + application/xml-external-parsed-entity, or application/xml-dtd, + the encoding given in the charset parameter of the HTTP Content-Type + takes precedence over the encoding given in the XML prefix within the + document, and defaults to 'utf-8' if neither are specified. But, if + the HTTP Content-Type is text/xml, text/*+xml, or + text/xml-external-parsed-entity, the encoding given in the XML prefix + within the document is ALWAYS IGNORED and only the encoding given in + the charset parameter of the HTTP Content-Type header should be + respected, and it defaults to 'us-ascii' if not specified. + + Furthermore, discussion on the atom-syntax mailing list with the + author of RFC 3023 leads me to the conclusion that any document + served with a Content-Type of text/* and no charset parameter + must be treated as us-ascii. (We now do this.) And also that it + must always be flagged as non-well-formed. (We now do this too.) + + If Content-Type is unspecified (input was local file or non-HTTP source) + or unrecognized (server just got it totally wrong), then go by the + encoding given in the XML prefix of the document and default to + 'iso-8859-1' as per the HTTP specification (RFC 2616). + + Then, assuming we didn't find a character encoding in the HTTP headers + (and the HTTP Content-type allowed us to look in the body), we need + to sniff the first few bytes of the XML data and try to determine + whether the encoding is ASCII-compatible. Section F of the XML + specification shows the way here: + http://www.w3.org/TR/REC-xml/#sec-guessing-no-ext-info + + If the sniffed encoding is not ASCII-compatible, we need to make it + ASCII compatible so that we can sniff further into the XML declaration + to find the encoding attribute, which will tell us the true encoding. + + Of course, none of this guarantees that we will be able to parse the + feed in the declared character encoding (assuming it was declared + correctly, which many are not). CJKCodecs and iconv_codec help a lot; + you should definitely install them if you can. + http://cjkpython.i18n.org/ + ''' + + def _parseHTTPContentType(content_type): + '''takes HTTP Content-Type header and returns (content type, charset) + + If no charset is specified, returns (content type, '') + If no content type is specified, returns ('', '') + Both return parameters are guaranteed to be lowercase strings + ''' + content_type = content_type or '' + content_type, params = cgi.parse_header(content_type) + return content_type, params.get('charset', '').replace("'", '') + + sniffed_xml_encoding = '' + xml_encoding = '' + true_encoding = '' + http_content_type, http_encoding = _parseHTTPContentType(http_headers.get('content-type')) + # Must sniff for non-ASCII-compatible character encodings before + # searching for XML declaration. This heuristic is defined in + # section F of the XML specification: + # http://www.w3.org/TR/REC-xml/#sec-guessing-no-ext-info + try: + if xml_data[:4] == '\x4c\x6f\xa7\x94': + # EBCDIC + xml_data = _ebcdic_to_ascii(xml_data) + elif xml_data[:4] == '\x00\x3c\x00\x3f': + # UTF-16BE + sniffed_xml_encoding = 'utf-16be' + xml_data = unicode(xml_data, 'utf-16be').encode('utf-8') + elif (len(xml_data) >= 4) and (xml_data[:2] == '\xfe\xff') and (xml_data[2:4] != '\x00\x00'): + # UTF-16BE with BOM + sniffed_xml_encoding = 'utf-16be' + xml_data = unicode(xml_data[2:], 'utf-16be').encode('utf-8') + elif xml_data[:4] == '\x3c\x00\x3f\x00': + # UTF-16LE + sniffed_xml_encoding = 'utf-16le' + xml_data = unicode(xml_data, 'utf-16le').encode('utf-8') + elif (len(xml_data) >= 4) and (xml_data[:2] == '\xff\xfe') and (xml_data[2:4] != '\x00\x00'): + # UTF-16LE with BOM + sniffed_xml_encoding = 'utf-16le' + xml_data = unicode(xml_data[2:], 'utf-16le').encode('utf-8') + elif xml_data[:4] == '\x00\x00\x00\x3c': + # UTF-32BE + sniffed_xml_encoding = 'utf-32be' + xml_data = unicode(xml_data, 'utf-32be').encode('utf-8') + elif xml_data[:4] == '\x3c\x00\x00\x00': + # UTF-32LE + sniffed_xml_encoding = 'utf-32le' + xml_data = unicode(xml_data, 'utf-32le').encode('utf-8') + elif xml_data[:4] == '\x00\x00\xfe\xff': + # UTF-32BE with BOM + sniffed_xml_encoding = 'utf-32be' + xml_data = unicode(xml_data[4:], 'utf-32be').encode('utf-8') + elif xml_data[:4] == '\xff\xfe\x00\x00': + # UTF-32LE with BOM + sniffed_xml_encoding = 'utf-32le' + xml_data = unicode(xml_data[4:], 'utf-32le').encode('utf-8') + elif xml_data[:3] == '\xef\xbb\xbf': + # UTF-8 with BOM + sniffed_xml_encoding = 'utf-8' + xml_data = unicode(xml_data[3:], 'utf-8').encode('utf-8') + else: + # ASCII-compatible + pass + xml_encoding_match = re.compile('^<\?.*encoding=[\'"](.*?)[\'"].*\?>').match(xml_data) + except: + xml_encoding_match = None + if xml_encoding_match: + xml_encoding = xml_encoding_match.groups()[0].lower() + if sniffed_xml_encoding and (xml_encoding in ('iso-10646-ucs-2', 'ucs-2', 'csunicode', 'iso-10646-ucs-4', 'ucs-4', 'csucs4', 'utf-16', 'utf-32', 'utf_16', 'utf_32', 'utf16', 'u16')): + xml_encoding = sniffed_xml_encoding + acceptable_content_type = 0 + application_content_types = ('application/xml', 'application/xml-dtd', 'application/xml-external-parsed-entity') + text_content_types = ('text/xml', 'text/xml-external-parsed-entity') + if (http_content_type in application_content_types) or \ + (http_content_type.startswith('application/') and http_content_type.endswith('+xml')): + acceptable_content_type = 1 + true_encoding = http_encoding or xml_encoding or 'utf-8' + elif (http_content_type in text_content_types) or \ + (http_content_type.startswith('text/')) and http_content_type.endswith('+xml'): + acceptable_content_type = 1 + true_encoding = http_encoding or 'us-ascii' + elif http_content_type.startswith('text/'): + true_encoding = http_encoding or 'us-ascii' + elif http_headers and (not http_headers.has_key('content-type')): + true_encoding = xml_encoding or 'iso-8859-1' + else: + true_encoding = xml_encoding or 'utf-8' + return true_encoding, http_encoding, xml_encoding, sniffed_xml_encoding, acceptable_content_type + +def _toUTF8(data, encoding): + '''Changes an XML data stream on the fly to specify a new encoding + + data is a raw sequence of bytes (not Unicode) that is presumed to be in %encoding already + encoding is a string recognized by encodings.aliases + ''' + if _debug: sys.stderr.write('entering _toUTF8, trying encoding %s\n' % encoding) + # strip Byte Order Mark (if present) + if (len(data) >= 4) and (data[:2] == '\xfe\xff') and (data[2:4] != '\x00\x00'): + if _debug: + sys.stderr.write('stripping BOM\n') + if encoding != 'utf-16be': + sys.stderr.write('trying utf-16be instead\n') + encoding = 'utf-16be' + data = data[2:] + elif (len(data) >= 4) and (data[:2] == '\xff\xfe') and (data[2:4] != '\x00\x00'): + if _debug: + sys.stderr.write('stripping BOM\n') + if encoding != 'utf-16le': + sys.stderr.write('trying utf-16le instead\n') + encoding = 'utf-16le' + data = data[2:] + elif data[:3] == '\xef\xbb\xbf': + if _debug: + sys.stderr.write('stripping BOM\n') + if encoding != 'utf-8': + sys.stderr.write('trying utf-8 instead\n') + encoding = 'utf-8' + data = data[3:] + elif data[:4] == '\x00\x00\xfe\xff': + if _debug: + sys.stderr.write('stripping BOM\n') + if encoding != 'utf-32be': + sys.stderr.write('trying utf-32be instead\n') + encoding = 'utf-32be' + data = data[4:] + elif data[:4] == '\xff\xfe\x00\x00': + if _debug: + sys.stderr.write('stripping BOM\n') + if encoding != 'utf-32le': + sys.stderr.write('trying utf-32le instead\n') + encoding = 'utf-32le' + data = data[4:] + newdata = unicode(data, encoding) + if _debug: sys.stderr.write('successfully converted %s data to unicode\n' % encoding) + declmatch = re.compile('^<\?xml[^>]*?>') + newdecl = '''''' + if declmatch.search(newdata): + newdata = declmatch.sub(newdecl, newdata) + else: + newdata = newdecl + u'\n' + newdata + return newdata.encode('utf-8') + +def _stripDoctype(data): + '''Strips DOCTYPE from XML document, returns (rss_version, stripped_data) + + rss_version may be 'rss091n' or None + stripped_data is the same XML document, minus the DOCTYPE + ''' + entity_pattern = re.compile(r']*?)>', re.MULTILINE) + data = entity_pattern.sub('', data) + doctype_pattern = re.compile(r']*?)>', re.MULTILINE) + doctype_results = doctype_pattern.findall(data) + doctype = doctype_results and doctype_results[0] or '' + if doctype.lower().count('netscape'): + version = 'rss091n' + else: + version = None + data = doctype_pattern.sub('', data) + return version, data + +def opensearch_parse(url_file_stream_or_string, etag=None, modified=None, agent=None, referrer=None, handlers=[]): + '''Parse a feed from a URL, file, stream, or string''' + result = FeedParserDict() + result['feed'] = FeedParserDict() + result['entries'] = [] + if _XML_AVAILABLE: + result['bozo'] = 0 + if type(handlers) == types.InstanceType: + handlers = [handlers] + try: + f = _open_resource(url_file_stream_or_string, etag, modified, agent, referrer, handlers) + data = f.read() + except Exception, e: + result['bozo'] = 1 + result['bozo_exception'] = e + data = '' + f = None + + # if feed is gzip-compressed, decompress it + if f and data and hasattr(f, 'headers'): + if gzip and f.headers.get('content-encoding', '') == 'gzip': + try: + data = gzip.GzipFile(fileobj=_StringIO(data)).read() + except Exception, e: + # Some feeds claim to be gzipped but they're not, so + # we get garbage. Ideally, we should re-request the + # feed without the 'Accept-encoding: gzip' header, + # but we don't. + result['bozo'] = 1 + result['bozo_exception'] = e + data = '' + elif zlib and f.headers.get('content-encoding', '') == 'deflate': + try: + data = zlib.decompress(data, -zlib.MAX_WBITS) + except Exception, e: + result['bozo'] = 1 + result['bozo_exception'] = e + data = '' + + # save HTTP headers + if hasattr(f, 'info'): + info = f.info() + result['etag'] = info.getheader('ETag') + last_modified = info.getheader('Last-Modified') + if last_modified: + result['modified'] = _parse_date(last_modified) + if hasattr(f, 'url'): + result['href'] = f.url + result['status'] = 200 + if hasattr(f, 'status'): + result['status'] = f.status + if hasattr(f, 'headers'): + result['headers'] = f.headers.dict + if hasattr(f, 'close'): + f.close() + + # there are four encodings to keep track of: + # - http_encoding is the encoding declared in the Content-Type HTTP header + # - xml_encoding is the encoding declared in the ; changed +# project name +#2.5 - 7/25/2003 - MAP - changed to Python license (all contributors agree); +# removed unnecessary urllib code -- urllib2 should always be available anyway; +# return actual url, status, and full HTTP headers (as result['url'], +# result['status'], and result['headers']) if parsing a remote feed over HTTP -- +# this should pass all the HTTP tests at ; +# added the latest namespace-of-the-week for RSS 2.0 +#2.5.1 - 7/26/2003 - RMK - clear opener.addheaders so we only send our custom +# User-Agent (otherwise urllib2 sends two, which confuses some servers) +#2.5.2 - 7/28/2003 - MAP - entity-decode inline xml properly; added support for +# inline and as used in some RSS 2.0 feeds +#2.5.3 - 8/6/2003 - TvdV - patch to track whether we're inside an image or +# textInput, and also to return the character encoding (if specified) +#2.6 - 1/1/2004 - MAP - dc:author support (MarekK); fixed bug tracking +# nested divs within content (JohnD); fixed missing sys import (JohanS); +# fixed regular expression to capture XML character encoding (Andrei); +# added support for Atom 0.3-style links; fixed bug with textInput tracking; +# added support for cloud (MartijnP); added support for multiple +# category/dc:subject (MartijnP); normalize content model: 'description' gets +# description (which can come from description, summary, or full content if no +# description), 'content' gets dict of base/language/type/value (which can come +# from content:encoded, xhtml:body, content, or fullitem); +# fixed bug matching arbitrary Userland namespaces; added xml:base and xml:lang +# tracking; fixed bug tracking unknown tags; fixed bug tracking content when +# element is not in default namespace (like Pocketsoap feed); +# resolve relative URLs in link, guid, docs, url, comments, wfw:comment, +# wfw:commentRSS; resolve relative URLs within embedded HTML markup in +# description, xhtml:body, content, content:encoded, title, subtitle, +# summary, info, tagline, and copyright; added support for pingback and +# trackback namespaces +#2.7 - 1/5/2004 - MAP - really added support for trackback and pingback +# namespaces, as opposed to 2.6 when I said I did but didn't really; +# sanitize HTML markup within some elements; added mxTidy support (if +# installed) to tidy HTML markup within some elements; fixed indentation +# bug in _parse_date (FazalM); use socket.setdefaulttimeout if available +# (FazalM); universal date parsing and normalization (FazalM): 'created', modified', +# 'issued' are parsed into 9-tuple date format and stored in 'created_parsed', +# 'modified_parsed', and 'issued_parsed'; 'date' is duplicated in 'modified' +# and vice-versa; 'date_parsed' is duplicated in 'modified_parsed' and vice-versa +#2.7.1 - 1/9/2004 - MAP - fixed bug handling " and '. fixed memory +# leak not closing url opener (JohnD); added dc:publisher support (MarekK); +# added admin:errorReportsTo support (MarekK); Python 2.1 dict support (MarekK) +#2.7.4 - 1/14/2004 - MAP - added workaround for improperly formed
tags in +# encoded HTML (skadz); fixed unicode handling in normalize_attrs (ChrisL); +# fixed relative URI processing for guid (skadz); added ICBM support; added +# base64 support +#2.7.5 - 1/15/2004 - MAP - added workaround for malformed DOCTYPE (seen on many +# blogspot.com sites); added _debug variable +#2.7.6 - 1/16/2004 - MAP - fixed bug with StringIO importing +#3.0b3 - 1/23/2004 - MAP - parse entire feed with real XML parser (if available); +# added several new supported namespaces; fixed bug tracking naked markup in +# description; added support for enclosure; added support for source; re-added +# support for cloud which got dropped somehow; added support for expirationDate +#3.0b4 - 1/26/2004 - MAP - fixed xml:lang inheritance; fixed multiple bugs tracking +# xml:base URI, one for documents that don't define one explicitly and one for +# documents that define an outer and an inner xml:base that goes out of scope +# before the end of the document +#3.0b5 - 1/26/2004 - MAP - fixed bug parsing multiple links at feed level +#3.0b6 - 1/27/2004 - MAP - added feed type and version detection, result['version'] +# will be one of SUPPORTED_VERSIONS.keys() or empty string if unrecognized; +# added support for creativeCommons:license and cc:license; added support for +# full Atom content model in title, tagline, info, copyright, summary; fixed bug +# with gzip encoding (not always telling server we support it when we do) +#3.0b7 - 1/28/2004 - MAP - support Atom-style author element in author_detail +# (dictionary of 'name', 'url', 'email'); map author to author_detail if author +# contains name + email address +#3.0b8 - 1/28/2004 - MAP - added support for contributor +#3.0b9 - 1/29/2004 - MAP - fixed check for presence of dict function; added +# support for summary +#3.0b10 - 1/31/2004 - MAP - incorporated ISO-8601 date parsing routines from +# xml.util.iso8601 +#3.0b11 - 2/2/2004 - MAP - added 'rights' to list of elements that can contain +# dangerous markup; fiddled with decodeEntities (not right); liberalized +# date parsing even further +#3.0b12 - 2/6/2004 - MAP - fiddled with decodeEntities (still not right); +# added support to Atom 0.2 subtitle; added support for Atom content model +# in copyright; better sanitizing of dangerous HTML elements with end tags +# (script, frameset) +#3.0b13 - 2/8/2004 - MAP - better handling of empty HTML tags (br, hr, img, +# etc.) in embedded markup, in either HTML or XHTML form (
,
,
) +#3.0b14 - 2/8/2004 - MAP - fixed CDATA handling in non-wellformed feeds under +# Python 2.1 +#3.0b15 - 2/11/2004 - MAP - fixed bug resolving relative links in wfw:commentRSS; +# fixed bug capturing author and contributor URL; fixed bug resolving relative +# links in author and contributor URL; fixed bug resolvin relative links in +# generator URL; added support for recognizing RSS 1.0; passed Simon Fell's +# namespace tests, and included them permanently in the test suite with his +# permission; fixed namespace handling under Python 2.1 +#3.0b16 - 2/12/2004 - MAP - fixed support for RSS 0.90 (broken in b15) +#3.0b17 - 2/13/2004 - MAP - determine character encoding as per RFC 3023 +#3.0b18 - 2/17/2004 - MAP - always map description to summary_detail (Andrei); +# use libxml2 (if available) +#3.0b19 - 3/15/2004 - MAP - fixed bug exploding author information when author +# name was in parentheses; removed ultra-problematic mxTidy support; patch to +# workaround crash in PyXML/expat when encountering invalid entities +# (MarkMoraes); support for textinput/textInput +#3.0b20 - 4/7/2004 - MAP - added CDF support +#3.0b21 - 4/14/2004 - MAP - added Hot RSS support +#3.0b22 - 4/19/2004 - MAP - changed 'channel' to 'feed', 'item' to 'entries' in +# results dict; changed results dict to allow getting values with results.key +# as well as results[key]; work around embedded illformed HTML with half +# a DOCTYPE; work around malformed Content-Type header; if character encoding +# is wrong, try several common ones before falling back to regexes (if this +# works, bozo_exception is set to CharacterEncodingOverride); fixed character +# encoding issues in BaseHTMLProcessor by tracking encoding and converting +# from Unicode to raw strings before feeding data to sgmllib.SGMLParser; +# convert each value in results to Unicode (if possible), even if using +# regex-based parsing +#3.0b23 - 4/21/2004 - MAP - fixed UnicodeDecodeError for feeds that contain +# high-bit characters in attributes in embedded HTML in description (thanks +# Thijs van de Vossen); moved guid, date, and date_parsed to mapped keys in +# FeedParserDict; tweaked FeedParserDict.has_key to return True if asking +# about a mapped key +#3.0fc1 - 4/23/2004 - MAP - made results.entries[0].links[0] and +# results.entries[0].enclosures[0] into FeedParserDict; fixed typo that could +# cause the same encoding to be tried twice (even if it failed the first time); +# fixed DOCTYPE stripping when DOCTYPE contained entity declarations; +# better textinput and image tracking in illformed RSS 1.0 feeds +#3.0fc2 - 5/10/2004 - MAP - added and passed Sam's amp tests; added and passed +# my blink tag tests +#3.0fc3 - 6/18/2004 - MAP - fixed bug in _changeEncodingDeclaration that +# failed to parse utf-16 encoded feeds; made source into a FeedParserDict; +# duplicate admin:generatorAgent/@rdf:resource in generator_detail.url; +# added support for image; refactored parse() fallback logic to try other +# encodings if SAX parsing fails (previously it would only try other encodings +# if re-encoding failed); remove unichr madness in normalize_attrs now that +# we're properly tracking encoding in and out of BaseHTMLProcessor; set +# feed.language from root-level xml:lang; set entry.id from rdf:about; +# send Accept header +#3.0 - 6/21/2004 - MAP - don't try iso-8859-1 (can't distinguish between +# iso-8859-1 and windows-1252 anyway, and most incorrectly marked feeds are +# windows-1252); fixed regression that could cause the same encoding to be +# tried twice (even if it failed the first time) +#3.0.1 - 6/22/2004 - MAP - default to us-ascii for all text/* content types; +# recover from malformed content-type header parameter with no equals sign +# ('text/xml; charset:iso-8859-1') +#3.1 - 6/28/2004 - MAP - added and passed tests for converting HTML entities +# to Unicode equivalents in illformed feeds (aaronsw); added and +# passed tests for converting character entities to Unicode equivalents +# in illformed feeds (aaronsw); test for valid parsers when setting +# XML_AVAILABLE; make version and encoding available when server returns +# a 304; add handlers parameter to pass arbitrary urllib2 handlers (like +# digest auth or proxy support); add code to parse username/password +# out of url and send as basic authentication; expose downloading-related +# exceptions in bozo_exception (aaronsw); added __contains__ method to +# FeedParserDict (aaronsw); added publisher_detail (aaronsw) +#3.2 - 7/3/2004 - MAP - use cjkcodecs and iconv_codec if available; always +# convert feed to UTF-8 before passing to XML parser; completely revamped +# logic for determining character encoding and attempting XML parsing +# (much faster); increased default timeout to 20 seconds; test for presence +# of Location header on redirects; added tests for many alternate character +# encodings; support various EBCDIC encodings; support UTF-16BE and +# UTF16-LE with or without a BOM; support UTF-8 with a BOM; support +# UTF-32BE and UTF-32LE with or without a BOM; fixed crashing bug if no +# XML parsers are available; added support for 'Content-encoding: deflate'; +# send blank 'Accept-encoding: ' header if neither gzip nor zlib modules +# are available +#3.3 - 7/15/2004 - MAP - optimize EBCDIC to ASCII conversion; fix obscure +# problem tracking xml:base and xml:lang if element declares it, child +# doesn't, first grandchild redeclares it, and second grandchild doesn't; +# refactored date parsing; defined public registerDateHandler so callers +# can add support for additional date formats at runtime; added support +# for OnBlog, Nate, MSSQL, Greek, and Hungarian dates (ytrewq1); added +# zopeCompatibilityHack() which turns FeedParserDict into a regular +# dictionary, required for Zope compatibility, and also makes command- +# line debugging easier because pprint module formats real dictionaries +# better than dictionary-like objects; added NonXMLContentType exception, +# which is stored in bozo_exception when a feed is served with a non-XML +# media type such as 'text/plain'; respect Content-Language as default +# language if not xml:lang is present; cloud dict is now FeedParserDict; +# generator dict is now FeedParserDict; better tracking of xml:lang, +# including support for xml:lang='' to unset the current language; +# recognize RSS 1.0 feeds even when RSS 1.0 namespace is not the default +# namespace; don't overwrite final status on redirects (scenarios: +# redirecting to a URL that returns 304, redirecting to a URL that +# redirects to another URL with a different type of redirect); add +# support for HTTP 303 redirects +#4.0 - MAP - support for relative URIs in xml:base attribute; fixed +# encoding issue with mxTidy (phopkins); preliminary support for RFC 3229; +# support for Atom 1.0; support for iTunes extensions; new 'tags' for +# categories/keywords/etc. as array of dict +# {'term': term, 'scheme': scheme, 'label': label} to match Atom 1.0 +# terminology; parse RFC 822-style dates with no time; lots of other +# bug fixes diff --git a/src/calibre/utils/opensearch/query.py b/src/calibre/utils/opensearch/query.py new file mode 100644 index 0000000000..31c37ca923 --- /dev/null +++ b/src/calibre/utils/opensearch/query.py @@ -0,0 +1,66 @@ +from urlparse import urlparse, urlunparse +from urllib import urlencode +from cgi import parse_qs + +class Query: + """Represents an opensearch query. Used internally by the Client to + construct an opensearch url to request. Really this class is just a + helper for substituting values into the macros in a format. + + format = 'http://beta.indeed.com/opensearch?q={searchTerms}&start={startIndex}&limit={count}' + q = Query(format) + q.searchTerms('zx81') + q.startIndex = 1 + q.count = 25 + print q.to_url() + """ + + standard_macros = ['searchTerms','count','startIndex','startPage', + 'language', 'outputEncoding', 'inputEncoding'] + + def __init__(self, format): + """Create a query object by passing it the url format obtained + from the opensearch Description. + """ + self.format = format + + # unpack the url to a tuple + self.url_parts = urlparse(format) + + # unpack the query string to a dictionary + self.query_string = parse_qs(self.url_parts[4]) + + # look for standard macros and create a mapping of the + # opensearch names to the service specific ones + # so q={searchTerms} will result in a mapping between searchTerms and q + self.macro_map = {} + for key,values in self.query_string.items(): + # TODO eventually optional/required params should be + # distinguished somehow (the ones with/without trailing ? + macro = values[0].replace('{','').replace('}','').replace('?','') + if macro in Query.standard_macros: + self.macro_map[macro] = key + + def url(self): + # copy the original query string + query_string = dict(self.query_string) + + # iterate through macros and set the position in the querystring + for macro, name in self.macro_map.items(): + if hasattr(self, macro): + # set the name/value pair + query_string[name] = [getattr(self, macro)] + else: + # remove the name/value pair + del(query_string[name]) + + # copy the url parts and substitute in our new query string + url_parts = list(self.url_parts) + url_parts[4] = urlencode(query_string, 1) + + # recompose and return url + return urlunparse(tuple(url_parts)) + + def has_macro(self, macro): + return self.macro_map.has_key(macro) + diff --git a/src/calibre/utils/opensearch/results.py b/src/calibre/utils/opensearch/results.py new file mode 100644 index 0000000000..1922848e22 --- /dev/null +++ b/src/calibre/utils/opensearch/results.py @@ -0,0 +1,131 @@ +import osfeedparser + +class Results(object): + + def __init__(self, query, agent=None): + self.agent = agent + self._fetch(query) + self._iter = 0 + + def __iter__(self): + self._iter = 0 + return self + + def __len__(self): + return self.totalResults + + def next(self): + + # just keep going like the energizer bunny + while True: + + # return any item we haven't returned + if self._iter < len(self.items): + self._iter += 1 + return self.items[self._iter-1] + + # if there appears to be more to fetch + if \ + self.totalResults != 0 \ + and self.totalResults > self.startIndex + self.itemsPerPage - 1: + + # get the next query + next_query = self._get_next_query() + + # if we got one executed it and go back to the beginning + if next_query: + self._fetch(next_query) + # very important to reset this counter + # or else the return will fail + self._iter = 0 + + else: + raise StopIteration + + + def _fetch(self, query): + feed = osfeedparser.opensearch_parse(query.url(), agent=self.agent) + self.feed = feed + + # general channel stuff + channel = feed['feed'] + self.title = _pick(channel,'title') + self.link = _pick(channel,'link') + self.description = _pick(channel,'description') + self.language = _pick(channel,'language') + self.copyright = _pick(channel,'copyright') + + # get back opensearch specific values + self.totalResults = _pick(channel,'opensearch_totalresults',0) + self.startIndex = _pick(channel,'opensearch_startindex',1) + self.itemsPerPage = _pick(channel,'opensearch_itemsperpage',0) + + # alias items from the feed to our results object + self.items = feed['items'] + + # set default values if necessary + if self.startIndex == 0: + self.startIndex = 1 + if self.itemsPerPage == 0 and len(self.items) > 0: + self.itemsPerPage = len(self.items) + + # store away query for calculating next results + # if necessary + self.last_query = query + + + def _get_next_query(self): + # update our query to get the next set of records + query = self.last_query + + # use start page if the query supports it + if query.has_macro('startPage'): + # if the query already defined the startPage + # we just need to increment it + if hasattr(query, 'startPage'): + query.startPage += 1 + # to issue the first query startPage might not have + # been specified, so set it to 2 + else: + query.startPage = 2 + return query + + # otherwise the query should support startIndex + elif query.has_macro('startIndex'): + # if startIndex was used before we just add the + # items per page to it to get the next set + if hasattr(query, 'startIndex'): + query.startIndex += self.itemsPerPage + # to issue the first query the startIndex may have + # been left blank in that case we assume it to be + # the item just after the last one on this page + else: + query.startIndex = self.itemsPerPage + 1 + return query + + # doesn't look like there is another stage to this query + return None + + +# helper for pulling values out of a dictionary if they're there +# and returning a default value if they're not +def _pick(d,key,default=None): + + # get the value out + value = d.get(key) + + # if it wasn't there return the default + if value == None: + return default + + # if they want an int try to convert to an int + # and return default if it fails + if type(default) == int: + try: + return int(d[key]) + except: + return default + + # otherwise we're good to return the value + return value + diff --git a/src/calibre/utils/opensearch/url.py b/src/calibre/utils/opensearch/url.py new file mode 100644 index 0000000000..665c024ef3 --- /dev/null +++ b/src/calibre/utils/opensearch/url.py @@ -0,0 +1,8 @@ +class URL: + """Class for representing a URL in an opensearch v1.1 query""" + + def __init__(self, type='', template='', method='GET'): + self.type = type + self.template = template + self.method = 'GET' + self.params = [] From 5570a17ee0544b2b4284eba3ed0b37cefe801f9b Mon Sep 17 00:00:00 2001 From: John Schember Date: Sun, 26 Jun 2011 10:33:22 -0400 Subject: [PATCH 17/24] Store: OpenSearchStore fix opening store directly. --- src/calibre/gui2/store/opensearch_store.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/calibre/gui2/store/opensearch_store.py b/src/calibre/gui2/store/opensearch_store.py index f473608309..773bc6d4a7 100644 --- a/src/calibre/gui2/store/opensearch_store.py +++ b/src/calibre/gui2/store/opensearch_store.py @@ -23,10 +23,13 @@ class OpenSearchStore(StorePlugin): web_url = '' def open(self, parent=None, detail_item=None, external=False): + if not hasattr(self, 'web_url'): + return + if external or self.config.get('open_external', False): - open_url(QUrl(detail_item if detail_item else self.url)) + open_url(QUrl(detail_item if detail_item else self.web_url)) else: - d = WebStoreDialog(self.gui, self.url, parent, detail_item) + d = WebStoreDialog(self.gui, self.web_url, parent, detail_item) d.setWindowTitle(self.name) d.set_tags(self.config.get('tags', '')) d.exec_() From 85a4cca82249dc24fc633791b7de94ed1f8e23dc Mon Sep 17 00:00:00 2001 From: John Schember Date: Sun, 26 Jun 2011 10:41:43 -0400 Subject: [PATCH 18/24] Store: Convert EpubBud to use new OpenSearchStore class. --- src/calibre/gui2/store/epubbud_plugin.py | 75 ++++------------------ src/calibre/gui2/store/opensearch_store.py | 2 +- 2 files changed, 12 insertions(+), 65 deletions(-) diff --git a/src/calibre/gui2/store/epubbud_plugin.py b/src/calibre/gui2/store/epubbud_plugin.py index d6193f6ae0..7c581b9578 100644 --- a/src/calibre/gui2/store/epubbud_plugin.py +++ b/src/calibre/gui2/store/epubbud_plugin.py @@ -6,73 +6,20 @@ __license__ = 'GPL 3' __copyright__ = '2011, John Schember ' __docformat__ = 'restructuredtext en' -import urllib -from contextlib import closing - -from lxml import html - -from PyQt4.Qt import QUrl - -from calibre import browser, url_slash_cleaner -from calibre.gui2 import open_url -from calibre.gui2.store import StorePlugin from calibre.gui2.store.basic_config import BasicStoreConfig +from calibre.gui2.store.opensearch_store import OpenSearchStore from calibre.gui2.store.search_result import SearchResult -from calibre.gui2.store.web_store_dialog import WebStoreDialog -class EpubBudStore(BasicStoreConfig, StorePlugin): +class EpubBudStore(BasicStoreConfig, OpenSearchStore): - def open(self, parent=None, detail_item=None, external=False): - url = 'http://epubbud.com/' - - if external or self.config.get('open_external', False): - open_url(QUrl(url_slash_cleaner(detail_item if detail_item else url))) - else: - d = WebStoreDialog(self.gui, url, parent, detail_item) - d.setWindowTitle(self.name) - d.set_tags(self.config.get('tags', '')) - d.exec_() + open_search_url = 'http://www.epubbud.com/feeds/opensearch.xml' + web_url = 'http://www.epubbud.com/' + + # http://www.epubbud.com/feeds/catalog.atom def search(self, query, max_results=10, timeout=60): - ''' - OPDS based search. - - We really should get the catelog from http://pragprog.com/catalog.opds - and look for the application/opensearchdescription+xml entry. - Then get the opensearch description to get the search url and - format. However, we are going to be lazy and hard code it. - ''' - url = 'http://www.epubbud.com/search.php?format=atom&q=' + urllib.quote_plus(query) - - br = browser() - - counter = max_results - with closing(br.open(url, timeout=timeout)) as f: - # Use html instead of etree as html allows us - # to ignore the namespace easily. - doc = html.fromstring(f.read()) - for data in doc.xpath('//entry'): - if counter <= 0: - break - - id = ''.join(data.xpath('.//id/text()')) - if not id: - continue - - cover_url = ''.join(data.xpath('.//link[@rel="http://opds-spec.org/thumbnail"]/@href')) - - title = u''.join(data.xpath('.//title/text()')) - author = u''.join(data.xpath('.//author/name/text()')) - - counter -= 1 - - s = SearchResult() - s.cover_url = cover_url - s.title = title.strip() - s.author = author.strip() - s.price = '$0.00' - s.detail_item = id.strip() - s.drm = SearchResult.DRM_UNLOCKED - s.formats = 'EPUB' - - yield s + for s in OpenSearchStore.search(self, query, max_results, timeout): + s.price = '$0.00' + s.drm = SearchResult.DRM_UNLOCKED + s.formats = 'EPUB' + yield s diff --git a/src/calibre/gui2/store/opensearch_store.py b/src/calibre/gui2/store/opensearch_store.py index 773bc6d4a7..a3dc0e7941 100644 --- a/src/calibre/gui2/store/opensearch_store.py +++ b/src/calibre/gui2/store/opensearch_store.py @@ -54,7 +54,7 @@ class OpenSearchStore(StorePlugin): links = r.get('links', None) for l in links: if l.get('rel', None): - if l['rel'] == u'http://opds-spec.org/image/thumbnail': + if l['rel'] in ('http://opds-spec.org/thumbnail', 'http://opds-spec.org/image/thumbnail'): s.cover_url = l.get('href', '') elif l['rel'] == u'http://opds-spec.org/acquisition/buy': s.detail_item = l.get('href', s.detail_item) From 08e263e29717da2df0e4c23c66eea1682e5b4340 Mon Sep 17 00:00:00 2001 From: John Schember Date: Sun, 26 Jun 2011 10:58:49 -0400 Subject: [PATCH 19/24] OpenSearch: Fix a few bugs. Store: Use Feedbooks OpenSearch. --- src/calibre/gui2/store/feedbooks_plugin.py | 104 +++---------------- src/calibre/utils/opensearch/description.py | 2 +- src/calibre/utils/opensearch/osfeedparser.py | 4 +- 3 files changed, 16 insertions(+), 94 deletions(-) diff --git a/src/calibre/gui2/store/feedbooks_plugin.py b/src/calibre/gui2/store/feedbooks_plugin.py index 9b1f7f6574..96d0a10dc7 100644 --- a/src/calibre/gui2/store/feedbooks_plugin.py +++ b/src/calibre/gui2/store/feedbooks_plugin.py @@ -6,101 +6,23 @@ __license__ = 'GPL 3' __copyright__ = '2011, John Schember ' __docformat__ = 'restructuredtext en' -import urllib2 -from contextlib import closing - -from lxml import html - -from PyQt4.Qt import QUrl - -from calibre import browser, url_slash_cleaner -from calibre.gui2 import open_url -from calibre.gui2.store import StorePlugin from calibre.gui2.store.basic_config import BasicStoreConfig +from calibre.gui2.store.opensearch_store import OpenSearchStore from calibre.gui2.store.search_result import SearchResult -from calibre.gui2.store.web_store_dialog import WebStoreDialog -class FeedbooksStore(BasicStoreConfig, StorePlugin): +class FeedbooksStore(BasicStoreConfig, OpenSearchStore): - def open(self, parent=None, detail_item=None, external=False): - url = 'http://m.feedbooks.com/' - ext_url = 'http://feedbooks.com/' - - if external or self.config.get('open_external', False): - if detail_item: - ext_url = ext_url + detail_item - open_url(QUrl(url_slash_cleaner(ext_url))) - else: - detail_url = None - if detail_item: - detail_url = url + detail_item - d = WebStoreDialog(self.gui, url, parent, detail_url) - d.setWindowTitle(self.name) - d.set_tags(self.config.get('tags', '')) - d.exec_() + open_search_url = 'http://assets0.feedbooks.net/opensearch.xml?t=1253087147' + web_url = 'http://feedbooks.com/' + + # http://www.feedbooks.com/catalog def search(self, query, max_results=10, timeout=60): - url = 'http://m.feedbooks.com/search?query=' + urllib2.quote(query) - - br = browser() - - counter = max_results - with closing(br.open(url, timeout=timeout)) as f: - doc = html.fromstring(f.read()) - for data in doc.xpath('//ul[@class="m-list"]//li'): - if counter <= 0: - break - data = html.fromstring(html.tostring(data)) - - id = '' - id_a = data.xpath('//a[@class="buy"]') - if id_a: - id = id_a[0].get('href', None) - id = id.split('/')[-2] - id = '/item/' + id - else: - id_a = data.xpath('//a[@class="download"]') - if id_a: - id = id_a[0].get('href', None) - id = id.split('/')[-1] - id = id.split('.')[0] - id = '/book/' + id - if not id: - continue - - title = ''.join(data.xpath('//h5//a/text()')) - author = ''.join(data.xpath('//h6//a/text()')) - price = ''.join(data.xpath('//a[@class="buy"]/text()')) - formats = 'EPUB' - if not price: - price = '$0.00' - formats = 'EPUB, MOBI, PDF' - cover_url = '' - cover_url_img = data.xpath('//img') - if cover_url_img: - cover_url = cover_url_img[0].get('src') - cover_url.split('?')[0] - - counter -= 1 - - s = SearchResult() - s.cover_url = cover_url - s.title = title.strip() - s.author = author.strip() - s.price = price.replace(' ', '').strip() - s.detail_item = id.strip() - s.formats = formats - - yield s - - def get_details(self, search_result, timeout): - url = 'http://m.feedbooks.com/' - - br = browser() - with closing(br.open(url_slash_cleaner(url + search_result.detail_item), timeout=timeout)) as nf: - idata = html.fromstring(nf.read()) - if idata.xpath('boolean(//div[contains(@class, "m-description-long")]//p[contains(., "DRM") or contains(b, "Protection")])'): - search_result.drm = SearchResult.DRM_LOCKED + for s in OpenSearchStore.search(self, query, max_results, timeout): + if s.downloads: + s.drm = SearchResult.DRM_UNLOCKED + s.price = '$0.00' else: - search_result.drm = SearchResult.DRM_UNLOCKED - return True + s.drm = SearchResult.DRM_LOCKED + s.formats = 'EPUB' + yield s diff --git a/src/calibre/utils/opensearch/description.py b/src/calibre/utils/opensearch/description.py index d486e615df..2909dbceb3 100644 --- a/src/calibre/utils/opensearch/description.py +++ b/src/calibre/utils/opensearch/description.py @@ -87,7 +87,7 @@ class Description: return self.urls[0].template # out of luck - return Nil + return None # these are internal methods for querying xml diff --git a/src/calibre/utils/opensearch/osfeedparser.py b/src/calibre/utils/opensearch/osfeedparser.py index 364de2b26c..ed894cb572 100644 --- a/src/calibre/utils/opensearch/osfeedparser.py +++ b/src/calibre/utils/opensearch/osfeedparser.py @@ -46,8 +46,8 @@ _debug = 0 # If you are embedding feedparser in a larger application, you should # change this to your application name and URL. # Changed by John Schember -from calibre import random_user_agent -USER_AGENT = random_user_agent() +from calibre import USER_AGENT +USER_AGENT = USER_AGENT # HTTP "Accept" header to send to servers when downloading feeds. If you don't # want to send an Accept header, set this to None. From 12e9b6194e7585039abf1167da9c7d634d9eeca2 Mon Sep 17 00:00:00 2001 From: John Schember Date: Sun, 26 Jun 2011 11:15:19 -0400 Subject: [PATCH 20/24] Store: Organize store plugins into their own module. --- src/calibre/customize/builtins.py | 74 +++++++++---------- src/calibre/gui2/store/stores/__init__.py | 3 + .../store/{ => stores}/amazon_de_plugin.py | 0 .../gui2/store/{ => stores}/amazon_plugin.py | 0 .../store/{ => stores}/amazon_uk_plugin.py | 0 .../store/{ => stores}/archive_org_plugin.py | 0 .../{ => stores}/baen_webscription_plugin.py | 0 .../{ => stores}/beam_ebooks_de_plugin.py | 0 .../gui2/store/{ => stores}/bewrite_plugin.py | 0 .../gui2/store/{ => stores}/bn_plugin.py | 0 .../{ => stores}/diesel_ebooks_plugin.py | 0 .../store/{ => stores}/ebooks_com_plugin.py | 0 .../{ => stores}/ebookshoppe_uk_plugin.py | 0 .../store/{ => stores}/eharlequin_plugin.py | 0 .../gui2/store/{ => stores}/epubbud_plugin.py | 0 .../store/{ => stores}/epubbuy_de_plugin.py | 0 .../store/{ => stores}/feedbooks_plugin.py | 0 .../store/{ => stores}/foyles_uk_plugin.py | 0 .../gui2/store/{ => stores}/gandalf_plugin.py | 0 .../store/{ => stores}/google_books_plugin.py | 0 .../store/{ => stores}/gutenberg_plugin.py | 0 .../gui2/store/{ => stores}/kobo_plugin.py | 0 .../gui2/store/{ => stores}/legimi_plugin.py | 0 .../store/{ => stores}/libri_de_plugin.py | 0 .../store/{ => stores}/manybooks_plugin.py | 0 .../store/{ => stores}/mobileread/__init__.py | 0 .../mobileread/adv_search_builder.py | 2 +- .../mobileread/adv_search_builder.ui | 0 .../mobileread/cache_progress_dialog.py | 2 +- .../mobileread/cache_progress_dialog.ui | 0 .../mobileread/cache_update_thread.py | 0 .../mobileread/mobileread_plugin.py | 8 +- .../store/{ => stores}/mobileread/models.py | 0 .../{ => stores}/mobileread/store_dialog.py | 6 +- .../{ => stores}/mobileread/store_dialog.ui | 0 .../gui2/store/{ => stores}/nexto_plugin.py | 0 .../store/{ => stores}/open_books_plugin.py | 0 .../store/{ => stores}/open_library_plugin.py | 0 .../gui2/store/{ => stores}/oreilly_plugin.py | 0 .../pragmatic_bookshelf_plugin.py | 0 .../store/{ => stores}/smashwords_plugin.py | 0 .../store/{ => stores}/virtualo_plugin.py | 0 .../{ => stores}/waterstones_uk_plugin.py | 0 .../{ => stores}/weightless_books_plugin.py | 0 .../store/{ => stores}/whsmith_uk_plugin.py | 0 .../wizards_tower_books_plugin.py | 0 .../gui2/store/{ => stores}/woblink_plugin.py | 0 .../gui2/store/{ => stores}/zixo_plugin.py | 0 48 files changed, 49 insertions(+), 46 deletions(-) create mode 100644 src/calibre/gui2/store/stores/__init__.py rename src/calibre/gui2/store/{ => stores}/amazon_de_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/amazon_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/amazon_uk_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/archive_org_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/baen_webscription_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/beam_ebooks_de_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/bewrite_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/bn_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/diesel_ebooks_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/ebooks_com_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/ebookshoppe_uk_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/eharlequin_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/epubbud_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/epubbuy_de_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/feedbooks_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/foyles_uk_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/gandalf_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/google_books_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/gutenberg_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/kobo_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/legimi_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/libri_de_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/manybooks_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/mobileread/__init__.py (100%) rename src/calibre/gui2/store/{ => stores}/mobileread/adv_search_builder.py (97%) rename src/calibre/gui2/store/{ => stores}/mobileread/adv_search_builder.ui (100%) rename src/calibre/gui2/store/{ => stores}/mobileread/cache_progress_dialog.py (94%) rename src/calibre/gui2/store/{ => stores}/mobileread/cache_progress_dialog.ui (100%) rename src/calibre/gui2/store/{ => stores}/mobileread/cache_update_thread.py (100%) rename src/calibre/gui2/store/{ => stores}/mobileread/mobileread_plugin.py (91%) rename src/calibre/gui2/store/{ => stores}/mobileread/models.py (100%) rename src/calibre/gui2/store/{ => stores}/mobileread/store_dialog.py (93%) rename src/calibre/gui2/store/{ => stores}/mobileread/store_dialog.ui (100%) rename src/calibre/gui2/store/{ => stores}/nexto_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/open_books_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/open_library_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/oreilly_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/pragmatic_bookshelf_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/smashwords_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/virtualo_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/waterstones_uk_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/weightless_books_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/whsmith_uk_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/wizards_tower_books_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/woblink_plugin.py (100%) rename src/calibre/gui2/store/{ => stores}/zixo_plugin.py (100%) diff --git a/src/calibre/customize/builtins.py b/src/calibre/customize/builtins.py index 8305e32303..333a5baaa4 100644 --- a/src/calibre/customize/builtins.py +++ b/src/calibre/customize/builtins.py @@ -1148,7 +1148,7 @@ plugins += [LookAndFeel, Behavior, Columns, Toolbar, Search, InputOptions, class StoreAmazonKindleStore(StoreBase): name = 'Amazon Kindle' description = u'Kindle books from Amazon.' - actual_plugin = 'calibre.gui2.store.amazon_plugin:AmazonKindleStore' + actual_plugin = 'calibre.gui2.store.stores.amazon_plugin:AmazonKindleStore' headquarters = 'US' formats = ['KINDLE'] @@ -1158,7 +1158,7 @@ class StoreAmazonDEKindleStore(StoreBase): name = 'Amazon DE Kindle' author = 'Charles Haley' description = u'Kindle Bücher von Amazon.' - actual_plugin = 'calibre.gui2.store.amazon_de_plugin:AmazonDEKindleStore' + actual_plugin = 'calibre.gui2.store.stores.amazon_de_plugin:AmazonDEKindleStore' headquarters = 'DE' formats = ['KINDLE'] @@ -1168,7 +1168,7 @@ class StoreAmazonUKKindleStore(StoreBase): name = 'Amazon UK Kindle' author = 'Charles Haley' description = u'Kindle books from Amazon\'s UK web site. Also, includes French language ebooks.' - actual_plugin = 'calibre.gui2.store.amazon_uk_plugin:AmazonUKKindleStore' + actual_plugin = 'calibre.gui2.store.stores.amazon_uk_plugin:AmazonUKKindleStore' headquarters = 'UK' formats = ['KINDLE'] @@ -1177,7 +1177,7 @@ class StoreAmazonUKKindleStore(StoreBase): class StoreArchiveOrgStore(StoreBase): name = 'Archive.org' description = u'An Internet library offering permanent access for researchers, historians, scholars, people with disabilities, and the general public to historical collections that exist in digital format.' - actual_plugin = 'calibre.gui2.store.archive_org_plugin:ArchiveOrgStore' + actual_plugin = 'calibre.gui2.store.stores.archive_org_plugin:ArchiveOrgStore' drm_free_only = True headquarters = 'US' @@ -1186,7 +1186,7 @@ class StoreArchiveOrgStore(StoreBase): class StoreBaenWebScriptionStore(StoreBase): name = 'Baen WebScription' description = u'Sci-Fi & Fantasy brought to you by Jim Baen.' - actual_plugin = 'calibre.gui2.store.baen_webscription_plugin:BaenWebScriptionStore' + actual_plugin = 'calibre.gui2.store.stores.baen_webscription_plugin:BaenWebScriptionStore' drm_free_only = True headquarters = 'US' @@ -1195,7 +1195,7 @@ class StoreBaenWebScriptionStore(StoreBase): class StoreBNStore(StoreBase): name = 'Barnes and Noble' description = u'The world\'s largest book seller. As the ultimate destination for book lovers, Barnes & Noble.com offers an incredible array of content.' - actual_plugin = 'calibre.gui2.store.bn_plugin:BNStore' + actual_plugin = 'calibre.gui2.store.stores.bn_plugin:BNStore' headquarters = 'US' formats = ['NOOK'] @@ -1205,7 +1205,7 @@ class StoreBeamEBooksDEStore(StoreBase): name = 'Beam EBooks DE' author = 'Charles Haley' description = u'Bei uns finden Sie: Tausende deutschsprachige eBooks; Alle eBooks ohne hartes DRM; PDF, ePub und Mobipocket Format; Sofortige Verfügbarkeit - 24 Stunden am Tag; Günstige Preise; eBooks für viele Lesegeräte, PC,Mac und Smartphones; Viele Gratis eBooks' - actual_plugin = 'calibre.gui2.store.beam_ebooks_de_plugin:BeamEBooksDEStore' + actual_plugin = 'calibre.gui2.store.stores.beam_ebooks_de_plugin:BeamEBooksDEStore' drm_free_only = True headquarters = 'DE' @@ -1215,7 +1215,7 @@ class StoreBeamEBooksDEStore(StoreBase): class StoreBeWriteStore(StoreBase): name = 'BeWrite Books' description = u'Publishers of fine books. Highly selective and editorially driven. Does not offer: books for children or exclusively YA, erotica, swords-and-sorcery fantasy and space-opera-style science fiction. All other genres are represented.' - actual_plugin = 'calibre.gui2.store.bewrite_plugin:BeWriteStore' + actual_plugin = 'calibre.gui2.store.stores.bewrite_plugin:BeWriteStore' drm_free_only = True headquarters = 'US' @@ -1224,7 +1224,7 @@ class StoreBeWriteStore(StoreBase): class StoreDieselEbooksStore(StoreBase): name = 'Diesel eBooks' description = u'Instant access to over 2.4 million titles from hundreds of publishers including Harlequin, HarperCollins, John Wiley & Sons, McGraw-Hill, Simon & Schuster and Random House.' - actual_plugin = 'calibre.gui2.store.diesel_ebooks_plugin:DieselEbooksStore' + actual_plugin = 'calibre.gui2.store.stores.diesel_ebooks_plugin:DieselEbooksStore' headquarters = 'US' formats = ['EPUB', 'PDF'] @@ -1233,7 +1233,7 @@ class StoreDieselEbooksStore(StoreBase): class StoreEbookscomStore(StoreBase): name = 'eBooks.com' description = u'Sells books in multiple electronic formats in all categories. Technical infrastructure is cutting edge, robust and scalable, with servers in the US and Europe.' - actual_plugin = 'calibre.gui2.store.ebooks_com_plugin:EbookscomStore' + actual_plugin = 'calibre.gui2.store.stores.ebooks_com_plugin:EbookscomStore' headquarters = 'US' formats = ['EPUB', 'LIT', 'MOBI', 'PDF'] @@ -1243,7 +1243,7 @@ class StoreEPubBuyDEStore(StoreBase): name = 'EPUBBuy DE' author = 'Charles Haley' description = u'Bei EPUBBuy.com finden Sie ausschliesslich eBooks im weitverbreiteten EPUB-Format und ohne DRM. So haben Sie die freie Wahl, wo Sie Ihr eBook lesen: Tablet, eBook-Reader, Smartphone oder einfach auf Ihrem PC. So macht eBook-Lesen Spaß!' - actual_plugin = 'calibre.gui2.store.epubbuy_de_plugin:EPubBuyDEStore' + actual_plugin = 'calibre.gui2.store.stores.epubbuy_de_plugin:EPubBuyDEStore' drm_free_only = True headquarters = 'DE' @@ -1254,7 +1254,7 @@ class StoreEBookShoppeUKStore(StoreBase): name = 'ebookShoppe UK' author = u'Charles Haley' description = u'We made this website in an attempt to offer the widest range of UK eBooks possible across and as many formats as we could manage.' - actual_plugin = 'calibre.gui2.store.ebookshoppe_uk_plugin:EBookShoppeUKStore' + actual_plugin = 'calibre.gui2.store.stores.ebookshoppe_uk_plugin:EBookShoppeUKStore' headquarters = 'UK' formats = ['EPUB', 'PDF'] @@ -1263,7 +1263,7 @@ class StoreEBookShoppeUKStore(StoreBase): class StoreEHarlequinStore(StoreBase): name = 'eHarlequin' description = u'A global leader in series romance and one of the world\'s leading publishers of books for women. Offers women a broad range of reading from romance to bestseller fiction, from young adult novels to erotic literature, from nonfiction to fantasy, from African-American novels to inspirational romance, and more.' - actual_plugin = 'calibre.gui2.store.eharlequin_plugin:EHarlequinStore' + actual_plugin = 'calibre.gui2.store.stores.eharlequin_plugin:EHarlequinStore' headquarters = 'CA' formats = ['EPUB', 'PDF'] @@ -1272,7 +1272,7 @@ class StoreEHarlequinStore(StoreBase): class StoreEpubBudStore(StoreBase): name = 'ePub Bud' description = 'Well, it\'s pretty much just "YouTube for Children\'s eBooks. A not-for-profit organization devoted to brining self published childrens books to the world.' - actual_plugin = 'calibre.gui2.store.epubbud_plugin:EpubBudStore' + actual_plugin = 'calibre.gui2.store.stores.epubbud_plugin:EpubBudStore' drm_free_only = True headquarters = 'US' @@ -1281,7 +1281,7 @@ class StoreEpubBudStore(StoreBase): class StoreFeedbooksStore(StoreBase): name = 'Feedbooks' description = u'Feedbooks is a cloud publishing and distribution service, connected to a large ecosystem of reading systems and social networks. Provides a variety of genres from independent and classic books.' - actual_plugin = 'calibre.gui2.store.feedbooks_plugin:FeedbooksStore' + actual_plugin = 'calibre.gui2.store.stores.feedbooks_plugin:FeedbooksStore' headquarters = 'FR' formats = ['EPUB', 'MOBI', 'PDF'] @@ -1290,7 +1290,7 @@ class StoreFoylesUKStore(StoreBase): name = 'Foyles UK' author = 'Charles Haley' description = u'Foyles of London\'s ebook store. Provides extensive range covering all subjects.' - actual_plugin = 'calibre.gui2.store.foyles_uk_plugin:FoylesUKStore' + actual_plugin = 'calibre.gui2.store.stores.foyles_uk_plugin:FoylesUKStore' headquarters = 'UK' formats = ['EPUB', 'PDF'] @@ -1300,7 +1300,7 @@ class StoreGandalfStore(StoreBase): name = 'Gandalf' author = u'Tomasz Długosz' description = u'Księgarnia internetowa Gandalf.' - actual_plugin = 'calibre.gui2.store.gandalf_plugin:GandalfStore' + actual_plugin = 'calibre.gui2.store.stores.gandalf_plugin:GandalfStore' headquarters = 'PL' formats = ['EPUB', 'PDF'] @@ -1308,7 +1308,7 @@ class StoreGandalfStore(StoreBase): class StoreGoogleBooksStore(StoreBase): name = 'Google Books' description = u'Google Books' - actual_plugin = 'calibre.gui2.store.google_books_plugin:GoogleBooksStore' + actual_plugin = 'calibre.gui2.store.stores.google_books_plugin:GoogleBooksStore' headquarters = 'US' formats = ['EPUB', 'PDF', 'TXT'] @@ -1316,7 +1316,7 @@ class StoreGoogleBooksStore(StoreBase): class StoreGutenbergStore(StoreBase): name = 'Project Gutenberg' description = u'The first producer of free ebooks. Free in the United States because their copyright has expired. They may not be free of copyright in other countries. Readers outside of the United States must check the copyright laws of their countries before downloading or redistributing our ebooks.' - actual_plugin = 'calibre.gui2.store.gutenberg_plugin:GutenbergStore' + actual_plugin = 'calibre.gui2.store.stores.gutenberg_plugin:GutenbergStore' drm_free_only = True headquarters = 'US' @@ -1325,7 +1325,7 @@ class StoreGutenbergStore(StoreBase): class StoreKoboStore(StoreBase): name = 'Kobo' description = u'With over 2.3 million eBooks to browse we have engaged readers in over 200 countries in Kobo eReading. Our eBook listings include New York Times Bestsellers, award winners, classics and more!' - actual_plugin = 'calibre.gui2.store.kobo_plugin:KoboStore' + actual_plugin = 'calibre.gui2.store.stores.kobo_plugin:KoboStore' headquarters = 'CA' formats = ['EPUB'] @@ -1335,7 +1335,7 @@ class StoreLegimiStore(StoreBase): name = 'Legimi' author = u'Tomasz Długosz' description = u'Tanie oraz darmowe ebooki, egazety i blogi w formacie EPUB, wprost na Twój e-czytnik, iPhone, iPad, Android i komputer' - actual_plugin = 'calibre.gui2.store.legimi_plugin:LegimiStore' + actual_plugin = 'calibre.gui2.store.stores.legimi_plugin:LegimiStore' headquarters = 'PL' formats = ['EPUB'] @@ -1344,7 +1344,7 @@ class StoreLibreDEStore(StoreBase): name = 'Libri DE' author = 'Charles Haley' description = u'Sicher Bücher, Hörbücher und Downloads online bestellen.' - actual_plugin = 'calibre.gui2.store.libri_de_plugin:LibreDEStore' + actual_plugin = 'calibre.gui2.store.stores.libri_de_plugin:LibreDEStore' headquarters = 'DE' formats = ['EPUB', 'PDF'] @@ -1353,7 +1353,7 @@ class StoreLibreDEStore(StoreBase): class StoreManyBooksStore(StoreBase): name = 'ManyBooks' description = u'Public domain and creative commons works from many sources.' - actual_plugin = 'calibre.gui2.store.manybooks_plugin:ManyBooksStore' + actual_plugin = 'calibre.gui2.store.stores.manybooks_plugin:ManyBooksStore' drm_free_only = True headquarters = 'US' @@ -1362,7 +1362,7 @@ class StoreManyBooksStore(StoreBase): class StoreMobileReadStore(StoreBase): name = 'MobileRead' description = u'Ebooks handcrafted with the utmost care.' - actual_plugin = 'calibre.gui2.store.mobileread.mobileread_plugin:MobileReadStore' + actual_plugin = 'calibre.gui2.store.stores.mobileread.mobileread_plugin:MobileReadStore' drm_free_only = True headquarters = 'CH' @@ -1372,7 +1372,7 @@ class StoreNextoStore(StoreBase): name = 'Nexto' author = u'Tomasz Długosz' description = u'Największy w Polsce sklep internetowy z audiobookami mp3, ebookami pdf oraz prasą do pobrania on-line.' - actual_plugin = 'calibre.gui2.store.nexto_plugin:NextoStore' + actual_plugin = 'calibre.gui2.store.stores.nexto_plugin:NextoStore' headquarters = 'PL' formats = ['EPUB', 'PDF'] @@ -1381,7 +1381,7 @@ class StoreNextoStore(StoreBase): class StoreOpenBooksStore(StoreBase): name = 'Open Books' description = u'Comprehensive listing of DRM free ebooks from a variety of sources provided by users of calibre.' - actual_plugin = 'calibre.gui2.store.open_books_plugin:OpenBooksStore' + actual_plugin = 'calibre.gui2.store.stores.open_books_plugin:OpenBooksStore' drm_free_only = True headquarters = 'US' @@ -1389,7 +1389,7 @@ class StoreOpenBooksStore(StoreBase): class StoreOpenLibraryStore(StoreBase): name = 'Open Library' description = u'One web page for every book ever published. The goal is to be a true online library. Over 20 million records from a variety of large catalogs as well as single contributions, with more on the way.' - actual_plugin = 'calibre.gui2.store.open_library_plugin:OpenLibraryStore' + actual_plugin = 'calibre.gui2.store.stores.open_library_plugin:OpenLibraryStore' drm_free_only = True headquarters = 'US' @@ -1398,7 +1398,7 @@ class StoreOpenLibraryStore(StoreBase): class StoreOReillyStore(StoreBase): name = 'OReilly' description = u'Programming and tech ebooks from OReilly.' - actual_plugin = 'calibre.gui2.store.oreilly_plugin:OReillyStore' + actual_plugin = 'calibre.gui2.store.stores.oreilly_plugin:OReillyStore' drm_free_only = True headquarters = 'US' @@ -1407,7 +1407,7 @@ class StoreOReillyStore(StoreBase): class StorePragmaticBookshelfStore(StoreBase): name = 'Pragmatic Bookshelf' description = u'The Pragmatic Bookshelf\'s collection of programming and tech books avaliable as ebooks.' - actual_plugin = 'calibre.gui2.store.pragmatic_bookshelf_plugin:PragmaticBookshelfStore' + actual_plugin = 'calibre.gui2.store.stores.pragmatic_bookshelf_plugin:PragmaticBookshelfStore' drm_free_only = True headquarters = 'US' @@ -1416,7 +1416,7 @@ class StorePragmaticBookshelfStore(StoreBase): class StoreSmashwordsStore(StoreBase): name = 'Smashwords' description = u'An ebook publishing and distribution platform for ebook authors, publishers and readers. Covers many genres and formats.' - actual_plugin = 'calibre.gui2.store.smashwords_plugin:SmashwordsStore' + actual_plugin = 'calibre.gui2.store.stores.smashwords_plugin:SmashwordsStore' drm_free_only = True headquarters = 'US' @@ -1427,7 +1427,7 @@ class StoreVirtualoStore(StoreBase): name = 'Virtualo' author = u'Tomasz Długosz' description = u'Księgarnia internetowa, która oferuje bezpieczny i szeroki dostęp do książek w formie cyfrowej.' - actual_plugin = 'calibre.gui2.store.virtualo_plugin:VirtualoStore' + actual_plugin = 'calibre.gui2.store.stores.virtualo_plugin:VirtualoStore' headquarters = 'PL' formats = ['EPUB', 'PDF'] @@ -1436,7 +1436,7 @@ class StoreWaterstonesUKStore(StoreBase): name = 'Waterstones UK' author = 'Charles Haley' description = u'Waterstone\'s mission is to be the leading Bookseller on the High Street and online providing customers the widest choice, great value and expert advice from a team passionate about Bookselling.' - actual_plugin = 'calibre.gui2.store.waterstones_uk_plugin:WaterstonesUKStore' + actual_plugin = 'calibre.gui2.store.stores.waterstones_uk_plugin:WaterstonesUKStore' headquarters = 'UK' formats = ['EPUB', 'PDF'] @@ -1444,7 +1444,7 @@ class StoreWaterstonesUKStore(StoreBase): class StoreWeightlessBooksStore(StoreBase): name = 'Weightless Books' description = u'An independent DRM-free ebooksite devoted to ebooks of all sorts.' - actual_plugin = 'calibre.gui2.store.weightless_books_plugin:WeightlessBooksStore' + actual_plugin = 'calibre.gui2.store.stores.weightless_books_plugin:WeightlessBooksStore' drm_free_only = True headquarters = 'US' @@ -1454,7 +1454,7 @@ class StoreWHSmithUKStore(StoreBase): name = 'WH Smith UK' author = 'Charles Haley' description = u"Shop for savings on Books, discounted Magazine subscriptions and great prices on Stationery, Toys & Games" - actual_plugin = 'calibre.gui2.store.whsmith_uk_plugin:WHSmithUKStore' + actual_plugin = 'calibre.gui2.store.stores.whsmith_uk_plugin:WHSmithUKStore' headquarters = 'UK' formats = ['EPUB', 'PDF'] @@ -1462,7 +1462,7 @@ class StoreWHSmithUKStore(StoreBase): class StoreWizardsTowerBooksStore(StoreBase): name = 'Wizards Tower Books' description = u'A science fiction and fantasy publisher. Concentrates mainly on making out-of-print works available once more as e-books, and helping other small presses exploit the e-book market. Also publishes a small number of limited-print-run anthologies with a view to encouraging diversity in the science fiction and fantasy field.' - actual_plugin = 'calibre.gui2.store.wizards_tower_books_plugin:WizardsTowerBooksStore' + actual_plugin = 'calibre.gui2.store.stores.wizards_tower_books_plugin:WizardsTowerBooksStore' drm_free_only = True headquarters = 'UK' @@ -1472,7 +1472,7 @@ class StoreWoblinkStore(StoreBase): name = 'Woblink' author = u'Tomasz Długosz' description = u'Czytanie zdarza się wszędzie!' - actual_plugin = 'calibre.gui2.store.woblink_plugin:WoblinkStore' + actual_plugin = 'calibre.gui2.store.stores.woblink_plugin:WoblinkStore' headquarters = 'PL' formats = ['EPUB'] @@ -1481,7 +1481,7 @@ class StoreZixoStore(StoreBase): name = 'Zixo' author = u'Tomasz Długosz' description = u'Księgarnia z ebookami oraz książkami audio. Aby otwierać książki w formacie Zixo należy zainstalować program dostępny na stronie księgarni. Umożliwia on m.in. dodawanie zakładek i dostosowywanie rozmiaru czcionki.' - actual_plugin = 'calibre.gui2.store.zixo_plugin:ZixoStore' + actual_plugin = 'calibre.gui2.store.stores.zixo_plugin:ZixoStore' headquarters = 'PL' formats = ['PDF, ZIXO'] diff --git a/src/calibre/gui2/store/stores/__init__.py b/src/calibre/gui2/store/stores/__init__.py new file mode 100644 index 0000000000..db25b54b67 --- /dev/null +++ b/src/calibre/gui2/store/stores/__init__.py @@ -0,0 +1,3 @@ +''' +All store plugins are placed here. +''' \ No newline at end of file diff --git a/src/calibre/gui2/store/amazon_de_plugin.py b/src/calibre/gui2/store/stores/amazon_de_plugin.py similarity index 100% rename from src/calibre/gui2/store/amazon_de_plugin.py rename to src/calibre/gui2/store/stores/amazon_de_plugin.py diff --git a/src/calibre/gui2/store/amazon_plugin.py b/src/calibre/gui2/store/stores/amazon_plugin.py similarity index 100% rename from src/calibre/gui2/store/amazon_plugin.py rename to src/calibre/gui2/store/stores/amazon_plugin.py diff --git a/src/calibre/gui2/store/amazon_uk_plugin.py b/src/calibre/gui2/store/stores/amazon_uk_plugin.py similarity index 100% rename from src/calibre/gui2/store/amazon_uk_plugin.py rename to src/calibre/gui2/store/stores/amazon_uk_plugin.py diff --git a/src/calibre/gui2/store/archive_org_plugin.py b/src/calibre/gui2/store/stores/archive_org_plugin.py similarity index 100% rename from src/calibre/gui2/store/archive_org_plugin.py rename to src/calibre/gui2/store/stores/archive_org_plugin.py diff --git a/src/calibre/gui2/store/baen_webscription_plugin.py b/src/calibre/gui2/store/stores/baen_webscription_plugin.py similarity index 100% rename from src/calibre/gui2/store/baen_webscription_plugin.py rename to src/calibre/gui2/store/stores/baen_webscription_plugin.py diff --git a/src/calibre/gui2/store/beam_ebooks_de_plugin.py b/src/calibre/gui2/store/stores/beam_ebooks_de_plugin.py similarity index 100% rename from src/calibre/gui2/store/beam_ebooks_de_plugin.py rename to src/calibre/gui2/store/stores/beam_ebooks_de_plugin.py diff --git a/src/calibre/gui2/store/bewrite_plugin.py b/src/calibre/gui2/store/stores/bewrite_plugin.py similarity index 100% rename from src/calibre/gui2/store/bewrite_plugin.py rename to src/calibre/gui2/store/stores/bewrite_plugin.py diff --git a/src/calibre/gui2/store/bn_plugin.py b/src/calibre/gui2/store/stores/bn_plugin.py similarity index 100% rename from src/calibre/gui2/store/bn_plugin.py rename to src/calibre/gui2/store/stores/bn_plugin.py diff --git a/src/calibre/gui2/store/diesel_ebooks_plugin.py b/src/calibre/gui2/store/stores/diesel_ebooks_plugin.py similarity index 100% rename from src/calibre/gui2/store/diesel_ebooks_plugin.py rename to src/calibre/gui2/store/stores/diesel_ebooks_plugin.py diff --git a/src/calibre/gui2/store/ebooks_com_plugin.py b/src/calibre/gui2/store/stores/ebooks_com_plugin.py similarity index 100% rename from src/calibre/gui2/store/ebooks_com_plugin.py rename to src/calibre/gui2/store/stores/ebooks_com_plugin.py diff --git a/src/calibre/gui2/store/ebookshoppe_uk_plugin.py b/src/calibre/gui2/store/stores/ebookshoppe_uk_plugin.py similarity index 100% rename from src/calibre/gui2/store/ebookshoppe_uk_plugin.py rename to src/calibre/gui2/store/stores/ebookshoppe_uk_plugin.py diff --git a/src/calibre/gui2/store/eharlequin_plugin.py b/src/calibre/gui2/store/stores/eharlequin_plugin.py similarity index 100% rename from src/calibre/gui2/store/eharlequin_plugin.py rename to src/calibre/gui2/store/stores/eharlequin_plugin.py diff --git a/src/calibre/gui2/store/epubbud_plugin.py b/src/calibre/gui2/store/stores/epubbud_plugin.py similarity index 100% rename from src/calibre/gui2/store/epubbud_plugin.py rename to src/calibre/gui2/store/stores/epubbud_plugin.py diff --git a/src/calibre/gui2/store/epubbuy_de_plugin.py b/src/calibre/gui2/store/stores/epubbuy_de_plugin.py similarity index 100% rename from src/calibre/gui2/store/epubbuy_de_plugin.py rename to src/calibre/gui2/store/stores/epubbuy_de_plugin.py diff --git a/src/calibre/gui2/store/feedbooks_plugin.py b/src/calibre/gui2/store/stores/feedbooks_plugin.py similarity index 100% rename from src/calibre/gui2/store/feedbooks_plugin.py rename to src/calibre/gui2/store/stores/feedbooks_plugin.py diff --git a/src/calibre/gui2/store/foyles_uk_plugin.py b/src/calibre/gui2/store/stores/foyles_uk_plugin.py similarity index 100% rename from src/calibre/gui2/store/foyles_uk_plugin.py rename to src/calibre/gui2/store/stores/foyles_uk_plugin.py diff --git a/src/calibre/gui2/store/gandalf_plugin.py b/src/calibre/gui2/store/stores/gandalf_plugin.py similarity index 100% rename from src/calibre/gui2/store/gandalf_plugin.py rename to src/calibre/gui2/store/stores/gandalf_plugin.py diff --git a/src/calibre/gui2/store/google_books_plugin.py b/src/calibre/gui2/store/stores/google_books_plugin.py similarity index 100% rename from src/calibre/gui2/store/google_books_plugin.py rename to src/calibre/gui2/store/stores/google_books_plugin.py diff --git a/src/calibre/gui2/store/gutenberg_plugin.py b/src/calibre/gui2/store/stores/gutenberg_plugin.py similarity index 100% rename from src/calibre/gui2/store/gutenberg_plugin.py rename to src/calibre/gui2/store/stores/gutenberg_plugin.py diff --git a/src/calibre/gui2/store/kobo_plugin.py b/src/calibre/gui2/store/stores/kobo_plugin.py similarity index 100% rename from src/calibre/gui2/store/kobo_plugin.py rename to src/calibre/gui2/store/stores/kobo_plugin.py diff --git a/src/calibre/gui2/store/legimi_plugin.py b/src/calibre/gui2/store/stores/legimi_plugin.py similarity index 100% rename from src/calibre/gui2/store/legimi_plugin.py rename to src/calibre/gui2/store/stores/legimi_plugin.py diff --git a/src/calibre/gui2/store/libri_de_plugin.py b/src/calibre/gui2/store/stores/libri_de_plugin.py similarity index 100% rename from src/calibre/gui2/store/libri_de_plugin.py rename to src/calibre/gui2/store/stores/libri_de_plugin.py diff --git a/src/calibre/gui2/store/manybooks_plugin.py b/src/calibre/gui2/store/stores/manybooks_plugin.py similarity index 100% rename from src/calibre/gui2/store/manybooks_plugin.py rename to src/calibre/gui2/store/stores/manybooks_plugin.py diff --git a/src/calibre/gui2/store/mobileread/__init__.py b/src/calibre/gui2/store/stores/mobileread/__init__.py similarity index 100% rename from src/calibre/gui2/store/mobileread/__init__.py rename to src/calibre/gui2/store/stores/mobileread/__init__.py diff --git a/src/calibre/gui2/store/mobileread/adv_search_builder.py b/src/calibre/gui2/store/stores/mobileread/adv_search_builder.py similarity index 97% rename from src/calibre/gui2/store/mobileread/adv_search_builder.py rename to src/calibre/gui2/store/stores/mobileread/adv_search_builder.py index 8c41f1924b..8bc7850b0f 100644 --- a/src/calibre/gui2/store/mobileread/adv_search_builder.py +++ b/src/calibre/gui2/store/stores/mobileread/adv_search_builder.py @@ -10,7 +10,7 @@ import re from PyQt4.Qt import (QDialog, QDialogButtonBox) -from calibre.gui2.store.mobileread.adv_search_builder_ui import Ui_Dialog +from calibre.gui2.store.stores.mobileread.adv_search_builder_ui import Ui_Dialog from calibre.library.caches import CONTAINS_MATCH, EQUALS_MATCH class AdvSearchBuilderDialog(QDialog, Ui_Dialog): diff --git a/src/calibre/gui2/store/mobileread/adv_search_builder.ui b/src/calibre/gui2/store/stores/mobileread/adv_search_builder.ui similarity index 100% rename from src/calibre/gui2/store/mobileread/adv_search_builder.ui rename to src/calibre/gui2/store/stores/mobileread/adv_search_builder.ui diff --git a/src/calibre/gui2/store/mobileread/cache_progress_dialog.py b/src/calibre/gui2/store/stores/mobileread/cache_progress_dialog.py similarity index 94% rename from src/calibre/gui2/store/mobileread/cache_progress_dialog.py rename to src/calibre/gui2/store/stores/mobileread/cache_progress_dialog.py index 71416d8680..de2cf50f84 100644 --- a/src/calibre/gui2/store/mobileread/cache_progress_dialog.py +++ b/src/calibre/gui2/store/stores/mobileread/cache_progress_dialog.py @@ -8,7 +8,7 @@ __docformat__ = 'restructuredtext en' from PyQt4.Qt import QDialog -from calibre.gui2.store.mobileread.cache_progress_dialog_ui import Ui_Dialog +from calibre.gui2.store.stores.mobileread.cache_progress_dialog_ui import Ui_Dialog class CacheProgressDialog(QDialog, Ui_Dialog): diff --git a/src/calibre/gui2/store/mobileread/cache_progress_dialog.ui b/src/calibre/gui2/store/stores/mobileread/cache_progress_dialog.ui similarity index 100% rename from src/calibre/gui2/store/mobileread/cache_progress_dialog.ui rename to src/calibre/gui2/store/stores/mobileread/cache_progress_dialog.ui diff --git a/src/calibre/gui2/store/mobileread/cache_update_thread.py b/src/calibre/gui2/store/stores/mobileread/cache_update_thread.py similarity index 100% rename from src/calibre/gui2/store/mobileread/cache_update_thread.py rename to src/calibre/gui2/store/stores/mobileread/cache_update_thread.py diff --git a/src/calibre/gui2/store/mobileread/mobileread_plugin.py b/src/calibre/gui2/store/stores/mobileread/mobileread_plugin.py similarity index 91% rename from src/calibre/gui2/store/mobileread/mobileread_plugin.py rename to src/calibre/gui2/store/stores/mobileread/mobileread_plugin.py index 4e11d62bbd..3ffb5c36a1 100644 --- a/src/calibre/gui2/store/mobileread/mobileread_plugin.py +++ b/src/calibre/gui2/store/stores/mobileread/mobileread_plugin.py @@ -15,10 +15,10 @@ from calibre.gui2.store import StorePlugin from calibre.gui2.store.basic_config import BasicStoreConfig from calibre.gui2.store.search_result import SearchResult from calibre.gui2.store.web_store_dialog import WebStoreDialog -from calibre.gui2.store.mobileread.models import SearchFilter -from calibre.gui2.store.mobileread.cache_progress_dialog import CacheProgressDialog -from calibre.gui2.store.mobileread.cache_update_thread import CacheUpdateThread -from calibre.gui2.store.mobileread.store_dialog import MobileReadStoreDialog +from calibre.gui2.store.stores.mobileread.models import SearchFilter +from calibre.gui2.store.stores.mobileread.cache_progress_dialog import CacheProgressDialog +from calibre.gui2.store.stores.mobileread.cache_update_thread import CacheUpdateThread +from calibre.gui2.store.stores.mobileread.store_dialog import MobileReadStoreDialog class MobileReadStore(BasicStoreConfig, StorePlugin): diff --git a/src/calibre/gui2/store/mobileread/models.py b/src/calibre/gui2/store/stores/mobileread/models.py similarity index 100% rename from src/calibre/gui2/store/mobileread/models.py rename to src/calibre/gui2/store/stores/mobileread/models.py diff --git a/src/calibre/gui2/store/mobileread/store_dialog.py b/src/calibre/gui2/store/stores/mobileread/store_dialog.py similarity index 93% rename from src/calibre/gui2/store/mobileread/store_dialog.py rename to src/calibre/gui2/store/stores/mobileread/store_dialog.py index 749f96a614..ff7fea090f 100644 --- a/src/calibre/gui2/store/mobileread/store_dialog.py +++ b/src/calibre/gui2/store/stores/mobileread/store_dialog.py @@ -9,9 +9,9 @@ __docformat__ = 'restructuredtext en' from PyQt4.Qt import (Qt, QDialog, QIcon, QComboBox) -from calibre.gui2.store.mobileread.adv_search_builder import AdvSearchBuilderDialog -from calibre.gui2.store.mobileread.models import BooksModel -from calibre.gui2.store.mobileread.store_dialog_ui import Ui_Dialog +from calibre.gui2.store.stores.mobileread.adv_search_builder import AdvSearchBuilderDialog +from calibre.gui2.store.stores.mobileread.models import BooksModel +from calibre.gui2.store.stores.mobileread.store_dialog_ui import Ui_Dialog class MobileReadStoreDialog(QDialog, Ui_Dialog): diff --git a/src/calibre/gui2/store/mobileread/store_dialog.ui b/src/calibre/gui2/store/stores/mobileread/store_dialog.ui similarity index 100% rename from src/calibre/gui2/store/mobileread/store_dialog.ui rename to src/calibre/gui2/store/stores/mobileread/store_dialog.ui diff --git a/src/calibre/gui2/store/nexto_plugin.py b/src/calibre/gui2/store/stores/nexto_plugin.py similarity index 100% rename from src/calibre/gui2/store/nexto_plugin.py rename to src/calibre/gui2/store/stores/nexto_plugin.py diff --git a/src/calibre/gui2/store/open_books_plugin.py b/src/calibre/gui2/store/stores/open_books_plugin.py similarity index 100% rename from src/calibre/gui2/store/open_books_plugin.py rename to src/calibre/gui2/store/stores/open_books_plugin.py diff --git a/src/calibre/gui2/store/open_library_plugin.py b/src/calibre/gui2/store/stores/open_library_plugin.py similarity index 100% rename from src/calibre/gui2/store/open_library_plugin.py rename to src/calibre/gui2/store/stores/open_library_plugin.py diff --git a/src/calibre/gui2/store/oreilly_plugin.py b/src/calibre/gui2/store/stores/oreilly_plugin.py similarity index 100% rename from src/calibre/gui2/store/oreilly_plugin.py rename to src/calibre/gui2/store/stores/oreilly_plugin.py diff --git a/src/calibre/gui2/store/pragmatic_bookshelf_plugin.py b/src/calibre/gui2/store/stores/pragmatic_bookshelf_plugin.py similarity index 100% rename from src/calibre/gui2/store/pragmatic_bookshelf_plugin.py rename to src/calibre/gui2/store/stores/pragmatic_bookshelf_plugin.py diff --git a/src/calibre/gui2/store/smashwords_plugin.py b/src/calibre/gui2/store/stores/smashwords_plugin.py similarity index 100% rename from src/calibre/gui2/store/smashwords_plugin.py rename to src/calibre/gui2/store/stores/smashwords_plugin.py diff --git a/src/calibre/gui2/store/virtualo_plugin.py b/src/calibre/gui2/store/stores/virtualo_plugin.py similarity index 100% rename from src/calibre/gui2/store/virtualo_plugin.py rename to src/calibre/gui2/store/stores/virtualo_plugin.py diff --git a/src/calibre/gui2/store/waterstones_uk_plugin.py b/src/calibre/gui2/store/stores/waterstones_uk_plugin.py similarity index 100% rename from src/calibre/gui2/store/waterstones_uk_plugin.py rename to src/calibre/gui2/store/stores/waterstones_uk_plugin.py diff --git a/src/calibre/gui2/store/weightless_books_plugin.py b/src/calibre/gui2/store/stores/weightless_books_plugin.py similarity index 100% rename from src/calibre/gui2/store/weightless_books_plugin.py rename to src/calibre/gui2/store/stores/weightless_books_plugin.py diff --git a/src/calibre/gui2/store/whsmith_uk_plugin.py b/src/calibre/gui2/store/stores/whsmith_uk_plugin.py similarity index 100% rename from src/calibre/gui2/store/whsmith_uk_plugin.py rename to src/calibre/gui2/store/stores/whsmith_uk_plugin.py diff --git a/src/calibre/gui2/store/wizards_tower_books_plugin.py b/src/calibre/gui2/store/stores/wizards_tower_books_plugin.py similarity index 100% rename from src/calibre/gui2/store/wizards_tower_books_plugin.py rename to src/calibre/gui2/store/stores/wizards_tower_books_plugin.py diff --git a/src/calibre/gui2/store/woblink_plugin.py b/src/calibre/gui2/store/stores/woblink_plugin.py similarity index 100% rename from src/calibre/gui2/store/woblink_plugin.py rename to src/calibre/gui2/store/stores/woblink_plugin.py diff --git a/src/calibre/gui2/store/zixo_plugin.py b/src/calibre/gui2/store/stores/zixo_plugin.py similarity index 100% rename from src/calibre/gui2/store/zixo_plugin.py rename to src/calibre/gui2/store/stores/zixo_plugin.py From 3c83b7873a108764bf78a8d04d5d9bbe8755d2a1 Mon Sep 17 00:00:00 2001 From: John Schember Date: Sun, 26 Jun 2011 12:29:58 -0400 Subject: [PATCH 21/24] Store: Allow for direct downloading of ebooks in the Get Books search dialog. Allow the user to right click and choose between downloading or opening in the store. --- src/calibre/gui2/store/opensearch_store.py | 14 ++++---- .../gui2/store/search/adv_search_builder.py | 4 +++ .../gui2/store/search/adv_search_builder.ui | 34 ++++++++++++++++--- src/calibre/gui2/store/search/models.py | 25 +++++++++++--- src/calibre/gui2/store/search/results_view.py | 22 +++++++++++- src/calibre/gui2/store/search/search.py | 28 ++++++++++++--- src/calibre/gui2/store/search_result.py | 4 ++- .../gui2/store/stores/epubbud_plugin.py | 2 ++ 8 files changed, 112 insertions(+), 21 deletions(-) diff --git a/src/calibre/gui2/store/opensearch_store.py b/src/calibre/gui2/store/opensearch_store.py index a3dc0e7941..8a25a80132 100644 --- a/src/calibre/gui2/store/opensearch_store.py +++ b/src/calibre/gui2/store/opensearch_store.py @@ -59,14 +59,14 @@ class OpenSearchStore(StorePlugin): elif l['rel'] == u'http://opds-spec.org/acquisition/buy': s.detail_item = l.get('href', s.detail_item) elif l['rel'] == u'http://opds-spec.org/acquisition': - s.downloads.append((l.get('type', ''), l.get('href', ''))) + mime = l.get('type', '') + if mime: + ext = mimetypes.guess_extension(mime) + if ext: + ext = ext[1:].upper() + s.downloads[ext] = l.get('href', '') - formats = [] - for mime, url in s.downloads: - ext = mimetypes.guess_extension(mime) - if ext: - formats.append(ext[1:]) - s.formats = ', '.join(formats) + s.formats = ', '.join(s.downloads.keys()) s.title = r.get('title', '') s.author = r.get('author', '') diff --git a/src/calibre/gui2/store/search/adv_search_builder.py b/src/calibre/gui2/store/search/adv_search_builder.py index cc89ca4eb7..127ac27acb 100644 --- a/src/calibre/gui2/store/search/adv_search_builder.py +++ b/src/calibre/gui2/store/search/adv_search_builder.py @@ -45,6 +45,7 @@ class AdvSearchBuilderDialog(QDialog, Ui_Dialog): self.author_box.setText('') self.price_box.setText('') self.format_box.setText('') + self.download_combo.setCurrentIndex(0) self.affiliate_combo.setCurrentIndex(0) def tokens(self, raw): @@ -119,6 +120,9 @@ class AdvSearchBuilderDialog(QDialog, Ui_Dialog): format = unicode(self.format_box.text()).strip() if format: ans.append('format:"' + self.mc + format + '"') + download = unicode(self.download_combo.currentText()).strip() + if download: + ans.append('download:' + download) affiliate = unicode(self.affiliate_combo.currentText()).strip() if affiliate: ans.append('affiliate:' + affiliate) diff --git a/src/calibre/gui2/store/search/adv_search_builder.ui b/src/calibre/gui2/store/search/adv_search_builder.ui index ab12dbbc00..02eb8f6aa1 100644 --- a/src/calibre/gui2/store/search/adv_search_builder.ui +++ b/src/calibre/gui2/store/search/adv_search_builder.ui @@ -226,7 +226,7 @@ - + @@ -244,7 +244,7 @@ - + Qt::Vertical @@ -283,14 +283,14 @@ - + Affiliate: - + @@ -309,6 +309,32 @@ + + + + Download: + + + + + + + + + + + + + true + + + + + false + + + + diff --git a/src/calibre/gui2/store/search/models.py b/src/calibre/gui2/store/search/models.py index e2c1a03e90..1fb0e5327b 100644 --- a/src/calibre/gui2/store/search/models.py +++ b/src/calibre/gui2/store/search/models.py @@ -33,7 +33,7 @@ class Matches(QAbstractItemModel): total_changed = pyqtSignal(int) - HEADERS = [_('Cover'), _('Title'), _('Price'), _('DRM'), _('Store'), ''] + HEADERS = [_('Cover'), _('Title'), _('Price'), _('DRM'), _('Store'), _('Download'), _('Affiliate')] HTML_COLS = (1, 4) def __init__(self, cover_thread_count=2, detail_thread_count=4): @@ -47,6 +47,8 @@ class Matches(QAbstractItemModel): Qt.SmoothTransformation) self.DONATE_ICON = QPixmap(I('donate.png')).scaledToHeight(16, Qt.SmoothTransformation) + self.DOWNLOAD_ICON = QPixmap(I('arrow-down.png')).scaledToHeight(16, + Qt.SmoothTransformation) # All matches. Used to determine the order to display # self.matches because the SearchFilter returns @@ -181,9 +183,11 @@ class Matches(QAbstractItemModel): elif result.drm == SearchResult.DRM_UNKNOWN: return QVariant(self.DRM_UNKNOWN_ICON) if col == 5: + if result.downloads: + return QVariant(self.DOWNLOAD_ICON) + if col == 6: if result.affiliate: return QVariant(self.DONATE_ICON) - return NONE elif role == Qt.ToolTipRole: if col == 1: return QVariant('

%s

' % result.title) @@ -199,6 +203,9 @@ class Matches(QAbstractItemModel): elif col == 4: return QVariant('

%s

' % result.formats) elif col == 5: + if result.downloads: + return QVariant('

' + _('The following formats can be downloaded directly: %s.') % ', '.join(result.downloads.keys()) + '

') + elif col == 6: if result.affiliate: return QVariant('

' + _('Buying from this store supports the calibre developer: %s.') % result.plugin_author + '

') elif role == Qt.SizeHintRole: @@ -221,6 +228,11 @@ class Matches(QAbstractItemModel): elif col == 4: text = result.store_name elif col == 5: + if result.downloads: + text = 'a' + else: + text = 'b' + elif col == 6: if result.affiliate: text = 'a' else: @@ -257,6 +269,8 @@ class SearchFilter(SearchQueryParser): 'author', 'authors', 'cover', + 'download', + 'downloads', 'drm', 'format', 'formats', @@ -282,6 +296,8 @@ class SearchFilter(SearchQueryParser): location = location.lower().strip() if location == 'authors': location = 'author' + elif location == 'downloads': + location = 'download' elif location == 'formats': location = 'format' @@ -308,12 +324,13 @@ class SearchFilter(SearchQueryParser): 'author': lambda x: x.author.lower(), 'cover': attrgetter('cover_url'), 'drm': attrgetter('drm'), + 'download': attrgetter('downloads'), 'format': attrgetter('formats'), 'price': lambda x: comparable_price(x.price), 'store': lambda x: x.store_name.lower(), 'title': lambda x: x.title.lower(), } - for x in ('author', 'format'): + for x in ('author', 'download', 'format'): q[x+'s'] = q[x] for sr in self.srs: for locvalue in locations: @@ -347,7 +364,7 @@ class SearchFilter(SearchQueryParser): matches.add(sr) continue # this is bool or treated as bool, so can't match below. - if locvalue in ('affiliate', 'drm'): + if locvalue in ('affiliate', 'drm', 'download', 'downloads'): continue try: ### Can't separate authors because comma is used for name sep and author sep diff --git a/src/calibre/gui2/store/search/results_view.py b/src/calibre/gui2/store/search/results_view.py index 91c067006e..3957e18ef6 100644 --- a/src/calibre/gui2/store/search/results_view.py +++ b/src/calibre/gui2/store/search/results_view.py @@ -6,13 +6,18 @@ __license__ = 'GPL 3' __copyright__ = '2011, John Schember ' __docformat__ = 'restructuredtext en' -from PyQt4.Qt import (QTreeView) +from functools import partial + +from PyQt4.Qt import (pyqtSignal, QMenu, QTreeView) from calibre.gui2.metadata.single_download import RichTextDelegate from calibre.gui2.store.search.models import Matches class ResultsView(QTreeView): + download_requested = pyqtSignal(object) + open_requested = pyqtSignal(object) + def __init__(self, *args): QTreeView.__init__(self,*args) @@ -24,3 +29,18 @@ class ResultsView(QTreeView): for i in self._model.HTML_COLS: self.setItemDelegateForColumn(i, self.rt_delegate) + def contextMenuEvent(self, event): + index = self.indexAt(event.pos()) + + if not index.isValid(): + return + + result = self.model().get_result(index) + + menu = QMenu() + da = menu.addAction(_('Download...'), partial(self.download_requested.emit, result)) + if not result.downloads: + da.setEnabled(False) + menu.addSeparator() + menu.addAction(_('Goto in store...'), partial(self.open_requested.emit, result)) + menu.exec_(event.globalPos()) diff --git a/src/calibre/gui2/store/search/search.py b/src/calibre/gui2/store/search/search.py index 7db4d1bbaf..fd20669f09 100644 --- a/src/calibre/gui2/store/search/search.py +++ b/src/calibre/gui2/store/search/search.py @@ -14,6 +14,7 @@ from PyQt4.Qt import (Qt, QDialog, QDialogButtonBox, QTimer, QCheckBox, QLabel, QComboBox) from calibre.gui2 import JSONConfig, info_dialog +from calibre.gui2.dialogs.choose_format import ChooseFormatDialog from calibre.gui2.progress_indicator import ProgressIndicator from calibre.gui2.store.config.chooser.chooser_widget import StoreChooserWidget from calibre.gui2.store.config.search.search_widget import StoreConfigWidget @@ -72,7 +73,9 @@ class SearchDialog(QDialog, Ui_Dialog): self.search.clicked.connect(self.do_search) self.checker.timeout.connect(self.get_results) self.progress_checker.timeout.connect(self.check_progress) - self.results_view.activated.connect(self.open_store) + self.results_view.activated.connect(self.result_item_activated) + self.results_view.download_requested.connect(self.download_book) + self.results_view.open_requested.connect(self.open_store) self.results_view.model().total_changed.connect(self.update_book_total) self.select_all_stores.clicked.connect(self.stores_select_all) self.select_invert_stores.clicked.connect(self.stores_select_invert) @@ -129,11 +132,15 @@ class SearchDialog(QDialog, Ui_Dialog): # Title / Author self.results_view.setColumnWidth(1,int(total*.40)) # Price - self.results_view.setColumnWidth(2,int(total*.20)) + self.results_view.setColumnWidth(2,int(total*.12)) # DRM self.results_view.setColumnWidth(3, int(total*.15)) # Store / Formats self.results_view.setColumnWidth(4, int(total*.25)) + # Download + self.results_view.setColumnWidth(5, 20) + # Affiliate + self.results_view.setColumnWidth(6, 20) def do_search(self): # Stop all running threads. @@ -183,7 +190,7 @@ class SearchDialog(QDialog, Ui_Dialog): query = re.sub(r'%s:"(?P[^\s"]+)"' % loc, '\g', query) query = query.replace('%s:' % loc, '') # Remove the prefix and search text. - for loc in ('cover', 'drm', 'format', 'formats', 'price', 'store'): + for loc in ('cover', 'download', 'downloads', 'drm', 'format', 'formats', 'price', 'store'): query = re.sub(r'%s:"[^"]"' % loc, '', query) query = re.sub(r'%s:[^\s]*' % loc, '', query) # Remove logic. @@ -330,8 +337,21 @@ class SearchDialog(QDialog, Ui_Dialog): def update_book_total(self, total): self.total.setText('%s' % total) - def open_store(self, index): + def result_item_activated(self, index): result = self.results_view.model().get_result(index) + + if result.downloads: + self.download_book(result) + else: + self.open_store(result) + + def download_book(self, result): + d = ChooseFormatDialog(self, _('Choose format to download to your library.'), result.downloads.keys()) + if d.exec_() == d.Accepted: + ext = d.format() + self.gui.download_ebook(result.downloads[ext]) + + def open_store(self, result): self.gui.istores[result.store_name].open(self, result.detail_item, self.open_external.isChecked()) def check_progress(self): diff --git a/src/calibre/gui2/store/search_result.py b/src/calibre/gui2/store/search_result.py index bbe5b83c38..5cf71f011e 100644 --- a/src/calibre/gui2/store/search_result.py +++ b/src/calibre/gui2/store/search_result.py @@ -22,7 +22,9 @@ class SearchResult(object): self.detail_item = '' self.drm = None self.formats = '' - self.downloads = [] + # key = format in upper case. + # value = url to download the file. + self.downloads = {} self.affiliate = False self.plugin_author = '' diff --git a/src/calibre/gui2/store/stores/epubbud_plugin.py b/src/calibre/gui2/store/stores/epubbud_plugin.py index 7c581b9578..b4d642f62b 100644 --- a/src/calibre/gui2/store/stores/epubbud_plugin.py +++ b/src/calibre/gui2/store/stores/epubbud_plugin.py @@ -22,4 +22,6 @@ class EpubBudStore(BasicStoreConfig, OpenSearchStore): s.price = '$0.00' s.drm = SearchResult.DRM_UNLOCKED s.formats = 'EPUB' + # Download links are broken for this store. + s.downloads = {} yield s From 38364443a7c9cbacdec724bd197e453ba89c1ffc Mon Sep 17 00:00:00 2001 From: John Schember Date: Sun, 26 Jun 2011 20:56:43 -0400 Subject: [PATCH 22/24] OpenSearch: rewrite module to use lxml and remove the modified feed parser as it causes all avaliable file descriptors to be used. Store: Rework opensearch class to use the changes to the opensearch module. --- src/calibre/gui2/store/opensearch_store.py | 81 +- .../gui2/store/stores/archive_org_plugin.py | 1 + src/calibre/utils/opensearch/__init__.py | 4 - src/calibre/utils/opensearch/client.py | 39 - src/calibre/utils/opensearch/description.py | 135 +- src/calibre/utils/opensearch/osfeedparser.py | 2837 ----------------- src/calibre/utils/opensearch/query.py | 32 +- src/calibre/utils/opensearch/results.py | 131 - src/calibre/utils/opensearch/url.py | 14 +- 9 files changed, 144 insertions(+), 3130 deletions(-) delete mode 100644 src/calibre/utils/opensearch/client.py delete mode 100644 src/calibre/utils/opensearch/osfeedparser.py delete mode 100644 src/calibre/utils/opensearch/results.py diff --git a/src/calibre/gui2/store/opensearch_store.py b/src/calibre/gui2/store/opensearch_store.py index 8a25a80132..456b6a7461 100644 --- a/src/calibre/gui2/store/opensearch_store.py +++ b/src/calibre/gui2/store/opensearch_store.py @@ -8,14 +8,20 @@ __docformat__ = 'restructuredtext en' import mimetypes import urllib +from contextlib import closing + +from lxml import etree from PyQt4.Qt import QUrl +from calibre import browser from calibre.gui2 import open_url from calibre.gui2.store import StorePlugin from calibre.gui2.store.search_result import SearchResult from calibre.gui2.store.web_store_dialog import WebStoreDialog -from calibre.utils.opensearch import Client +#from calibre.utils.opensearch import Client +from calibre.utils.opensearch.description import Description +from calibre.utils.opensearch.query import Query class OpenSearchStore(StorePlugin): @@ -38,38 +44,51 @@ class OpenSearchStore(StorePlugin): if not hasattr(self, 'open_search_url'): return - client = Client(self.open_search_url) - results = client.search(urllib.quote_plus(query), max_results) + description = Description(self.open_search_url) + url_template = description.get_best_template() + if not url_template: + return + oquery = Query(url_template) + + # set up initial values + oquery.searchTerms = urllib.quote_plus(query) + oquery.count = max_results + url = oquery.url() counter = max_results - for r in results: - if counter <= 0: - break - counter -= 1 + br = browser() + with closing(br.open(url, timeout=timeout)) as f: + doc = etree.fromstring(f.read()) + for data in doc.xpath('//*[local-name() = "entry"]'): + if counter <= 0: + break - s = SearchResult() - - s.detail_item = r.get('id', '') - - links = r.get('links', None) - for l in links: - if l.get('rel', None): - if l['rel'] in ('http://opds-spec.org/thumbnail', 'http://opds-spec.org/image/thumbnail'): - s.cover_url = l.get('href', '') - elif l['rel'] == u'http://opds-spec.org/acquisition/buy': - s.detail_item = l.get('href', s.detail_item) - elif l['rel'] == u'http://opds-spec.org/acquisition': - mime = l.get('type', '') - if mime: - ext = mimetypes.guess_extension(mime) - if ext: - ext = ext[1:].upper() - s.downloads[ext] = l.get('href', '') + counter -= 1 + + s = SearchResult() + + s.detail_item = ''.join(data.xpath('./*[local-name() = "id"]/text()')) - s.formats = ', '.join(s.downloads.keys()) + for link in data.xpath('./*[local-name() = "link"]'): + rel = link.get('rel') + href = link.get('href') + type = link.get('type') + + if rel and href and type: + if rel in ('http://opds-spec.org/thumbnail', 'http://opds-spec.org/image/thumbnail'): + s.cover_url = href + elif rel == u'http://opds-spec.org/acquisition/buy': + s.detail_item = href + elif rel == u'http://opds-spec.org/acquisition': + if type: + ext = mimetypes.guess_extension(type) + if ext: + ext = ext[1:].upper() + s.downloads[ext] = href + s.formats = ', '.join(s.downloads.keys()) + + s.title = ' '.join(data.xpath('./*[local-name() = "title"]//text()')) + s.author = ', '.join(data.xpath('./*[local-name() = "author"]//*[local-name() = "name"]//text()')) + s.price = ' '.join(data.xpath('.//*[local-name() = "price"]//text()')) - s.title = r.get('title', '') - s.author = r.get('author', '') - s.price = r.get('price', '') - - yield s + yield s diff --git a/src/calibre/gui2/store/stores/archive_org_plugin.py b/src/calibre/gui2/store/stores/archive_org_plugin.py index 944b7aeba1..208b4c1aba 100644 --- a/src/calibre/gui2/store/stores/archive_org_plugin.py +++ b/src/calibre/gui2/store/stores/archive_org_plugin.py @@ -28,6 +28,7 @@ class ArchiveOrgStore(BasicStoreConfig, OpenSearchStore): s.price = '$0.00' s.drm = SearchResult.DRM_UNLOCKED yield s + ''' def get_details(self, search_result, timeout): br = browser() diff --git a/src/calibre/utils/opensearch/__init__.py b/src/calibre/utils/opensearch/__init__.py index f2d51febc4..e69de29bb2 100644 --- a/src/calibre/utils/opensearch/__init__.py +++ b/src/calibre/utils/opensearch/__init__.py @@ -1,4 +0,0 @@ -from description import Description -from query import Query -from client import Client -from results import Results diff --git a/src/calibre/utils/opensearch/client.py b/src/calibre/utils/opensearch/client.py deleted file mode 100644 index 434e921568..0000000000 --- a/src/calibre/utils/opensearch/client.py +++ /dev/null @@ -1,39 +0,0 @@ -from description import Description -from query import Query -from results import Results - -class Client: - - """This is the class you'll probably want to be using. You simply - pass the constructor the url for the service description file and - issue a search and get back results as an iterable Results object. - - The neat thing about a Results object is that it will seamlessly - handle fetching more results from the opensearch server when it can... - so you just need to iterate and can let the paging be taken care of - for you. - - from opensearch import Client - client = Client(description_url) - results = client.search("computer") - for result in results: - print result.title - """ - - def __init__(self, url, agent="python-opensearch "): - self.agent = agent - self.description = Description(url, self.agent) - - def search(self, search_terms, page_size=25): - """Perform a search and get back a results object - """ - url = self.description.get_best_template() - query = Query(url) - - # set up initial values - query.searchTerms = search_terms - query.count = page_size - - # run the results - return Results(query, agent=self.agent) - diff --git a/src/calibre/utils/opensearch/description.py b/src/calibre/utils/opensearch/description.py index 2909dbceb3..0b5afd8a7e 100644 --- a/src/calibre/utils/opensearch/description.py +++ b/src/calibre/utils/opensearch/description.py @@ -1,71 +1,95 @@ -from urllib2 import urlopen, Request -from xml.dom.minidom import parse -from url import URL +# -*- coding: utf-8 -*- -class Description: - """A class for representing OpenSearch Description files. - """ +from __future__ import (unicode_literals, division, absolute_import, print_function) - def __init__(self, url="", agent=""): - """The constructor which may pass an optional url to load from. +__license__ = 'GPL 3' +__copyright__ = ''' +2011, John Schember , +2006, Ed Summers +''' +__docformat__ = 'restructuredtext en' + +from contextlib import closing + +from lxml import etree + +from calibre import browser +from calibre.utils.opensearch.url import URL + +class Description(object): + ''' + A class for representing OpenSearch Description files. + ''' + + def __init__(self, url=""): + ''' + The constructor which may pass an optional url to load from. d = Description("http://www.example.com/description") - """ - self.agent = agent + ''' if url: self.load(url) def load(self, url): - """For loading up a description object from a url. Normally + ''' + For loading up a description object from a url. Normally you'll probably just want to pass a URL into the constructor. - """ - req = Request(url, headers={'User-Agent':self.agent}) - self.dom = parse(urlopen(req)) - + ''' + br = browser() + with closing(br.open(url, timeout=15)) as f: + doc = etree.fromstring(f.read()) + # version 1.1 has repeating Url elements - self.urls = self._get_urls() + self.urls = [] + for element in doc.xpath('//*[local-name() = "Url"]'): + template = element.get('template') + type = element.get('type') + if template and type: + url = URL() + url.template = template + url.type = type + self.urls.append(url) # this is version 1.0 specific - self.url = self._get_element_text('Url') - self.format = self._get_element_text('Format') + self.url = ''.join(doc.xpath('//*[local-name() = "Url"][1]//text()')) + self.format = ''.join(doc.xpath('//*[local-name() = "Format"][1]//text()')) - self.shortname = self._get_element_text('ShortName') - self.longname = self._get_element_text('LongName') - self.description = self._get_element_text('Description') - self.image = self._get_element_text('Image') - self.samplesearch = self._get_element_text('SampleSearch') - self.developer = self._get_element_text('Developer') - self.contact = self._get_element_text('Contact') - self.attribution = self._get_element_text('Attribution') - self.syndicationright = self._get_element_text('SyndicationRight') + self.shortname = ''.join(doc.xpath('//*[local-name() = "ShortName"][1]//text()')) + self.longname = ''.join(doc.xpath('//*[local-name() = "LongName"][1]//text()')) + self.description = ''.join(doc.xpath('//*[local-name() = "Description"][1]//text()')) + self.image = ''.join(doc.xpath('//*[local-name() = "Image"][1]//text()')) + self.sameplesearch = ''.join(doc.xpath('//*[local-name() = "SampleSearch"][1]//text()')) + self.developer = ''.join(doc.xpath('//*[local-name() = "Developer"][1]//text()')) + self.contact = ''.join(doc.xpath('/*[local-name() = "Contact"][1]//text()')) + self.attribution = ''.join(doc.xpath('//*[local-name() = "Attribution"][1]//text()')) + self.syndicationright = ''.join(doc.xpath('//*[local-name() = "SyndicationRight"][1]//text()')) - tag_text = self._get_element_text('Tags') + tag_text = ' '.join(doc.xpath('//*[local-name() = "Tags"]//text()')) if tag_text != None: - self.tags = tag_text.split(" ") + self.tags = tag_text.split(' ') - if self._get_element_text('AdultContent') == 'true': - self.adultcontent = True - else: - self.adultcontent = False + self.adultcontent = doc.xpath('boolean(//*[local-name() = "AdultContent" and contains(., "true")])') def get_url_by_type(self, type): - """Walks available urls and returns them by type. Only + ''' + Walks available urls and returns them by type. Only appropriate in opensearch v1.1 where there can be multiple query targets. Returns none if no such type is found. url = description.get_url_by_type('application/rss+xml') - """ + ''' for url in self.urls: if url.type == type: return url return None def get_best_template(self): - """OK, best is a value judgement, but so be it. You'll get + ''' + OK, best is a value judgement, but so be it. You'll get back either the atom, rss or first template available. This method handles the main difference between opensearch v1.0 and v1.1 - """ + ''' # version 1.0 if self.url: return self.url @@ -88,40 +112,3 @@ class Description: # out of luck return None - - - # these are internal methods for querying xml - - def _get_element_text(self, tag): - elements = self._get_elements(tag) - if not elements: - return None - return self._get_text(elements[0].childNodes) - - def _get_attribute_text(self, tag, attribute): - elements = self._get_elements(tag) - if not elements: - return '' - return elements[0].getAttribute('template') - - def _get_elements(self, tag): - return self.dom.getElementsByTagName(tag) - - def _get_text(self, nodes): - text = '' - for node in nodes: - if node.nodeType == node.TEXT_NODE: - text += node.data - return text.strip() - - def _get_urls(self): - urls = [] - for element in self._get_elements('Url'): - template = element.getAttribute('template') - type = element.getAttribute('type') - if template and type: - url = URL() - url.template = template - url.type = type - urls.append(url) - return urls diff --git a/src/calibre/utils/opensearch/osfeedparser.py b/src/calibre/utils/opensearch/osfeedparser.py deleted file mode 100644 index ed894cb572..0000000000 --- a/src/calibre/utils/opensearch/osfeedparser.py +++ /dev/null @@ -1,2837 +0,0 @@ -#!/usr/bin/env python -"""Universal feed parser - -Handles RSS 0.9x, RSS 1.0, RSS 2.0, CDF, Atom 0.3, and Atom 1.0 feeds - -Visit http://feedparser.org/ for the latest version -Visit http://feedparser.org/docs/ for the latest documentation - -Required: Python 2.1 or later -Recommended: Python 2.3 or later -Recommended: CJKCodecs and iconv_codec -""" - -__version__ = "4.0.2"# + "$Revision: 1.88 $"[11:15] + "-cvs" -__license__ = """Copyright (c) 2002-2005, Mark Pilgrim, All rights reserved. - -Redistribution and use in source and binary forms, with or without modification, -are permitted provided that the following conditions are met: - -* Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimer. -* Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE -LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -POSSIBILITY OF SUCH DAMAGE.""" -__author__ = "Mark Pilgrim " -__contributors__ = ["Jason Diamond ", - "John Beimler ", - "Fazal Majid ", - "Aaron Swartz ", - "Kevin Marks "] -_debug = 0 - -# HTTP "User-Agent" header to send to servers when downloading feeds. -# If you are embedding feedparser in a larger application, you should -# change this to your application name and URL. -# Changed by John Schember -from calibre import USER_AGENT -USER_AGENT = USER_AGENT - -# HTTP "Accept" header to send to servers when downloading feeds. If you don't -# want to send an Accept header, set this to None. -ACCEPT_HEADER = "application/atom+xml,application/rdf+xml,application/rss+xml,application/x-netcdf,application/xml;q=0.9,text/xml;q=0.2,*/*;q=0.1" - -# List of preferred XML parsers, by SAX driver name. These will be tried first, -# but if they're not installed, Python will keep searching through its own list -# of pre-installed parsers until it finds one that supports everything we need. -PREFERRED_XML_PARSERS = ["drv_libxml2"] - -# If you want feedparser to automatically run HTML markup through HTML Tidy, set -# this to 1. Requires mxTidy -# or utidylib . -TIDY_MARKUP = 0 - -# List of Python interfaces for HTML Tidy, in order of preference. Only useful -# if TIDY_MARKUP = 1 -PREFERRED_TIDY_INTERFACES = ["uTidy", "mxTidy"] - -# ---------- required modules (should come with any Python distribution) ---------- -import sgmllib, re, sys, copy, urlparse, time, rfc822, types, cgi -try: - from cStringIO import StringIO as _StringIO -except: - from StringIO import StringIO as _StringIO - -# ---------- optional modules (feedparser will work without these, but with reduced functionality) ---------- - -# gzip is included with most Python distributions, but may not be available if you compiled your own -try: - import gzip -except: - gzip = None -try: - import zlib -except: - zlib = None - -# timeoutsocket allows feedparser to time out rather than hang forever on ultra-slow servers. -# Python 2.3 now has this functionality available in the standard socket library, so under -# 2.3 or later you don't need to install anything. In fact, under Python 2.4, timeoutsocket -# write all sorts of crazy errors to stderr while running my unit tests, so it's probably -# outlived its usefulness. -import socket -if hasattr(socket, 'setdefaulttimeout'): - socket.setdefaulttimeout(20) -else: - try: - import timeoutsocket # http://www.timo-tasi.org/python/timeoutsocket.py - timeoutsocket.setDefaultSocketTimeout(20) - except ImportError: - pass -import urllib, urllib2 - -# If a real XML parser is available, feedparser will attempt to use it. feedparser has -# been tested with the built-in SAX parser, PyXML, and libxml2. On platforms where the -# Python distribution does not come with an XML parser (such as Mac OS X 10.2 and some -# versions of FreeBSD), feedparser will quietly fall back on regex-based parsing. -try: - import xml.sax - xml.sax.make_parser(PREFERRED_XML_PARSERS) # test for valid parsers - from xml.sax.saxutils import escape as _xmlescape - _XML_AVAILABLE = 1 -except: - _XML_AVAILABLE = 0 - def _xmlescape(data): - data = data.replace('&', '&') - data = data.replace('>', '>') - data = data.replace('<', '<') - return data - -# base64 support for Atom feeds that contain embedded binary data -try: - import base64, binascii -except: - base64 = binascii = None - -# cjkcodecs and iconv_codec provide support for more character encodings. -# Both are available from http://cjkpython.i18n.org/ -try: - import cjkcodecs.aliases -except: - pass -try: - import iconv_codec -except: - pass - -# ---------- don't touch these ---------- -class ThingsNobodyCaresAboutButMe(Exception): pass -class CharacterEncodingOverride(ThingsNobodyCaresAboutButMe): pass -class CharacterEncodingUnknown(ThingsNobodyCaresAboutButMe): pass -class NonXMLContentType(ThingsNobodyCaresAboutButMe): pass -class UndeclaredNamespace(Exception): pass - -sgmllib.tagfind = re.compile('[a-zA-Z][-_.:a-zA-Z0-9]*') -sgmllib.special = re.compile('' % (tag, ''.join([' %s="%s"' % t for t in attrs])), escape=0) - - # match namespaces - if tag.find(':') <> -1: - prefix, suffix = tag.split(':', 1) - else: - prefix, suffix = '', tag - prefix = self.namespacemap.get(prefix, prefix) - if prefix: - prefix = prefix + '_' - - # special hack for better tracking of empty textinput/image elements in illformed feeds - if (not prefix) and tag not in ('title', 'link', 'description', 'name'): - self.intextinput = 0 - if (not prefix) and tag not in ('title', 'link', 'description', 'url', 'href', 'width', 'height'): - self.inimage = 0 - - # call special handler (if defined) or default handler - methodname = '_start_' + prefix + suffix - try: - method = getattr(self, methodname) - return method(attrsD) - except AttributeError: - return self.push(prefix + suffix, 1) - - def unknown_endtag(self, tag): - if _debug: sys.stderr.write('end %s\n' % tag) - # match namespaces - if tag.find(':') <> -1: - prefix, suffix = tag.split(':', 1) - else: - prefix, suffix = '', tag - prefix = self.namespacemap.get(prefix, prefix) - if prefix: - prefix = prefix + '_' - - # call special handler (if defined) or default handler - methodname = '_end_' + prefix + suffix - try: - method = getattr(self, methodname) - method() - except AttributeError: - self.pop(prefix + suffix) - - # track inline content - if self.incontent and self.contentparams.has_key('type') and not self.contentparams.get('type', 'xml').endswith('xml'): - # element declared itself as escaped markup, but it isn't really - self.contentparams['type'] = 'application/xhtml+xml' - if self.incontent and self.contentparams.get('type') == 'application/xhtml+xml': - tag = tag.split(':')[-1] - self.handle_data('' % tag, escape=0) - - # track xml:base and xml:lang going out of scope - if self.basestack: - self.basestack.pop() - if self.basestack and self.basestack[-1]: - self.baseuri = self.basestack[-1] - if self.langstack: - self.langstack.pop() - if self.langstack: # and (self.langstack[-1] is not None): - self.lang = self.langstack[-1] - - def handle_charref(self, ref): - # called for each character reference, e.g. for ' ', ref will be '160' - if not self.elementstack: return - ref = ref.lower() - if ref in ('34', '38', '39', '60', '62', 'x22', 'x26', 'x27', 'x3c', 'x3e'): - text = '&#%s;' % ref - else: - if ref[0] == 'x': - c = int(ref[1:], 16) - else: - c = int(ref) - text = unichr(c).encode('utf-8') - self.elementstack[-1][2].append(text) - - def handle_entityref(self, ref): - # called for each entity reference, e.g. for '©', ref will be 'copy' - if not self.elementstack: return - if _debug: sys.stderr.write('entering handle_entityref with %s\n' % ref) - if ref in ('lt', 'gt', 'quot', 'amp', 'apos'): - text = '&%s;' % ref - else: - # entity resolution graciously donated by Aaron Swartz - def name2cp(k): - import htmlentitydefs - if hasattr(htmlentitydefs, 'name2codepoint'): # requires Python 2.3 - return htmlentitydefs.name2codepoint[k] - k = htmlentitydefs.entitydefs[k] - if k.startswith('&#') and k.endswith(';'): - return int(k[2:-1]) # not in latin-1 - return ord(k) - try: name2cp(ref) - except KeyError: text = '&%s;' % ref - else: text = unichr(name2cp(ref)).encode('utf-8') - self.elementstack[-1][2].append(text) - - def handle_data(self, text, escape=1): - # called for each block of plain text, i.e. outside of any tag and - # not containing any character or entity references - if not self.elementstack: return - if escape and self.contentparams.get('type') == 'application/xhtml+xml': - text = _xmlescape(text) - self.elementstack[-1][2].append(text) - - def handle_comment(self, text): - # called for each comment, e.g. - pass - - def handle_pi(self, text): - # called for each processing instruction, e.g. - pass - - def handle_decl(self, text): - pass - - def parse_declaration(self, i): - # override internal declaration handler to handle CDATA blocks - if _debug: sys.stderr.write('entering parse_declaration\n') - if self.rawdata[i:i+9] == '', i) - if k == -1: k = len(self.rawdata) - self.handle_data(_xmlescape(self.rawdata[i+9:k]), 0) - return k+3 - else: - k = self.rawdata.find('>', i) - return k+1 - - def mapContentType(self, contentType): - contentType = contentType.lower() - if contentType == 'text': - contentType = 'text/plain' - elif contentType == 'html': - contentType = 'text/html' - elif contentType == 'xhtml': - contentType = 'application/xhtml+xml' - return contentType - - def trackNamespace(self, prefix, uri): - loweruri = uri.lower() - if (prefix, loweruri) == (None, 'http://my.netscape.com/rdf/simple/0.9/') and not self.version: - self.version = 'rss090' - if loweruri == 'http://purl.org/rss/1.0/' and not self.version: - self.version = 'rss10' - if loweruri == 'http://www.w3.org/2005/atom' and not self.version: - self.version = 'atom10' - if loweruri.find('backend.userland.com/rss') <> -1: - # match any backend.userland.com namespace - uri = 'http://backend.userland.com/rss' - loweruri = uri - if self._matchnamespaces.has_key(loweruri): - self.namespacemap[prefix] = self._matchnamespaces[loweruri] - self.namespacesInUse[self._matchnamespaces[loweruri]] = uri - else: - self.namespacesInUse[prefix or ''] = uri - - def resolveURI(self, uri): - return _urljoin(self.baseuri or '', uri) - - def decodeEntities(self, element, data): - return data - - def push(self, element, expectingText): - self.elementstack.append([element, expectingText, []]) - - def pop(self, element, stripWhitespace=1): - if not self.elementstack: return - if self.elementstack[-1][0] != element: return - - element, expectingText, pieces = self.elementstack.pop() - output = ''.join(pieces) - if stripWhitespace: - output = output.strip() - if not expectingText: return output - - # decode base64 content - if base64 and self.contentparams.get('base64', 0): - try: - output = base64.decodestring(output) - except binascii.Error: - pass - except binascii.Incomplete: - pass - - # resolve relative URIs - if (element in self.can_be_relative_uri) and output: - output = self.resolveURI(output) - - # decode entities within embedded markup - if not self.contentparams.get('base64', 0): - output = self.decodeEntities(element, output) - - # remove temporary cruft from contentparams - try: - del self.contentparams['mode'] - except KeyError: - pass - try: - del self.contentparams['base64'] - except KeyError: - pass - - # resolve relative URIs within embedded markup - if self.mapContentType(self.contentparams.get('type', 'text/html')) in self.html_types: - if element in self.can_contain_relative_uris: - output = _resolveRelativeURIs(output, self.baseuri, self.encoding) - - # sanitize embedded markup - if self.mapContentType(self.contentparams.get('type', 'text/html')) in self.html_types: - if element in self.can_contain_dangerous_markup: - output = _sanitizeHTML(output, self.encoding) - - if self.encoding and type(output) != type(u''): - try: - output = unicode(output, self.encoding) - except: - pass - - # categories/tags/keywords/whatever are handled in _end_category - if element == 'category': - return output - - # store output in appropriate place(s) - if self.inentry and not self.insource: - if element == 'content': - self.entries[-1].setdefault(element, []) - contentparams = copy.deepcopy(self.contentparams) - contentparams['value'] = output - self.entries[-1][element].append(contentparams) - elif element == 'link': - self.entries[-1][element] = output - if output: - self.entries[-1]['links'][-1]['href'] = output - else: - if element == 'description': - element = 'summary' - self.entries[-1][element] = output - if self.incontent: - contentparams = copy.deepcopy(self.contentparams) - contentparams['value'] = output - self.entries[-1][element + '_detail'] = contentparams - elif (self.infeed or self.insource) and (not self.intextinput) and (not self.inimage): - context = self._getContext() - if element == 'description': - element = 'subtitle' - context[element] = output - if element == 'link': - context['links'][-1]['href'] = output - elif self.incontent: - contentparams = copy.deepcopy(self.contentparams) - contentparams['value'] = output - context[element + '_detail'] = contentparams - return output - - def pushContent(self, tag, attrsD, defaultContentType, expectingText): - self.incontent += 1 - self.contentparams = FeedParserDict({ - 'type': self.mapContentType(attrsD.get('type', defaultContentType)), - 'language': self.lang, - 'base': self.baseuri}) - self.contentparams['base64'] = self._isBase64(attrsD, self.contentparams) - self.push(tag, expectingText) - - def popContent(self, tag): - value = self.pop(tag) - self.incontent -= 1 - self.contentparams.clear() - return value - - def _mapToStandardPrefix(self, name): - colonpos = name.find(':') - if colonpos <> -1: - prefix = name[:colonpos] - suffix = name[colonpos+1:] - prefix = self.namespacemap.get(prefix, prefix) - name = prefix + ':' + suffix - return name - - def _getAttribute(self, attrsD, name): - return attrsD.get(self._mapToStandardPrefix(name)) - - def _isBase64(self, attrsD, contentparams): - if attrsD.get('mode', '') == 'base64': - return 1 - if self.contentparams['type'].startswith('text/'): - return 0 - if self.contentparams['type'].endswith('+xml'): - return 0 - if self.contentparams['type'].endswith('/xml'): - return 0 - return 1 - - def _itsAnHrefDamnIt(self, attrsD): - href = attrsD.get('url', attrsD.get('uri', attrsD.get('href', None))) - if href: - try: - del attrsD['url'] - except KeyError: - pass - try: - del attrsD['uri'] - except KeyError: - pass - attrsD['href'] = href - return attrsD - - def _save(self, key, value): - context = self._getContext() - context.setdefault(key, value) - - def _start_rss(self, attrsD): - versionmap = {'0.91': 'rss091u', - '0.92': 'rss092', - '0.93': 'rss093', - '0.94': 'rss094'} - if not self.version: - attr_version = attrsD.get('version', '') - version = versionmap.get(attr_version) - if version: - self.version = version - elif attr_version.startswith('2.'): - self.version = 'rss20' - else: - self.version = 'rss' - - def _start_dlhottitles(self, attrsD): - self.version = 'hotrss' - - def _start_channel(self, attrsD): - self.infeed = 1 - self._cdf_common(attrsD) - _start_feedinfo = _start_channel - - def _cdf_common(self, attrsD): - if attrsD.has_key('lastmod'): - self._start_modified({}) - self.elementstack[-1][-1] = attrsD['lastmod'] - self._end_modified() - if attrsD.has_key('href'): - self._start_link({}) - self.elementstack[-1][-1] = attrsD['href'] - self._end_link() - - def _start_feed(self, attrsD): - self.infeed = 1 - versionmap = {'0.1': 'atom01', - '0.2': 'atom02', - '0.3': 'atom03'} - if not self.version: - attr_version = attrsD.get('version') - version = versionmap.get(attr_version) - if version: - self.version = version - else: - self.version = 'atom' - - def _end_channel(self): - self.infeed = 0 - _end_feed = _end_channel - - def _start_image(self, attrsD): - self.inimage = 1 - self.push('image', 0) - context = self._getContext() - context.setdefault('image', FeedParserDict()) - - def _end_image(self): - self.pop('image') - self.inimage = 0 - - def _start_textinput(self, attrsD): - self.intextinput = 1 - self.push('textinput', 0) - context = self._getContext() - context.setdefault('textinput', FeedParserDict()) - _start_textInput = _start_textinput - - def _end_textinput(self): - self.pop('textinput') - self.intextinput = 0 - _end_textInput = _end_textinput - - def _start_author(self, attrsD): - self.inauthor = 1 - self.push('author', 1) - _start_managingeditor = _start_author - _start_dc_author = _start_author - _start_dc_creator = _start_author - _start_itunes_author = _start_author - - def _end_author(self): - self.pop('author') - self.inauthor = 0 - self._sync_author_detail() - _end_managingeditor = _end_author - _end_dc_author = _end_author - _end_dc_creator = _end_author - _end_itunes_author = _end_author - - def _start_itunes_owner(self, attrsD): - self.inpublisher = 1 - self.push('publisher', 0) - - def _end_itunes_owner(self): - self.pop('publisher') - self.inpublisher = 0 - self._sync_author_detail('publisher') - - def _start_contributor(self, attrsD): - self.incontributor = 1 - context = self._getContext() - context.setdefault('contributors', []) - context['contributors'].append(FeedParserDict()) - self.push('contributor', 0) - - def _end_contributor(self): - self.pop('contributor') - self.incontributor = 0 - - def _start_dc_contributor(self, attrsD): - self.incontributor = 1 - context = self._getContext() - context.setdefault('contributors', []) - context['contributors'].append(FeedParserDict()) - self.push('name', 0) - - def _end_dc_contributor(self): - self._end_name() - self.incontributor = 0 - - def _start_name(self, attrsD): - self.push('name', 0) - _start_itunes_name = _start_name - - def _end_name(self): - value = self.pop('name') - if self.inpublisher: - self._save_author('name', value, 'publisher') - elif self.inauthor: - self._save_author('name', value) - elif self.incontributor: - self._save_contributor('name', value) - elif self.intextinput: - context = self._getContext() - context['textinput']['name'] = value - _end_itunes_name = _end_name - - def _start_width(self, attrsD): - self.push('width', 0) - - def _end_width(self): - value = self.pop('width') - try: - value = int(value) - except: - value = 0 - if self.inimage: - context = self._getContext() - context['image']['width'] = value - - def _start_height(self, attrsD): - self.push('height', 0) - - def _end_height(self): - value = self.pop('height') - try: - value = int(value) - except: - value = 0 - if self.inimage: - context = self._getContext() - context['image']['height'] = value - - def _start_url(self, attrsD): - self.push('href', 1) - _start_homepage = _start_url - _start_uri = _start_url - - def _end_url(self): - value = self.pop('href') - if self.inauthor: - self._save_author('href', value) - elif self.incontributor: - self._save_contributor('href', value) - elif self.inimage: - context = self._getContext() - context['image']['href'] = value - elif self.intextinput: - context = self._getContext() - context['textinput']['link'] = value - _end_homepage = _end_url - _end_uri = _end_url - - def _start_email(self, attrsD): - self.push('email', 0) - _start_itunes_email = _start_email - - def _end_email(self): - value = self.pop('email') - if self.inpublisher: - self._save_author('email', value, 'publisher') - elif self.inauthor: - self._save_author('email', value) - elif self.incontributor: - self._save_contributor('email', value) - _end_itunes_email = _end_email - - def _getContext(self): - if self.insource: - context = self.sourcedata - elif self.inentry: - context = self.entries[-1] - else: - context = self.feeddata - return context - - def _save_author(self, key, value, prefix='author'): - context = self._getContext() - context.setdefault(prefix + '_detail', FeedParserDict()) - context[prefix + '_detail'][key] = value - self._sync_author_detail() - - def _save_contributor(self, key, value): - context = self._getContext() - context.setdefault('contributors', [FeedParserDict()]) - context['contributors'][-1][key] = value - - def _sync_author_detail(self, key='author'): - context = self._getContext() - detail = context.get('%s_detail' % key) - if detail: - name = detail.get('name') - email = detail.get('email') - if name and email: - context[key] = '%s (%s)' % (name, email) - elif name: - context[key] = name - elif email: - context[key] = email - else: - author = context.get(key) - if not author: return - emailmatch = re.search(r'''(([a-zA-Z0-9\_\-\.\+]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?))''', author) - if not emailmatch: return - email = emailmatch.group(0) - # probably a better way to do the following, but it passes all the tests - author = author.replace(email, '') - author = author.replace('()', '') - author = author.strip() - if author and (author[0] == '('): - author = author[1:] - if author and (author[-1] == ')'): - author = author[:-1] - author = author.strip() - context.setdefault('%s_detail' % key, FeedParserDict()) - context['%s_detail' % key]['name'] = author - context['%s_detail' % key]['email'] = email - - def _start_subtitle(self, attrsD): - self.pushContent('subtitle', attrsD, 'text/plain', 1) - _start_tagline = _start_subtitle - _start_itunes_subtitle = _start_subtitle - - def _end_subtitle(self): - self.popContent('subtitle') - _end_tagline = _end_subtitle - _end_itunes_subtitle = _end_subtitle - - def _start_rights(self, attrsD): - self.pushContent('rights', attrsD, 'text/plain', 1) - _start_dc_rights = _start_rights - _start_copyright = _start_rights - - def _end_rights(self): - self.popContent('rights') - _end_dc_rights = _end_rights - _end_copyright = _end_rights - - def _start_item(self, attrsD): - self.entries.append(FeedParserDict()) - self.push('item', 0) - self.inentry = 1 - self.guidislink = 0 - id = self._getAttribute(attrsD, 'rdf:about') - if id: - context = self._getContext() - context['id'] = id - self._cdf_common(attrsD) - _start_entry = _start_item - _start_product = _start_item - - def _end_item(self): - self.pop('item') - self.inentry = 0 - _end_entry = _end_item - - def _start_dc_language(self, attrsD): - self.push('language', 1) - _start_language = _start_dc_language - - def _end_dc_language(self): - self.lang = self.pop('language') - _end_language = _end_dc_language - - def _start_dc_publisher(self, attrsD): - self.push('publisher', 1) - _start_webmaster = _start_dc_publisher - - def _end_dc_publisher(self): - self.pop('publisher') - self._sync_author_detail('publisher') - _end_webmaster = _end_dc_publisher - - def _start_published(self, attrsD): - self.push('published', 1) - _start_dcterms_issued = _start_published - _start_issued = _start_published - - def _end_published(self): - value = self.pop('published') - self._save('published_parsed', _parse_date(value)) - _end_dcterms_issued = _end_published - _end_issued = _end_published - - def _start_updated(self, attrsD): - self.push('updated', 1) - _start_modified = _start_updated - _start_dcterms_modified = _start_updated - _start_pubdate = _start_updated - _start_dc_date = _start_updated - - def _end_updated(self): - value = self.pop('updated') - parsed_value = _parse_date(value) - self._save('updated_parsed', parsed_value) - _end_modified = _end_updated - _end_dcterms_modified = _end_updated - _end_pubdate = _end_updated - _end_dc_date = _end_updated - - def _start_created(self, attrsD): - self.push('created', 1) - _start_dcterms_created = _start_created - - def _end_created(self): - value = self.pop('created') - self._save('created_parsed', _parse_date(value)) - _end_dcterms_created = _end_created - - def _start_expirationdate(self, attrsD): - self.push('expired', 1) - - def _end_expirationdate(self): - self._save('expired_parsed', _parse_date(self.pop('expired'))) - - def _start_cc_license(self, attrsD): - self.push('license', 1) - value = self._getAttribute(attrsD, 'rdf:resource') - if value: - self.elementstack[-1][2].append(value) - self.pop('license') - - def _start_creativecommons_license(self, attrsD): - self.push('license', 1) - - def _end_creativecommons_license(self): - self.pop('license') - - def _addTag(self, term, scheme, label): - context = self._getContext() - tags = context.setdefault('tags', []) - if (not term) and (not scheme) and (not label): return - value = FeedParserDict({'term': term, 'scheme': scheme, 'label': label}) - if value not in tags: - tags.append(FeedParserDict({'term': term, 'scheme': scheme, 'label': label})) - - def _start_category(self, attrsD): - if _debug: sys.stderr.write('entering _start_category with %s\n' % repr(attrsD)) - term = attrsD.get('term') - scheme = attrsD.get('scheme', attrsD.get('domain')) - label = attrsD.get('label') - self._addTag(term, scheme, label) - self.push('category', 1) - _start_dc_subject = _start_category - _start_keywords = _start_category - - def _end_itunes_keywords(self): - for term in self.pop('itunes_keywords').split(): - self._addTag(term, 'http://www.itunes.com/', None) - - def _start_itunes_category(self, attrsD): - self._addTag(attrsD.get('text'), 'http://www.itunes.com/', None) - self.push('category', 1) - - def _end_category(self): - value = self.pop('category') - if not value: return - context = self._getContext() - tags = context['tags'] - if value and len(tags) and not tags[-1]['term']: - tags[-1]['term'] = value - else: - self._addTag(value, None, None) - _end_dc_subject = _end_category - _end_keywords = _end_category - _end_itunes_category = _end_category - - def _start_cloud(self, attrsD): - self._getContext()['cloud'] = FeedParserDict(attrsD) - - def _start_link(self, attrsD): - attrsD.setdefault('rel', 'alternate') - attrsD.setdefault('type', 'text/html') - attrsD = self._itsAnHrefDamnIt(attrsD) - if attrsD.has_key('href'): - attrsD['href'] = self.resolveURI(attrsD['href']) - expectingText = self.infeed or self.inentry or self.insource - context = self._getContext() - context.setdefault('links', []) - context['links'].append(FeedParserDict(attrsD)) - if attrsD['rel'] == 'enclosure': - self._start_enclosure(attrsD) - if attrsD.has_key('href'): - expectingText = 0 - if (attrsD.get('rel') == 'alternate') and (self.mapContentType(attrsD.get('type')) in self.html_types): - context['link'] = attrsD['href'] - else: - self.push('link', expectingText) - _start_producturl = _start_link - - def _end_link(self): - value = self.pop('link') - context = self._getContext() - if self.intextinput: - context['textinput']['link'] = value - if self.inimage: - context['image']['link'] = value - _end_producturl = _end_link - - def _start_guid(self, attrsD): - self.guidislink = (attrsD.get('ispermalink', 'true') == 'true') - self.push('id', 1) - - def _end_guid(self): - value = self.pop('id') - self._save('guidislink', self.guidislink and not self._getContext().has_key('link')) - if self.guidislink: - # guid acts as link, but only if 'ispermalink' is not present or is 'true', - # and only if the item doesn't already have a link element - self._save('link', value) - - def _start_title(self, attrsD): - self.pushContent('title', attrsD, 'text/plain', self.infeed or self.inentry or self.insource) - _start_dc_title = _start_title - _start_media_title = _start_title - - def _end_title(self): - value = self.popContent('title') - context = self._getContext() - if self.intextinput: - context['textinput']['title'] = value - elif self.inimage: - context['image']['title'] = value - _end_dc_title = _end_title - _end_media_title = _end_title - - def _start_description(self, attrsD): - context = self._getContext() - if context.has_key('summary'): - self._summaryKey = 'content' - self._start_content(attrsD) - else: - self.pushContent('description', attrsD, 'text/html', self.infeed or self.inentry or self.insource) - - def _start_abstract(self, attrsD): - self.pushContent('description', attrsD, 'text/plain', self.infeed or self.inentry or self.insource) - - def _end_description(self): - if self._summaryKey == 'content': - self._end_content() - else: - value = self.popContent('description') - context = self._getContext() - if self.intextinput: - context['textinput']['description'] = value - elif self.inimage: - context['image']['description'] = value - self._summaryKey = None - _end_abstract = _end_description - - def _start_info(self, attrsD): - self.pushContent('info', attrsD, 'text/plain', 1) - _start_feedburner_browserfriendly = _start_info - - def _end_info(self): - self.popContent('info') - _end_feedburner_browserfriendly = _end_info - - def _start_generator(self, attrsD): - if attrsD: - attrsD = self._itsAnHrefDamnIt(attrsD) - if attrsD.has_key('href'): - attrsD['href'] = self.resolveURI(attrsD['href']) - self._getContext()['generator_detail'] = FeedParserDict(attrsD) - self.push('generator', 1) - - def _end_generator(self): - value = self.pop('generator') - context = self._getContext() - if context.has_key('generator_detail'): - context['generator_detail']['name'] = value - - def _start_admin_generatoragent(self, attrsD): - self.push('generator', 1) - value = self._getAttribute(attrsD, 'rdf:resource') - if value: - self.elementstack[-1][2].append(value) - self.pop('generator') - self._getContext()['generator_detail'] = FeedParserDict({'href': value}) - - def _start_admin_errorreportsto(self, attrsD): - self.push('errorreportsto', 1) - value = self._getAttribute(attrsD, 'rdf:resource') - if value: - self.elementstack[-1][2].append(value) - self.pop('errorreportsto') - - def _start_summary(self, attrsD): - context = self._getContext() - if context.has_key('summary'): - self._summaryKey = 'content' - self._start_content(attrsD) - else: - self._summaryKey = 'summary' - self.pushContent(self._summaryKey, attrsD, 'text/plain', 1) - _start_itunes_summary = _start_summary - - def _end_summary(self): - if self._summaryKey == 'content': - self._end_content() - else: - self.popContent(self._summaryKey or 'summary') - self._summaryKey = None - _end_itunes_summary = _end_summary - - def _start_enclosure(self, attrsD): - attrsD = self._itsAnHrefDamnIt(attrsD) - self._getContext().setdefault('enclosures', []).append(FeedParserDict(attrsD)) - href = attrsD.get('href') - if href: - context = self._getContext() - if not context.get('id'): - context['id'] = href - - def _start_source(self, attrsD): - self.insource = 1 - - def _end_source(self): - self.insource = 0 - self._getContext()['source'] = copy.deepcopy(self.sourcedata) - self.sourcedata.clear() - - def _start_content(self, attrsD): - self.pushContent('content', attrsD, 'text/plain', 1) - src = attrsD.get('src') - if src: - self.contentparams['src'] = src - self.push('content', 1) - - def _start_prodlink(self, attrsD): - self.pushContent('content', attrsD, 'text/html', 1) - - def _start_body(self, attrsD): - self.pushContent('content', attrsD, 'application/xhtml+xml', 1) - _start_xhtml_body = _start_body - - def _start_content_encoded(self, attrsD): - self.pushContent('content', attrsD, 'text/html', 1) - _start_fullitem = _start_content_encoded - - def _end_content(self): - copyToDescription = self.mapContentType(self.contentparams.get('type')) in (['text/plain'] + self.html_types) - value = self.popContent('content') - if copyToDescription: - self._save('description', value) - _end_body = _end_content - _end_xhtml_body = _end_content - _end_content_encoded = _end_content - _end_fullitem = _end_content - _end_prodlink = _end_content - - def _start_itunes_image(self, attrsD): - self.push('itunes_image', 0) - self._getContext()['image'] = FeedParserDict({'href': attrsD.get('href')}) - _start_itunes_link = _start_itunes_image - - def _end_itunes_block(self): - value = self.pop('itunes_block', 0) - self._getContext()['itunes_block'] = (value == 'yes') and 1 or 0 - - def _end_itunes_explicit(self): - value = self.pop('itunes_explicit', 0) - self._getContext()['itunes_explicit'] = (value == 'yes') and 1 or 0 - -if _XML_AVAILABLE: - class _StrictFeedParser(_FeedParserMixin, xml.sax.handler.ContentHandler): - def __init__(self, baseuri, baselang, encoding): - if _debug: sys.stderr.write('trying StrictFeedParser\n') - xml.sax.handler.ContentHandler.__init__(self) - _FeedParserMixin.__init__(self, baseuri, baselang, encoding) - self.bozo = 0 - self.exc = None - - def startPrefixMapping(self, prefix, uri): - self.trackNamespace(prefix, uri) - - def startElementNS(self, name, qname, attrs): - namespace, localname = name - lowernamespace = str(namespace or '').lower() - if lowernamespace.find('backend.userland.com/rss') <> -1: - # match any backend.userland.com namespace - namespace = 'http://backend.userland.com/rss' - lowernamespace = namespace - if qname and qname.find(':') > 0: - givenprefix = qname.split(':')[0] - else: - givenprefix = None - prefix = self._matchnamespaces.get(lowernamespace, givenprefix) - if givenprefix and (prefix == None or (prefix == '' and lowernamespace == '')) and not self.namespacesInUse.has_key(givenprefix): - raise UndeclaredNamespace, "'%s' is not associated with a namespace" % givenprefix - if prefix: - localname = prefix + ':' + localname - localname = str(localname).lower() - if _debug: sys.stderr.write('startElementNS: qname = %s, namespace = %s, givenprefix = %s, prefix = %s, attrs = %s, localname = %s\n' % (qname, namespace, givenprefix, prefix, attrs.items(), localname)) - - # qname implementation is horribly broken in Python 2.1 (it - # doesn't report any), and slightly broken in Python 2.2 (it - # doesn't report the xml: namespace). So we match up namespaces - # with a known list first, and then possibly override them with - # the qnames the SAX parser gives us (if indeed it gives us any - # at all). Thanks to MatejC for helping me test this and - # tirelessly telling me that it didn't work yet. - attrsD = {} - for (namespace, attrlocalname), attrvalue in attrs._attrs.items(): - lowernamespace = (namespace or '').lower() - prefix = self._matchnamespaces.get(lowernamespace, '') - if prefix: - attrlocalname = prefix + ':' + attrlocalname - attrsD[str(attrlocalname).lower()] = attrvalue - for qname in attrs.getQNames(): - attrsD[str(qname).lower()] = attrs.getValueByQName(qname) - self.unknown_starttag(localname, attrsD.items()) - - def characters(self, text): - self.handle_data(text) - - def endElementNS(self, name, qname): - namespace, localname = name - lowernamespace = str(namespace or '').lower() - if qname and qname.find(':') > 0: - givenprefix = qname.split(':')[0] - else: - givenprefix = '' - prefix = self._matchnamespaces.get(lowernamespace, givenprefix) - if prefix: - localname = prefix + ':' + localname - localname = str(localname).lower() - self.unknown_endtag(localname) - - def error(self, exc): - self.bozo = 1 - self.exc = exc - - def fatalError(self, exc): - self.error(exc) - raise exc - -class _BaseHTMLProcessor(sgmllib.SGMLParser): - elements_no_end_tag = ['area', 'base', 'basefont', 'br', 'col', 'frame', 'hr', - 'img', 'input', 'isindex', 'link', 'meta', 'param'] - - def __init__(self, encoding): - self.encoding = encoding - if _debug: sys.stderr.write('entering BaseHTMLProcessor, encoding=%s\n' % self.encoding) - sgmllib.SGMLParser.__init__(self) - - def reset(self): - self.pieces = [] - sgmllib.SGMLParser.reset(self) - - def _shorttag_replace(self, match): - tag = match.group(1) - if tag in self.elements_no_end_tag: - return '<' + tag + ' />' - else: - return '<' + tag + '>' - - def feed(self, data): - data = re.compile(r'', self._shorttag_replace, data) - data = data.replace(''', "'") - data = data.replace('"', '"') - if self.encoding and type(data) == type(u''): - data = data.encode(self.encoding) - sgmllib.SGMLParser.feed(self, data) - - def normalize_attrs(self, attrs): - # utility method to be called by descendants - attrs = [(k.lower(), v) for k, v in attrs] - attrs = [(k, k in ('rel', 'type') and v.lower() or v) for k, v in attrs] - return attrs - - def unknown_starttag(self, tag, attrs): - # called for each start tag - # attrs is a list of (attr, value) tuples - # e.g. for 
, tag='pre', attrs=[('class', 'screen')]
-        if _debug: sys.stderr.write('_BaseHTMLProcessor, unknown_starttag, tag=%s\n' % tag)
-        uattrs = []
-        # thanks to Kevin Marks for this breathtaking hack to deal with (valid) high-bit attribute values in UTF-8 feeds
-        for key, value in attrs:
-            if type(value) != type(u''):
-                value = unicode(value, self.encoding)
-            uattrs.append((unicode(key, self.encoding), value))
-        strattrs = u''.join([u' %s="%s"' % (key, value) for key, value in uattrs]).encode(self.encoding)
-        if tag in self.elements_no_end_tag:
-            self.pieces.append('<%(tag)s%(strattrs)s />' % locals())
-        else:
-            self.pieces.append('<%(tag)s%(strattrs)s>' % locals())
-
-    def unknown_endtag(self, tag):
-        # called for each end tag, e.g. for
, tag will be 'pre' - # Reconstruct the original end tag. - if tag not in self.elements_no_end_tag: - self.pieces.append("" % locals()) - - def handle_charref(self, ref): - # called for each character reference, e.g. for ' ', ref will be '160' - # Reconstruct the original character reference. - self.pieces.append('&#%(ref)s;' % locals()) - - def handle_entityref(self, ref): - # called for each entity reference, e.g. for '©', ref will be 'copy' - # Reconstruct the original entity reference. - self.pieces.append('&%(ref)s;' % locals()) - - def handle_data(self, text): - # called for each block of plain text, i.e. outside of any tag and - # not containing any character or entity references - # Store the original text verbatim. - if _debug: sys.stderr.write('_BaseHTMLProcessor, handle_text, text=%s\n' % text) - self.pieces.append(text) - - def handle_comment(self, text): - # called for each HTML comment, e.g. - # Reconstruct the original comment. - self.pieces.append('' % locals()) - - def handle_pi(self, text): - # called for each processing instruction, e.g. - # Reconstruct original processing instruction. - self.pieces.append('' % locals()) - - def handle_decl(self, text): - # called for the DOCTYPE, if present, e.g. - # - # Reconstruct original DOCTYPE - self.pieces.append('' % locals()) - - _new_declname_match = re.compile(r'[a-zA-Z][-_.a-zA-Z0-9:]*\s*').match - def _scan_name(self, i, declstartpos): - rawdata = self.rawdata - n = len(rawdata) - if i == n: - return None, -1 - m = self._new_declname_match(rawdata, i) - if m: - s = m.group() - name = s.strip() - if (i + len(s)) == n: - return None, -1 # end of buffer - return name.lower(), m.end() - else: - self.handle_data(rawdata) -# self.updatepos(declstartpos, i) - return None, -1 - - def output(self): - '''Return processed HTML as a single string''' - return ''.join([str(p) for p in self.pieces]) - -class _LooseFeedParser(_FeedParserMixin, _BaseHTMLProcessor): - def __init__(self, baseuri, baselang, encoding): - sgmllib.SGMLParser.__init__(self) - _FeedParserMixin.__init__(self, baseuri, baselang, encoding) - - def decodeEntities(self, element, data): - data = data.replace('<', '<') - data = data.replace('<', '<') - data = data.replace('>', '>') - data = data.replace('>', '>') - data = data.replace('&', '&') - data = data.replace('&', '&') - data = data.replace('"', '"') - data = data.replace('"', '"') - data = data.replace(''', ''') - data = data.replace(''', ''') - if self.contentparams.has_key('type') and not self.contentparams.get('type', 'xml').endswith('xml'): - data = data.replace('<', '<') - data = data.replace('>', '>') - data = data.replace('&', '&') - data = data.replace('"', '"') - data = data.replace(''', "'") - return data - -class _RelativeURIResolver(_BaseHTMLProcessor): - relative_uris = [('a', 'href'), - ('applet', 'codebase'), - ('area', 'href'), - ('blockquote', 'cite'), - ('body', 'background'), - ('del', 'cite'), - ('form', 'action'), - ('frame', 'longdesc'), - ('frame', 'src'), - ('iframe', 'longdesc'), - ('iframe', 'src'), - ('head', 'profile'), - ('img', 'longdesc'), - ('img', 'src'), - ('img', 'usemap'), - ('input', 'src'), - ('input', 'usemap'), - ('ins', 'cite'), - ('link', 'href'), - ('object', 'classid'), - ('object', 'codebase'), - ('object', 'data'), - ('object', 'usemap'), - ('q', 'cite'), - ('script', 'src')] - - def __init__(self, baseuri, encoding): - _BaseHTMLProcessor.__init__(self, encoding) - self.baseuri = baseuri - - def resolveURI(self, uri): - return _urljoin(self.baseuri, uri) - - def unknown_starttag(self, tag, attrs): - attrs = self.normalize_attrs(attrs) - attrs = [(key, ((tag, key) in self.relative_uris) and self.resolveURI(value) or value) for key, value in attrs] - _BaseHTMLProcessor.unknown_starttag(self, tag, attrs) - -def _resolveRelativeURIs(htmlSource, baseURI, encoding): - if _debug: sys.stderr.write('entering _resolveRelativeURIs\n') - p = _RelativeURIResolver(baseURI, encoding) - p.feed(htmlSource) - return p.output() - -class _HTMLSanitizer(_BaseHTMLProcessor): - acceptable_elements = ['a', 'abbr', 'acronym', 'address', 'area', 'b', 'big', - 'blockquote', 'br', 'button', 'caption', 'center', 'cite', 'code', 'col', - 'colgroup', 'dd', 'del', 'dfn', 'dir', 'div', 'dl', 'dt', 'em', 'fieldset', - 'font', 'form', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'input', - 'ins', 'kbd', 'label', 'legend', 'li', 'map', 'menu', 'ol', 'optgroup', - 'option', 'p', 'pre', 'q', 's', 'samp', 'select', 'small', 'span', 'strike', - 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'textarea', 'tfoot', 'th', - 'thead', 'tr', 'tt', 'u', 'ul', 'var'] - - acceptable_attributes = ['abbr', 'accept', 'accept-charset', 'accesskey', - 'action', 'align', 'alt', 'axis', 'border', 'cellpadding', 'cellspacing', - 'char', 'charoff', 'charset', 'checked', 'cite', 'class', 'clear', 'cols', - 'colspan', 'color', 'compact', 'coords', 'datetime', 'dir', 'disabled', - 'enctype', 'for', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', - 'id', 'ismap', 'label', 'lang', 'longdesc', 'maxlength', 'media', 'method', - 'multiple', 'name', 'nohref', 'noshade', 'nowrap', 'prompt', 'readonly', - 'rel', 'rev', 'rows', 'rowspan', 'rules', 'scope', 'selected', 'shape', 'size', - 'span', 'src', 'start', 'summary', 'tabindex', 'target', 'title', 'type', - 'usemap', 'valign', 'value', 'vspace', 'width'] - - unacceptable_elements_with_end_tag = ['script', 'applet'] - - def reset(self): - _BaseHTMLProcessor.reset(self) - self.unacceptablestack = 0 - - def unknown_starttag(self, tag, attrs): - if not tag in self.acceptable_elements: - if tag in self.unacceptable_elements_with_end_tag: - self.unacceptablestack += 1 - return - attrs = self.normalize_attrs(attrs) - attrs = [(key, value) for key, value in attrs if key in self.acceptable_attributes] - _BaseHTMLProcessor.unknown_starttag(self, tag, attrs) - - def unknown_endtag(self, tag): - if not tag in self.acceptable_elements: - if tag in self.unacceptable_elements_with_end_tag: - self.unacceptablestack -= 1 - return - _BaseHTMLProcessor.unknown_endtag(self, tag) - - def handle_pi(self, text): - pass - - def handle_decl(self, text): - pass - - def handle_data(self, text): - if not self.unacceptablestack: - _BaseHTMLProcessor.handle_data(self, text) - -def _sanitizeHTML(htmlSource, encoding): - p = _HTMLSanitizer(encoding) - p.feed(htmlSource) - data = p.output() - if TIDY_MARKUP: - # loop through list of preferred Tidy interfaces looking for one that's installed, - # then set up a common _tidy function to wrap the interface-specific API. - _tidy = None - for tidy_interface in PREFERRED_TIDY_INTERFACES: - try: - if tidy_interface == "uTidy": - from tidy import parseString as _utidy - def _tidy(data, **kwargs): - return str(_utidy(data, **kwargs)) - break - elif tidy_interface == "mxTidy": - from mx.Tidy import Tidy as _mxtidy - def _tidy(data, **kwargs): - nerrors, nwarnings, data, errordata = _mxtidy.tidy(data, **kwargs) - return data - break - except: - pass - if _tidy: - utf8 = type(data) == type(u'') - if utf8: - data = data.encode('utf-8') - data = _tidy(data, output_xhtml=1, numeric_entities=1, wrap=0, char_encoding="utf8") - if utf8: - data = unicode(data, 'utf-8') - if data.count(''): - data = data.split('>', 1)[1] - if data.count('= '2.3.3' - assert base64 != None - user, passw = base64.decodestring(req.headers['Authorization'].split(' ')[1]).split(':') - realm = re.findall('realm="([^"]*)"', headers['WWW-Authenticate'])[0] - self.add_password(realm, host, user, passw) - retry = self.http_error_auth_reqed('www-authenticate', host, req, headers) - self.reset_retry_count() - return retry - except: - return self.http_error_default(req, fp, code, msg, headers) - -def _open_resource(url_file_stream_or_string, etag, modified, agent, referrer, handlers): - """URL, filename, or string --> stream - - This function lets you define parsers that take any input source - (URL, pathname to local or network file, or actual data as a string) - and deal with it in a uniform manner. Returned object is guaranteed - to have all the basic stdio read methods (read, readline, readlines). - Just .close() the object when you're done with it. - - If the etag argument is supplied, it will be used as the value of an - If-None-Match request header. - - If the modified argument is supplied, it must be a tuple of 9 integers - as returned by gmtime() in the standard Python time module. This MUST - be in GMT (Greenwich Mean Time). The formatted date/time will be used - as the value of an If-Modified-Since request header. - - If the agent argument is supplied, it will be used as the value of a - User-Agent request header. - - If the referrer argument is supplied, it will be used as the value of a - Referer[sic] request header. - - If handlers is supplied, it is a list of handlers used to build a - urllib2 opener. - """ - - if hasattr(url_file_stream_or_string, 'read'): - return url_file_stream_or_string - - if url_file_stream_or_string == '-': - return sys.stdin - - if urlparse.urlparse(url_file_stream_or_string)[0] in ('http', 'https', 'ftp'): - if not agent: - agent = USER_AGENT - # test for inline user:password for basic auth - auth = None - if base64: - urltype, rest = urllib.splittype(url_file_stream_or_string) - realhost, rest = urllib.splithost(rest) - if realhost: - user_passwd, realhost = urllib.splituser(realhost) - if user_passwd: - url_file_stream_or_string = '%s://%s%s' % (urltype, realhost, rest) - auth = base64.encodestring(user_passwd).strip() - # try to open with urllib2 (to use optional headers) - request = urllib2.Request(url_file_stream_or_string) - request.add_header('User-Agent', agent) - if etag: - request.add_header('If-None-Match', etag) - if modified: - # format into an RFC 1123-compliant timestamp. We can't use - # time.strftime() since the %a and %b directives can be affected - # by the current locale, but RFC 2616 states that dates must be - # in English. - short_weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'] - months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'] - request.add_header('If-Modified-Since', '%s, %02d %s %04d %02d:%02d:%02d GMT' % (short_weekdays[modified[6]], modified[2], months[modified[1] - 1], modified[0], modified[3], modified[4], modified[5])) - if referrer: - request.add_header('Referer', referrer) - if gzip and zlib: - request.add_header('Accept-encoding', 'gzip, deflate') - elif gzip: - request.add_header('Accept-encoding', 'gzip') - elif zlib: - request.add_header('Accept-encoding', 'deflate') - else: - request.add_header('Accept-encoding', '') - if auth: - request.add_header('Authorization', 'Basic %s' % auth) - if ACCEPT_HEADER: - request.add_header('Accept', ACCEPT_HEADER) - request.add_header('A-IM', 'feed') # RFC 3229 support - opener = apply(urllib2.build_opener, tuple([_FeedURLHandler()] + handlers)) - opener.addheaders = [] # RMK - must clear so we only send our custom User-Agent - try: - return opener.open(request) - finally: - opener.close() # JohnD - - # try to open with native open function (if url_file_stream_or_string is a filename) - try: - return open(url_file_stream_or_string) - except: - pass - - # treat url_file_stream_or_string as string - return _StringIO(str(url_file_stream_or_string)) - -_date_handlers = [] -def registerDateHandler(func): - '''Register a date handler function (takes string, returns 9-tuple date in GMT)''' - _date_handlers.insert(0, func) - -# ISO-8601 date parsing routines written by Fazal Majid. -# The ISO 8601 standard is very convoluted and irregular - a full ISO 8601 -# parser is beyond the scope of feedparser and would be a worthwhile addition -# to the Python library. -# A single regular expression cannot parse ISO 8601 date formats into groups -# as the standard is highly irregular (for instance is 030104 2003-01-04 or -# 0301-04-01), so we use templates instead. -# Please note the order in templates is significant because we need a -# greedy match. -_iso8601_tmpl = ['YYYY-?MM-?DD', 'YYYY-MM', 'YYYY-?OOO', - 'YY-?MM-?DD', 'YY-?OOO', 'YYYY', - '-YY-?MM', '-OOO', '-YY', - '--MM-?DD', '--MM', - '---DD', - 'CC', ''] -_iso8601_re = [ - tmpl.replace( - 'YYYY', r'(?P\d{4})').replace( - 'YY', r'(?P\d\d)').replace( - 'MM', r'(?P[01]\d)').replace( - 'DD', r'(?P[0123]\d)').replace( - 'OOO', r'(?P[0123]\d\d)').replace( - 'CC', r'(?P\d\d$)') - + r'(T?(?P\d{2}):(?P\d{2})' - + r'(:(?P\d{2}))?' - + r'(?P[+-](?P\d{2})(:(?P\d{2}))?|Z)?)?' - for tmpl in _iso8601_tmpl] -del tmpl -_iso8601_matches = [re.compile(regex).match for regex in _iso8601_re] -del regex -def _parse_date_iso8601(dateString): - '''Parse a variety of ISO-8601-compatible formats like 20040105''' - m = None - for _iso8601_match in _iso8601_matches: - m = _iso8601_match(dateString) - if m: break - if not m: return - if m.span() == (0, 0): return - params = m.groupdict() - ordinal = params.get('ordinal', 0) - if ordinal: - ordinal = int(ordinal) - else: - ordinal = 0 - year = params.get('year', '--') - if not year or year == '--': - year = time.gmtime()[0] - elif len(year) == 2: - # ISO 8601 assumes current century, i.e. 93 -> 2093, NOT 1993 - year = 100 * int(time.gmtime()[0] / 100) + int(year) - else: - year = int(year) - month = params.get('month', '-') - if not month or month == '-': - # ordinals are NOT normalized by mktime, we simulate them - # by setting month=1, day=ordinal - if ordinal: - month = 1 - else: - month = time.gmtime()[1] - month = int(month) - day = params.get('day', 0) - if not day: - # see above - if ordinal: - day = ordinal - elif params.get('century', 0) or \ - params.get('year', 0) or params.get('month', 0): - day = 1 - else: - day = time.gmtime()[2] - else: - day = int(day) - # special case of the century - is the first year of the 21st century - # 2000 or 2001 ? The debate goes on... - if 'century' in params.keys(): - year = (int(params['century']) - 1) * 100 + 1 - # in ISO 8601 most fields are optional - for field in ['hour', 'minute', 'second', 'tzhour', 'tzmin']: - if not params.get(field, None): - params[field] = 0 - hour = int(params.get('hour', 0)) - minute = int(params.get('minute', 0)) - second = int(params.get('second', 0)) - # weekday is normalized by mktime(), we can ignore it - weekday = 0 - # daylight savings is complex, but not needed for feedparser's purposes - # as time zones, if specified, include mention of whether it is active - # (e.g. PST vs. PDT, CET). Using -1 is implementation-dependent and - # and most implementations have DST bugs - daylight_savings_flag = 0 - tm = [year, month, day, hour, minute, second, weekday, - ordinal, daylight_savings_flag] - # ISO 8601 time zone adjustments - tz = params.get('tz') - if tz and tz != 'Z': - if tz[0] == '-': - tm[3] += int(params.get('tzhour', 0)) - tm[4] += int(params.get('tzmin', 0)) - elif tz[0] == '+': - tm[3] -= int(params.get('tzhour', 0)) - tm[4] -= int(params.get('tzmin', 0)) - else: - return None - # Python's time.mktime() is a wrapper around the ANSI C mktime(3c) - # which is guaranteed to normalize d/m/y/h/m/s. - # Many implementations have bugs, but we'll pretend they don't. - return time.localtime(time.mktime(tm)) -registerDateHandler(_parse_date_iso8601) - -# 8-bit date handling routines written by ytrewq1. -_korean_year = u'\ub144' # b3e2 in euc-kr -_korean_month = u'\uc6d4' # bff9 in euc-kr -_korean_day = u'\uc77c' # c0cf in euc-kr -_korean_am = u'\uc624\uc804' # bfc0 c0fc in euc-kr -_korean_pm = u'\uc624\ud6c4' # bfc0 c8c4 in euc-kr - -_korean_onblog_date_re = \ - re.compile('(\d{4})%s\s+(\d{2})%s\s+(\d{2})%s\s+(\d{2}):(\d{2}):(\d{2})' % \ - (_korean_year, _korean_month, _korean_day)) -_korean_nate_date_re = \ - re.compile(u'(\d{4})-(\d{2})-(\d{2})\s+(%s|%s)\s+(\d{,2}):(\d{,2}):(\d{,2})' % \ - (_korean_am, _korean_pm)) -def _parse_date_onblog(dateString): - '''Parse a string according to the OnBlog 8-bit date format''' - m = _korean_onblog_date_re.match(dateString) - if not m: return - w3dtfdate = '%(year)s-%(month)s-%(day)sT%(hour)s:%(minute)s:%(second)s%(zonediff)s' % \ - {'year': m.group(1), 'month': m.group(2), 'day': m.group(3),\ - 'hour': m.group(4), 'minute': m.group(5), 'second': m.group(6),\ - 'zonediff': '+09:00'} - if _debug: sys.stderr.write('OnBlog date parsed as: %s\n' % w3dtfdate) - return _parse_date_w3dtf(w3dtfdate) -registerDateHandler(_parse_date_onblog) - -def _parse_date_nate(dateString): - '''Parse a string according to the Nate 8-bit date format''' - m = _korean_nate_date_re.match(dateString) - if not m: return - hour = int(m.group(5)) - ampm = m.group(4) - if (ampm == _korean_pm): - hour += 12 - hour = str(hour) - if len(hour) == 1: - hour = '0' + hour - w3dtfdate = '%(year)s-%(month)s-%(day)sT%(hour)s:%(minute)s:%(second)s%(zonediff)s' % \ - {'year': m.group(1), 'month': m.group(2), 'day': m.group(3),\ - 'hour': hour, 'minute': m.group(6), 'second': m.group(7),\ - 'zonediff': '+09:00'} - if _debug: sys.stderr.write('Nate date parsed as: %s\n' % w3dtfdate) - return _parse_date_w3dtf(w3dtfdate) -registerDateHandler(_parse_date_nate) - -_mssql_date_re = \ - re.compile('(\d{4})-(\d{2})-(\d{2})\s+(\d{2}):(\d{2}):(\d{2})(\.\d+)?') -def _parse_date_mssql(dateString): - '''Parse a string according to the MS SQL date format''' - m = _mssql_date_re.match(dateString) - if not m: return - w3dtfdate = '%(year)s-%(month)s-%(day)sT%(hour)s:%(minute)s:%(second)s%(zonediff)s' % \ - {'year': m.group(1), 'month': m.group(2), 'day': m.group(3),\ - 'hour': m.group(4), 'minute': m.group(5), 'second': m.group(6),\ - 'zonediff': '+09:00'} - if _debug: sys.stderr.write('MS SQL date parsed as: %s\n' % w3dtfdate) - return _parse_date_w3dtf(w3dtfdate) -registerDateHandler(_parse_date_mssql) - -# Unicode strings for Greek date strings -_greek_months = \ - { \ - u'\u0399\u03b1\u03bd': u'Jan', # c9e1ed in iso-8859-7 - u'\u03a6\u03b5\u03b2': u'Feb', # d6e5e2 in iso-8859-7 - u'\u039c\u03ac\u03ce': u'Mar', # ccdcfe in iso-8859-7 - u'\u039c\u03b1\u03ce': u'Mar', # cce1fe in iso-8859-7 - u'\u0391\u03c0\u03c1': u'Apr', # c1f0f1 in iso-8859-7 - u'\u039c\u03ac\u03b9': u'May', # ccdce9 in iso-8859-7 - u'\u039c\u03b1\u03ca': u'May', # cce1fa in iso-8859-7 - u'\u039c\u03b1\u03b9': u'May', # cce1e9 in iso-8859-7 - u'\u0399\u03bf\u03cd\u03bd': u'Jun', # c9effded in iso-8859-7 - u'\u0399\u03bf\u03bd': u'Jun', # c9efed in iso-8859-7 - u'\u0399\u03bf\u03cd\u03bb': u'Jul', # c9effdeb in iso-8859-7 - u'\u0399\u03bf\u03bb': u'Jul', # c9f9eb in iso-8859-7 - u'\u0391\u03cd\u03b3': u'Aug', # c1fde3 in iso-8859-7 - u'\u0391\u03c5\u03b3': u'Aug', # c1f5e3 in iso-8859-7 - u'\u03a3\u03b5\u03c0': u'Sep', # d3e5f0 in iso-8859-7 - u'\u039f\u03ba\u03c4': u'Oct', # cfeaf4 in iso-8859-7 - u'\u039d\u03bf\u03ad': u'Nov', # cdefdd in iso-8859-7 - u'\u039d\u03bf\u03b5': u'Nov', # cdefe5 in iso-8859-7 - u'\u0394\u03b5\u03ba': u'Dec', # c4e5ea in iso-8859-7 - } - -_greek_wdays = \ - { \ - u'\u039a\u03c5\u03c1': u'Sun', # caf5f1 in iso-8859-7 - u'\u0394\u03b5\u03c5': u'Mon', # c4e5f5 in iso-8859-7 - u'\u03a4\u03c1\u03b9': u'Tue', # d4f1e9 in iso-8859-7 - u'\u03a4\u03b5\u03c4': u'Wed', # d4e5f4 in iso-8859-7 - u'\u03a0\u03b5\u03bc': u'Thu', # d0e5ec in iso-8859-7 - u'\u03a0\u03b1\u03c1': u'Fri', # d0e1f1 in iso-8859-7 - u'\u03a3\u03b1\u03b2': u'Sat', # d3e1e2 in iso-8859-7 - } - -_greek_date_format_re = \ - re.compile(u'([^,]+),\s+(\d{2})\s+([^\s]+)\s+(\d{4})\s+(\d{2}):(\d{2}):(\d{2})\s+([^\s]+)') - -def _parse_date_greek(dateString): - '''Parse a string according to a Greek 8-bit date format.''' - m = _greek_date_format_re.match(dateString) - if not m: return - try: - wday = _greek_wdays[m.group(1)] - month = _greek_months[m.group(3)] - except: - return - rfc822date = '%(wday)s, %(day)s %(month)s %(year)s %(hour)s:%(minute)s:%(second)s %(zonediff)s' % \ - {'wday': wday, 'day': m.group(2), 'month': month, 'year': m.group(4),\ - 'hour': m.group(5), 'minute': m.group(6), 'second': m.group(7),\ - 'zonediff': m.group(8)} - if _debug: sys.stderr.write('Greek date parsed as: %s\n' % rfc822date) - return _parse_date_rfc822(rfc822date) -registerDateHandler(_parse_date_greek) - -# Unicode strings for Hungarian date strings -_hungarian_months = \ - { \ - u'janu\u00e1r': u'01', # e1 in iso-8859-2 - u'febru\u00e1ri': u'02', # e1 in iso-8859-2 - u'm\u00e1rcius': u'03', # e1 in iso-8859-2 - u'\u00e1prilis': u'04', # e1 in iso-8859-2 - u'm\u00e1ujus': u'05', # e1 in iso-8859-2 - u'j\u00fanius': u'06', # fa in iso-8859-2 - u'j\u00falius': u'07', # fa in iso-8859-2 - u'augusztus': u'08', - u'szeptember': u'09', - u'okt\u00f3ber': u'10', # f3 in iso-8859-2 - u'november': u'11', - u'december': u'12', - } - -_hungarian_date_format_re = \ - re.compile(u'(\d{4})-([^-]+)-(\d{,2})T(\d{,2}):(\d{2})((\+|-)(\d{,2}:\d{2}))') - -def _parse_date_hungarian(dateString): - '''Parse a string according to a Hungarian 8-bit date format.''' - m = _hungarian_date_format_re.match(dateString) - if not m: return - try: - month = _hungarian_months[m.group(2)] - day = m.group(3) - if len(day) == 1: - day = '0' + day - hour = m.group(4) - if len(hour) == 1: - hour = '0' + hour - except: - return - w3dtfdate = '%(year)s-%(month)s-%(day)sT%(hour)s:%(minute)s%(zonediff)s' % \ - {'year': m.group(1), 'month': month, 'day': day,\ - 'hour': hour, 'minute': m.group(5),\ - 'zonediff': m.group(6)} - if _debug: sys.stderr.write('Hungarian date parsed as: %s\n' % w3dtfdate) - return _parse_date_w3dtf(w3dtfdate) -registerDateHandler(_parse_date_hungarian) - -# W3DTF-style date parsing adapted from PyXML xml.utils.iso8601, written by -# Drake and licensed under the Python license. Removed all range checking -# for month, day, hour, minute, and second, since mktime will normalize -# these later -def _parse_date_w3dtf(dateString): - def __extract_date(m): - year = int(m.group('year')) - if year < 100: - year = 100 * int(time.gmtime()[0] / 100) + int(year) - if year < 1000: - return 0, 0, 0 - julian = m.group('julian') - if julian: - julian = int(julian) - month = julian / 30 + 1 - day = julian % 30 + 1 - jday = None - while jday != julian: - t = time.mktime((year, month, day, 0, 0, 0, 0, 0, 0)) - jday = time.gmtime(t)[-2] - diff = abs(jday - julian) - if jday > julian: - if diff < day: - day = day - diff - else: - month = month - 1 - day = 31 - elif jday < julian: - if day + diff < 28: - day = day + diff - else: - month = month + 1 - return year, month, day - month = m.group('month') - day = 1 - if month is None: - month = 1 - else: - month = int(month) - day = m.group('day') - if day: - day = int(day) - else: - day = 1 - return year, month, day - - def __extract_time(m): - if not m: - return 0, 0, 0 - hours = m.group('hours') - if not hours: - return 0, 0, 0 - hours = int(hours) - minutes = int(m.group('minutes')) - seconds = m.group('seconds') - if seconds: - seconds = int(seconds) - else: - seconds = 0 - return hours, minutes, seconds - - def __extract_tzd(m): - '''Return the Time Zone Designator as an offset in seconds from UTC.''' - if not m: - return 0 - tzd = m.group('tzd') - if not tzd: - return 0 - if tzd == 'Z': - return 0 - hours = int(m.group('tzdhours')) - minutes = m.group('tzdminutes') - if minutes: - minutes = int(minutes) - else: - minutes = 0 - offset = (hours*60 + minutes) * 60 - if tzd[0] == '+': - return -offset - return offset - - __date_re = ('(?P\d\d\d\d)' - '(?:(?P-|)' - '(?:(?P\d\d\d)' - '|(?P\d\d)(?:(?P=dsep)(?P\d\d))?))?') - __tzd_re = '(?P[-+](?P\d\d)(?::?(?P\d\d))|Z)' - __tzd_rx = re.compile(__tzd_re) - __time_re = ('(?P\d\d)(?P:|)(?P\d\d)' - '(?:(?P=tsep)(?P\d\d(?:[.,]\d+)?))?' - + __tzd_re) - __datetime_re = '%s(?:T%s)?' % (__date_re, __time_re) - __datetime_rx = re.compile(__datetime_re) - m = __datetime_rx.match(dateString) - if (m is None) or (m.group() != dateString): return - gmt = __extract_date(m) + __extract_time(m) + (0, 0, 0) - if gmt[0] == 0: return - return time.gmtime(time.mktime(gmt) + __extract_tzd(m) - time.timezone) -registerDateHandler(_parse_date_w3dtf) - -def _parse_date_rfc822(dateString): - '''Parse an RFC822, RFC1123, RFC2822, or asctime-style date''' - data = dateString.split() - if data[0][-1] in (',', '.') or data[0].lower() in rfc822._daynames: - del data[0] - if len(data) == 4: - s = data[3] - i = s.find('+') - if i > 0: - data[3:] = [s[:i], s[i+1:]] - else: - data.append('') - dateString = " ".join(data) - if len(data) < 5: - dateString += ' 00:00:00 GMT' - tm = rfc822.parsedate_tz(dateString) - if tm: - return time.gmtime(rfc822.mktime_tz(tm)) -# rfc822.py defines several time zones, but we define some extra ones. -# 'ET' is equivalent to 'EST', etc. -_additional_timezones = {'AT': -400, 'ET': -500, 'CT': -600, 'MT': -700, 'PT': -800} -rfc822._timezones.update(_additional_timezones) -registerDateHandler(_parse_date_rfc822) - -def _parse_date(dateString): - '''Parses a variety of date formats into a 9-tuple in GMT''' - for handler in _date_handlers: - try: - date9tuple = handler(dateString) - if not date9tuple: continue - if len(date9tuple) != 9: - if _debug: sys.stderr.write('date handler function must return 9-tuple\n') - raise ValueError - map(int, date9tuple) - return date9tuple - except Exception, e: - if _debug: sys.stderr.write('%s raised %s\n' % (handler.__name__, repr(e))) - pass - return None - -def _getCharacterEncoding(http_headers, xml_data): - '''Get the character encoding of the XML document - - http_headers is a dictionary - xml_data is a raw string (not Unicode) - - This is so much trickier than it sounds, it's not even funny. - According to RFC 3023 ('XML Media Types'), if the HTTP Content-Type - is application/xml, application/*+xml, - application/xml-external-parsed-entity, or application/xml-dtd, - the encoding given in the charset parameter of the HTTP Content-Type - takes precedence over the encoding given in the XML prefix within the - document, and defaults to 'utf-8' if neither are specified. But, if - the HTTP Content-Type is text/xml, text/*+xml, or - text/xml-external-parsed-entity, the encoding given in the XML prefix - within the document is ALWAYS IGNORED and only the encoding given in - the charset parameter of the HTTP Content-Type header should be - respected, and it defaults to 'us-ascii' if not specified. - - Furthermore, discussion on the atom-syntax mailing list with the - author of RFC 3023 leads me to the conclusion that any document - served with a Content-Type of text/* and no charset parameter - must be treated as us-ascii. (We now do this.) And also that it - must always be flagged as non-well-formed. (We now do this too.) - - If Content-Type is unspecified (input was local file or non-HTTP source) - or unrecognized (server just got it totally wrong), then go by the - encoding given in the XML prefix of the document and default to - 'iso-8859-1' as per the HTTP specification (RFC 2616). - - Then, assuming we didn't find a character encoding in the HTTP headers - (and the HTTP Content-type allowed us to look in the body), we need - to sniff the first few bytes of the XML data and try to determine - whether the encoding is ASCII-compatible. Section F of the XML - specification shows the way here: - http://www.w3.org/TR/REC-xml/#sec-guessing-no-ext-info - - If the sniffed encoding is not ASCII-compatible, we need to make it - ASCII compatible so that we can sniff further into the XML declaration - to find the encoding attribute, which will tell us the true encoding. - - Of course, none of this guarantees that we will be able to parse the - feed in the declared character encoding (assuming it was declared - correctly, which many are not). CJKCodecs and iconv_codec help a lot; - you should definitely install them if you can. - http://cjkpython.i18n.org/ - ''' - - def _parseHTTPContentType(content_type): - '''takes HTTP Content-Type header and returns (content type, charset) - - If no charset is specified, returns (content type, '') - If no content type is specified, returns ('', '') - Both return parameters are guaranteed to be lowercase strings - ''' - content_type = content_type or '' - content_type, params = cgi.parse_header(content_type) - return content_type, params.get('charset', '').replace("'", '') - - sniffed_xml_encoding = '' - xml_encoding = '' - true_encoding = '' - http_content_type, http_encoding = _parseHTTPContentType(http_headers.get('content-type')) - # Must sniff for non-ASCII-compatible character encodings before - # searching for XML declaration. This heuristic is defined in - # section F of the XML specification: - # http://www.w3.org/TR/REC-xml/#sec-guessing-no-ext-info - try: - if xml_data[:4] == '\x4c\x6f\xa7\x94': - # EBCDIC - xml_data = _ebcdic_to_ascii(xml_data) - elif xml_data[:4] == '\x00\x3c\x00\x3f': - # UTF-16BE - sniffed_xml_encoding = 'utf-16be' - xml_data = unicode(xml_data, 'utf-16be').encode('utf-8') - elif (len(xml_data) >= 4) and (xml_data[:2] == '\xfe\xff') and (xml_data[2:4] != '\x00\x00'): - # UTF-16BE with BOM - sniffed_xml_encoding = 'utf-16be' - xml_data = unicode(xml_data[2:], 'utf-16be').encode('utf-8') - elif xml_data[:4] == '\x3c\x00\x3f\x00': - # UTF-16LE - sniffed_xml_encoding = 'utf-16le' - xml_data = unicode(xml_data, 'utf-16le').encode('utf-8') - elif (len(xml_data) >= 4) and (xml_data[:2] == '\xff\xfe') and (xml_data[2:4] != '\x00\x00'): - # UTF-16LE with BOM - sniffed_xml_encoding = 'utf-16le' - xml_data = unicode(xml_data[2:], 'utf-16le').encode('utf-8') - elif xml_data[:4] == '\x00\x00\x00\x3c': - # UTF-32BE - sniffed_xml_encoding = 'utf-32be' - xml_data = unicode(xml_data, 'utf-32be').encode('utf-8') - elif xml_data[:4] == '\x3c\x00\x00\x00': - # UTF-32LE - sniffed_xml_encoding = 'utf-32le' - xml_data = unicode(xml_data, 'utf-32le').encode('utf-8') - elif xml_data[:4] == '\x00\x00\xfe\xff': - # UTF-32BE with BOM - sniffed_xml_encoding = 'utf-32be' - xml_data = unicode(xml_data[4:], 'utf-32be').encode('utf-8') - elif xml_data[:4] == '\xff\xfe\x00\x00': - # UTF-32LE with BOM - sniffed_xml_encoding = 'utf-32le' - xml_data = unicode(xml_data[4:], 'utf-32le').encode('utf-8') - elif xml_data[:3] == '\xef\xbb\xbf': - # UTF-8 with BOM - sniffed_xml_encoding = 'utf-8' - xml_data = unicode(xml_data[3:], 'utf-8').encode('utf-8') - else: - # ASCII-compatible - pass - xml_encoding_match = re.compile('^<\?.*encoding=[\'"](.*?)[\'"].*\?>').match(xml_data) - except: - xml_encoding_match = None - if xml_encoding_match: - xml_encoding = xml_encoding_match.groups()[0].lower() - if sniffed_xml_encoding and (xml_encoding in ('iso-10646-ucs-2', 'ucs-2', 'csunicode', 'iso-10646-ucs-4', 'ucs-4', 'csucs4', 'utf-16', 'utf-32', 'utf_16', 'utf_32', 'utf16', 'u16')): - xml_encoding = sniffed_xml_encoding - acceptable_content_type = 0 - application_content_types = ('application/xml', 'application/xml-dtd', 'application/xml-external-parsed-entity') - text_content_types = ('text/xml', 'text/xml-external-parsed-entity') - if (http_content_type in application_content_types) or \ - (http_content_type.startswith('application/') and http_content_type.endswith('+xml')): - acceptable_content_type = 1 - true_encoding = http_encoding or xml_encoding or 'utf-8' - elif (http_content_type in text_content_types) or \ - (http_content_type.startswith('text/')) and http_content_type.endswith('+xml'): - acceptable_content_type = 1 - true_encoding = http_encoding or 'us-ascii' - elif http_content_type.startswith('text/'): - true_encoding = http_encoding or 'us-ascii' - elif http_headers and (not http_headers.has_key('content-type')): - true_encoding = xml_encoding or 'iso-8859-1' - else: - true_encoding = xml_encoding or 'utf-8' - return true_encoding, http_encoding, xml_encoding, sniffed_xml_encoding, acceptable_content_type - -def _toUTF8(data, encoding): - '''Changes an XML data stream on the fly to specify a new encoding - - data is a raw sequence of bytes (not Unicode) that is presumed to be in %encoding already - encoding is a string recognized by encodings.aliases - ''' - if _debug: sys.stderr.write('entering _toUTF8, trying encoding %s\n' % encoding) - # strip Byte Order Mark (if present) - if (len(data) >= 4) and (data[:2] == '\xfe\xff') and (data[2:4] != '\x00\x00'): - if _debug: - sys.stderr.write('stripping BOM\n') - if encoding != 'utf-16be': - sys.stderr.write('trying utf-16be instead\n') - encoding = 'utf-16be' - data = data[2:] - elif (len(data) >= 4) and (data[:2] == '\xff\xfe') and (data[2:4] != '\x00\x00'): - if _debug: - sys.stderr.write('stripping BOM\n') - if encoding != 'utf-16le': - sys.stderr.write('trying utf-16le instead\n') - encoding = 'utf-16le' - data = data[2:] - elif data[:3] == '\xef\xbb\xbf': - if _debug: - sys.stderr.write('stripping BOM\n') - if encoding != 'utf-8': - sys.stderr.write('trying utf-8 instead\n') - encoding = 'utf-8' - data = data[3:] - elif data[:4] == '\x00\x00\xfe\xff': - if _debug: - sys.stderr.write('stripping BOM\n') - if encoding != 'utf-32be': - sys.stderr.write('trying utf-32be instead\n') - encoding = 'utf-32be' - data = data[4:] - elif data[:4] == '\xff\xfe\x00\x00': - if _debug: - sys.stderr.write('stripping BOM\n') - if encoding != 'utf-32le': - sys.stderr.write('trying utf-32le instead\n') - encoding = 'utf-32le' - data = data[4:] - newdata = unicode(data, encoding) - if _debug: sys.stderr.write('successfully converted %s data to unicode\n' % encoding) - declmatch = re.compile('^<\?xml[^>]*?>') - newdecl = '''''' - if declmatch.search(newdata): - newdata = declmatch.sub(newdecl, newdata) - else: - newdata = newdecl + u'\n' + newdata - return newdata.encode('utf-8') - -def _stripDoctype(data): - '''Strips DOCTYPE from XML document, returns (rss_version, stripped_data) - - rss_version may be 'rss091n' or None - stripped_data is the same XML document, minus the DOCTYPE - ''' - entity_pattern = re.compile(r']*?)>', re.MULTILINE) - data = entity_pattern.sub('', data) - doctype_pattern = re.compile(r']*?)>', re.MULTILINE) - doctype_results = doctype_pattern.findall(data) - doctype = doctype_results and doctype_results[0] or '' - if doctype.lower().count('netscape'): - version = 'rss091n' - else: - version = None - data = doctype_pattern.sub('', data) - return version, data - -def opensearch_parse(url_file_stream_or_string, etag=None, modified=None, agent=None, referrer=None, handlers=[]): - '''Parse a feed from a URL, file, stream, or string''' - result = FeedParserDict() - result['feed'] = FeedParserDict() - result['entries'] = [] - if _XML_AVAILABLE: - result['bozo'] = 0 - if type(handlers) == types.InstanceType: - handlers = [handlers] - try: - f = _open_resource(url_file_stream_or_string, etag, modified, agent, referrer, handlers) - data = f.read() - except Exception, e: - result['bozo'] = 1 - result['bozo_exception'] = e - data = '' - f = None - - # if feed is gzip-compressed, decompress it - if f and data and hasattr(f, 'headers'): - if gzip and f.headers.get('content-encoding', '') == 'gzip': - try: - data = gzip.GzipFile(fileobj=_StringIO(data)).read() - except Exception, e: - # Some feeds claim to be gzipped but they're not, so - # we get garbage. Ideally, we should re-request the - # feed without the 'Accept-encoding: gzip' header, - # but we don't. - result['bozo'] = 1 - result['bozo_exception'] = e - data = '' - elif zlib and f.headers.get('content-encoding', '') == 'deflate': - try: - data = zlib.decompress(data, -zlib.MAX_WBITS) - except Exception, e: - result['bozo'] = 1 - result['bozo_exception'] = e - data = '' - - # save HTTP headers - if hasattr(f, 'info'): - info = f.info() - result['etag'] = info.getheader('ETag') - last_modified = info.getheader('Last-Modified') - if last_modified: - result['modified'] = _parse_date(last_modified) - if hasattr(f, 'url'): - result['href'] = f.url - result['status'] = 200 - if hasattr(f, 'status'): - result['status'] = f.status - if hasattr(f, 'headers'): - result['headers'] = f.headers.dict - if hasattr(f, 'close'): - f.close() - - # there are four encodings to keep track of: - # - http_encoding is the encoding declared in the Content-Type HTTP header - # - xml_encoding is the encoding declared in the ; changed -# project name -#2.5 - 7/25/2003 - MAP - changed to Python license (all contributors agree); -# removed unnecessary urllib code -- urllib2 should always be available anyway; -# return actual url, status, and full HTTP headers (as result['url'], -# result['status'], and result['headers']) if parsing a remote feed over HTTP -- -# this should pass all the HTTP tests at ; -# added the latest namespace-of-the-week for RSS 2.0 -#2.5.1 - 7/26/2003 - RMK - clear opener.addheaders so we only send our custom -# User-Agent (otherwise urllib2 sends two, which confuses some servers) -#2.5.2 - 7/28/2003 - MAP - entity-decode inline xml properly; added support for -# inline and as used in some RSS 2.0 feeds -#2.5.3 - 8/6/2003 - TvdV - patch to track whether we're inside an image or -# textInput, and also to return the character encoding (if specified) -#2.6 - 1/1/2004 - MAP - dc:author support (MarekK); fixed bug tracking -# nested divs within content (JohnD); fixed missing sys import (JohanS); -# fixed regular expression to capture XML character encoding (Andrei); -# added support for Atom 0.3-style links; fixed bug with textInput tracking; -# added support for cloud (MartijnP); added support for multiple -# category/dc:subject (MartijnP); normalize content model: 'description' gets -# description (which can come from description, summary, or full content if no -# description), 'content' gets dict of base/language/type/value (which can come -# from content:encoded, xhtml:body, content, or fullitem); -# fixed bug matching arbitrary Userland namespaces; added xml:base and xml:lang -# tracking; fixed bug tracking unknown tags; fixed bug tracking content when -# element is not in default namespace (like Pocketsoap feed); -# resolve relative URLs in link, guid, docs, url, comments, wfw:comment, -# wfw:commentRSS; resolve relative URLs within embedded HTML markup in -# description, xhtml:body, content, content:encoded, title, subtitle, -# summary, info, tagline, and copyright; added support for pingback and -# trackback namespaces -#2.7 - 1/5/2004 - MAP - really added support for trackback and pingback -# namespaces, as opposed to 2.6 when I said I did but didn't really; -# sanitize HTML markup within some elements; added mxTidy support (if -# installed) to tidy HTML markup within some elements; fixed indentation -# bug in _parse_date (FazalM); use socket.setdefaulttimeout if available -# (FazalM); universal date parsing and normalization (FazalM): 'created', modified', -# 'issued' are parsed into 9-tuple date format and stored in 'created_parsed', -# 'modified_parsed', and 'issued_parsed'; 'date' is duplicated in 'modified' -# and vice-versa; 'date_parsed' is duplicated in 'modified_parsed' and vice-versa -#2.7.1 - 1/9/2004 - MAP - fixed bug handling " and '. fixed memory -# leak not closing url opener (JohnD); added dc:publisher support (MarekK); -# added admin:errorReportsTo support (MarekK); Python 2.1 dict support (MarekK) -#2.7.4 - 1/14/2004 - MAP - added workaround for improperly formed
tags in -# encoded HTML (skadz); fixed unicode handling in normalize_attrs (ChrisL); -# fixed relative URI processing for guid (skadz); added ICBM support; added -# base64 support -#2.7.5 - 1/15/2004 - MAP - added workaround for malformed DOCTYPE (seen on many -# blogspot.com sites); added _debug variable -#2.7.6 - 1/16/2004 - MAP - fixed bug with StringIO importing -#3.0b3 - 1/23/2004 - MAP - parse entire feed with real XML parser (if available); -# added several new supported namespaces; fixed bug tracking naked markup in -# description; added support for enclosure; added support for source; re-added -# support for cloud which got dropped somehow; added support for expirationDate -#3.0b4 - 1/26/2004 - MAP - fixed xml:lang inheritance; fixed multiple bugs tracking -# xml:base URI, one for documents that don't define one explicitly and one for -# documents that define an outer and an inner xml:base that goes out of scope -# before the end of the document -#3.0b5 - 1/26/2004 - MAP - fixed bug parsing multiple links at feed level -#3.0b6 - 1/27/2004 - MAP - added feed type and version detection, result['version'] -# will be one of SUPPORTED_VERSIONS.keys() or empty string if unrecognized; -# added support for creativeCommons:license and cc:license; added support for -# full Atom content model in title, tagline, info, copyright, summary; fixed bug -# with gzip encoding (not always telling server we support it when we do) -#3.0b7 - 1/28/2004 - MAP - support Atom-style author element in author_detail -# (dictionary of 'name', 'url', 'email'); map author to author_detail if author -# contains name + email address -#3.0b8 - 1/28/2004 - MAP - added support for contributor -#3.0b9 - 1/29/2004 - MAP - fixed check for presence of dict function; added -# support for summary -#3.0b10 - 1/31/2004 - MAP - incorporated ISO-8601 date parsing routines from -# xml.util.iso8601 -#3.0b11 - 2/2/2004 - MAP - added 'rights' to list of elements that can contain -# dangerous markup; fiddled with decodeEntities (not right); liberalized -# date parsing even further -#3.0b12 - 2/6/2004 - MAP - fiddled with decodeEntities (still not right); -# added support to Atom 0.2 subtitle; added support for Atom content model -# in copyright; better sanitizing of dangerous HTML elements with end tags -# (script, frameset) -#3.0b13 - 2/8/2004 - MAP - better handling of empty HTML tags (br, hr, img, -# etc.) in embedded markup, in either HTML or XHTML form (
,
,
) -#3.0b14 - 2/8/2004 - MAP - fixed CDATA handling in non-wellformed feeds under -# Python 2.1 -#3.0b15 - 2/11/2004 - MAP - fixed bug resolving relative links in wfw:commentRSS; -# fixed bug capturing author and contributor URL; fixed bug resolving relative -# links in author and contributor URL; fixed bug resolvin relative links in -# generator URL; added support for recognizing RSS 1.0; passed Simon Fell's -# namespace tests, and included them permanently in the test suite with his -# permission; fixed namespace handling under Python 2.1 -#3.0b16 - 2/12/2004 - MAP - fixed support for RSS 0.90 (broken in b15) -#3.0b17 - 2/13/2004 - MAP - determine character encoding as per RFC 3023 -#3.0b18 - 2/17/2004 - MAP - always map description to summary_detail (Andrei); -# use libxml2 (if available) -#3.0b19 - 3/15/2004 - MAP - fixed bug exploding author information when author -# name was in parentheses; removed ultra-problematic mxTidy support; patch to -# workaround crash in PyXML/expat when encountering invalid entities -# (MarkMoraes); support for textinput/textInput -#3.0b20 - 4/7/2004 - MAP - added CDF support -#3.0b21 - 4/14/2004 - MAP - added Hot RSS support -#3.0b22 - 4/19/2004 - MAP - changed 'channel' to 'feed', 'item' to 'entries' in -# results dict; changed results dict to allow getting values with results.key -# as well as results[key]; work around embedded illformed HTML with half -# a DOCTYPE; work around malformed Content-Type header; if character encoding -# is wrong, try several common ones before falling back to regexes (if this -# works, bozo_exception is set to CharacterEncodingOverride); fixed character -# encoding issues in BaseHTMLProcessor by tracking encoding and converting -# from Unicode to raw strings before feeding data to sgmllib.SGMLParser; -# convert each value in results to Unicode (if possible), even if using -# regex-based parsing -#3.0b23 - 4/21/2004 - MAP - fixed UnicodeDecodeError for feeds that contain -# high-bit characters in attributes in embedded HTML in description (thanks -# Thijs van de Vossen); moved guid, date, and date_parsed to mapped keys in -# FeedParserDict; tweaked FeedParserDict.has_key to return True if asking -# about a mapped key -#3.0fc1 - 4/23/2004 - MAP - made results.entries[0].links[0] and -# results.entries[0].enclosures[0] into FeedParserDict; fixed typo that could -# cause the same encoding to be tried twice (even if it failed the first time); -# fixed DOCTYPE stripping when DOCTYPE contained entity declarations; -# better textinput and image tracking in illformed RSS 1.0 feeds -#3.0fc2 - 5/10/2004 - MAP - added and passed Sam's amp tests; added and passed -# my blink tag tests -#3.0fc3 - 6/18/2004 - MAP - fixed bug in _changeEncodingDeclaration that -# failed to parse utf-16 encoded feeds; made source into a FeedParserDict; -# duplicate admin:generatorAgent/@rdf:resource in generator_detail.url; -# added support for image; refactored parse() fallback logic to try other -# encodings if SAX parsing fails (previously it would only try other encodings -# if re-encoding failed); remove unichr madness in normalize_attrs now that -# we're properly tracking encoding in and out of BaseHTMLProcessor; set -# feed.language from root-level xml:lang; set entry.id from rdf:about; -# send Accept header -#3.0 - 6/21/2004 - MAP - don't try iso-8859-1 (can't distinguish between -# iso-8859-1 and windows-1252 anyway, and most incorrectly marked feeds are -# windows-1252); fixed regression that could cause the same encoding to be -# tried twice (even if it failed the first time) -#3.0.1 - 6/22/2004 - MAP - default to us-ascii for all text/* content types; -# recover from malformed content-type header parameter with no equals sign -# ('text/xml; charset:iso-8859-1') -#3.1 - 6/28/2004 - MAP - added and passed tests for converting HTML entities -# to Unicode equivalents in illformed feeds (aaronsw); added and -# passed tests for converting character entities to Unicode equivalents -# in illformed feeds (aaronsw); test for valid parsers when setting -# XML_AVAILABLE; make version and encoding available when server returns -# a 304; add handlers parameter to pass arbitrary urllib2 handlers (like -# digest auth or proxy support); add code to parse username/password -# out of url and send as basic authentication; expose downloading-related -# exceptions in bozo_exception (aaronsw); added __contains__ method to -# FeedParserDict (aaronsw); added publisher_detail (aaronsw) -#3.2 - 7/3/2004 - MAP - use cjkcodecs and iconv_codec if available; always -# convert feed to UTF-8 before passing to XML parser; completely revamped -# logic for determining character encoding and attempting XML parsing -# (much faster); increased default timeout to 20 seconds; test for presence -# of Location header on redirects; added tests for many alternate character -# encodings; support various EBCDIC encodings; support UTF-16BE and -# UTF16-LE with or without a BOM; support UTF-8 with a BOM; support -# UTF-32BE and UTF-32LE with or without a BOM; fixed crashing bug if no -# XML parsers are available; added support for 'Content-encoding: deflate'; -# send blank 'Accept-encoding: ' header if neither gzip nor zlib modules -# are available -#3.3 - 7/15/2004 - MAP - optimize EBCDIC to ASCII conversion; fix obscure -# problem tracking xml:base and xml:lang if element declares it, child -# doesn't, first grandchild redeclares it, and second grandchild doesn't; -# refactored date parsing; defined public registerDateHandler so callers -# can add support for additional date formats at runtime; added support -# for OnBlog, Nate, MSSQL, Greek, and Hungarian dates (ytrewq1); added -# zopeCompatibilityHack() which turns FeedParserDict into a regular -# dictionary, required for Zope compatibility, and also makes command- -# line debugging easier because pprint module formats real dictionaries -# better than dictionary-like objects; added NonXMLContentType exception, -# which is stored in bozo_exception when a feed is served with a non-XML -# media type such as 'text/plain'; respect Content-Language as default -# language if not xml:lang is present; cloud dict is now FeedParserDict; -# generator dict is now FeedParserDict; better tracking of xml:lang, -# including support for xml:lang='' to unset the current language; -# recognize RSS 1.0 feeds even when RSS 1.0 namespace is not the default -# namespace; don't overwrite final status on redirects (scenarios: -# redirecting to a URL that returns 304, redirecting to a URL that -# redirects to another URL with a different type of redirect); add -# support for HTTP 303 redirects -#4.0 - MAP - support for relative URIs in xml:base attribute; fixed -# encoding issue with mxTidy (phopkins); preliminary support for RFC 3229; -# support for Atom 1.0; support for iTunes extensions; new 'tags' for -# categories/keywords/etc. as array of dict -# {'term': term, 'scheme': scheme, 'label': label} to match Atom 1.0 -# terminology; parse RFC 822-style dates with no time; lots of other -# bug fixes diff --git a/src/calibre/utils/opensearch/query.py b/src/calibre/utils/opensearch/query.py index 31c37ca923..d87eb0145f 100644 --- a/src/calibre/utils/opensearch/query.py +++ b/src/calibre/utils/opensearch/query.py @@ -1,10 +1,17 @@ -from urlparse import urlparse, urlunparse -from urllib import urlencode -from cgi import parse_qs +# -*- coding: utf-8 -*- -class Query: - """Represents an opensearch query. Used internally by the Client to - construct an opensearch url to request. Really this class is just a +from __future__ import (unicode_literals, division, absolute_import, print_function) + +__license__ = 'GPL 3' +__copyright__ = '2006, Ed Summers ' +__docformat__ = 'restructuredtext en' + +from urlparse import urlparse, urlunparse, parse_qs +from urllib import urlencode + +class Query(object): + ''' + Represents an opensearch query Really this class is just a helper for substituting values into the macros in a format. format = 'http://beta.indeed.com/opensearch?q={searchTerms}&start={startIndex}&limit={count}' @@ -12,16 +19,17 @@ class Query: q.searchTerms('zx81') q.startIndex = 1 q.count = 25 - print q.to_url() - """ + print q.url() + ''' - standard_macros = ['searchTerms','count','startIndex','startPage', + standard_macros = ['searchTerms', 'count', 'startIndex', 'startPage', 'language', 'outputEncoding', 'inputEncoding'] def __init__(self, format): - """Create a query object by passing it the url format obtained + ''' + Create a query object by passing it the url format obtained from the opensearch Description. - """ + ''' self.format = format # unpack the url to a tuple @@ -37,7 +45,7 @@ class Query: for key,values in self.query_string.items(): # TODO eventually optional/required params should be # distinguished somehow (the ones with/without trailing ? - macro = values[0].replace('{','').replace('}','').replace('?','') + macro = values[0].replace('{', '').replace('}', '').replace('?', '') if macro in Query.standard_macros: self.macro_map[macro] = key diff --git a/src/calibre/utils/opensearch/results.py b/src/calibre/utils/opensearch/results.py deleted file mode 100644 index 1922848e22..0000000000 --- a/src/calibre/utils/opensearch/results.py +++ /dev/null @@ -1,131 +0,0 @@ -import osfeedparser - -class Results(object): - - def __init__(self, query, agent=None): - self.agent = agent - self._fetch(query) - self._iter = 0 - - def __iter__(self): - self._iter = 0 - return self - - def __len__(self): - return self.totalResults - - def next(self): - - # just keep going like the energizer bunny - while True: - - # return any item we haven't returned - if self._iter < len(self.items): - self._iter += 1 - return self.items[self._iter-1] - - # if there appears to be more to fetch - if \ - self.totalResults != 0 \ - and self.totalResults > self.startIndex + self.itemsPerPage - 1: - - # get the next query - next_query = self._get_next_query() - - # if we got one executed it and go back to the beginning - if next_query: - self._fetch(next_query) - # very important to reset this counter - # or else the return will fail - self._iter = 0 - - else: - raise StopIteration - - - def _fetch(self, query): - feed = osfeedparser.opensearch_parse(query.url(), agent=self.agent) - self.feed = feed - - # general channel stuff - channel = feed['feed'] - self.title = _pick(channel,'title') - self.link = _pick(channel,'link') - self.description = _pick(channel,'description') - self.language = _pick(channel,'language') - self.copyright = _pick(channel,'copyright') - - # get back opensearch specific values - self.totalResults = _pick(channel,'opensearch_totalresults',0) - self.startIndex = _pick(channel,'opensearch_startindex',1) - self.itemsPerPage = _pick(channel,'opensearch_itemsperpage',0) - - # alias items from the feed to our results object - self.items = feed['items'] - - # set default values if necessary - if self.startIndex == 0: - self.startIndex = 1 - if self.itemsPerPage == 0 and len(self.items) > 0: - self.itemsPerPage = len(self.items) - - # store away query for calculating next results - # if necessary - self.last_query = query - - - def _get_next_query(self): - # update our query to get the next set of records - query = self.last_query - - # use start page if the query supports it - if query.has_macro('startPage'): - # if the query already defined the startPage - # we just need to increment it - if hasattr(query, 'startPage'): - query.startPage += 1 - # to issue the first query startPage might not have - # been specified, so set it to 2 - else: - query.startPage = 2 - return query - - # otherwise the query should support startIndex - elif query.has_macro('startIndex'): - # if startIndex was used before we just add the - # items per page to it to get the next set - if hasattr(query, 'startIndex'): - query.startIndex += self.itemsPerPage - # to issue the first query the startIndex may have - # been left blank in that case we assume it to be - # the item just after the last one on this page - else: - query.startIndex = self.itemsPerPage + 1 - return query - - # doesn't look like there is another stage to this query - return None - - -# helper for pulling values out of a dictionary if they're there -# and returning a default value if they're not -def _pick(d,key,default=None): - - # get the value out - value = d.get(key) - - # if it wasn't there return the default - if value == None: - return default - - # if they want an int try to convert to an int - # and return default if it fails - if type(default) == int: - try: - return int(d[key]) - except: - return default - - # otherwise we're good to return the value - return value - diff --git a/src/calibre/utils/opensearch/url.py b/src/calibre/utils/opensearch/url.py index 665c024ef3..f05ec3205a 100644 --- a/src/calibre/utils/opensearch/url.py +++ b/src/calibre/utils/opensearch/url.py @@ -1,5 +1,15 @@ -class URL: - """Class for representing a URL in an opensearch v1.1 query""" +# -*- coding: utf-8 -*- + +from __future__ import (unicode_literals, division, absolute_import, print_function) + +__license__ = 'GPL 3' +__copyright__ = '2006, Ed Summers ' +__docformat__ = 'restructuredtext en' + +class URL(object): + ''' + Class for representing a URL in an opensearch v1.1 query + ''' def __init__(self, type='', template='', method='GET'): self.type = type From e4adfb044056b175d258974e67c377bd12fde3e4 Mon Sep 17 00:00:00 2001 From: John Schember Date: Sun, 26 Jun 2011 21:05:54 -0400 Subject: [PATCH 23/24] Store: opensearch fix showing price. --- src/calibre/gui2/store/opensearch_store.py | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/src/calibre/gui2/store/opensearch_store.py b/src/calibre/gui2/store/opensearch_store.py index 456b6a7461..e7aa30a85c 100644 --- a/src/calibre/gui2/store/opensearch_store.py +++ b/src/calibre/gui2/store/opensearch_store.py @@ -67,7 +67,7 @@ class OpenSearchStore(StorePlugin): s = SearchResult() - s.detail_item = ''.join(data.xpath('./*[local-name() = "id"]/text()')) + s.detail_item = ''.join(data.xpath('./*[local-name() = "id"]/text()')).strip() for link in data.xpath('./*[local-name() = "link"]'): rel = link.get('rel') @@ -83,12 +83,20 @@ class OpenSearchStore(StorePlugin): if type: ext = mimetypes.guess_extension(type) if ext: - ext = ext[1:].upper() + ext = ext[1:].upper().strip() s.downloads[ext] = href - s.formats = ', '.join(s.downloads.keys()) + s.formats = ', '.join(s.downloads.keys()).strip() + + s.title = ' '.join(data.xpath('./*[local-name() = "title"]//text()')).strip() + s.author = ', '.join(data.xpath('./*[local-name() = "author"]//*[local-name() = "name"]//text()')).strip() + + price_e = data.xpath('.//*[local-name() = "price"][1]') + if price_e: + price_e = price_e[0] + currency_code = price_e.get('currencycode', '') + price = ''.join(price_e.xpath('.//text()')).strip() + s.price = currency_code + ' ' + price + s.price = s.price.strip() - s.title = ' '.join(data.xpath('./*[local-name() = "title"]//text()')) - s.author = ', '.join(data.xpath('./*[local-name() = "author"]//*[local-name() = "name"]//text()')) - s.price = ' '.join(data.xpath('.//*[local-name() = "price"]//text()')) yield s From 075468484d482f27477aa8511f9d313df67e848e Mon Sep 17 00:00:00 2001 From: John Schember Date: Sun, 26 Jun 2011 21:07:31 -0400 Subject: [PATCH 24/24] ... --- src/calibre/gui2/store/opensearch_store.py | 1 - src/calibre/gui2/store/stores/archive_org_plugin.py | 6 ++++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/calibre/gui2/store/opensearch_store.py b/src/calibre/gui2/store/opensearch_store.py index e7aa30a85c..54fedbd002 100644 --- a/src/calibre/gui2/store/opensearch_store.py +++ b/src/calibre/gui2/store/opensearch_store.py @@ -19,7 +19,6 @@ from calibre.gui2 import open_url from calibre.gui2.store import StorePlugin from calibre.gui2.store.search_result import SearchResult from calibre.gui2.store.web_store_dialog import WebStoreDialog -#from calibre.utils.opensearch import Client from calibre.utils.opensearch.description import Description from calibre.utils.opensearch.query import Query diff --git a/src/calibre/gui2/store/stores/archive_org_plugin.py b/src/calibre/gui2/store/stores/archive_org_plugin.py index 208b4c1aba..691f819e8c 100644 --- a/src/calibre/gui2/store/stores/archive_org_plugin.py +++ b/src/calibre/gui2/store/stores/archive_org_plugin.py @@ -29,8 +29,11 @@ class ArchiveOrgStore(BasicStoreConfig, OpenSearchStore): s.drm = SearchResult.DRM_UNLOCKED yield s -''' def get_details(self, search_result, timeout): + ''' + The opensearch feed only returns a subset of formats that are available. + We want to get a list of all formats that the user can get. + ''' br = browser() with closing(br.open(search_result.detail_item, timeout=timeout)) as nf: idata = html.fromstring(nf.read()) @@ -38,4 +41,3 @@ class ArchiveOrgStore(BasicStoreConfig, OpenSearchStore): search_result.formats = formats.upper() return True -'''