Bump version.

I've added fore more adapters for eFiction sites... one is slightly
dodgy...
The Rabid Reader
Naicea Nilmenet (Lord Of The Rings
Artemis Fowl Fan Fiction
Andromeda Web [doesn't retrieve some labels]

Gcomyn

calibre-plugin/__init__.py

@@ -12,7 +12,7 @@ if sys.version_info >= (2, 7):
     import logging
     logger = logging.getLogger(__name__)
     loghandler=logging.StreamHandler()
-    loghandler.setFormatter(logging.Formatter("FFF:%(levelname)s:%(filename)s(%(lineno)d):%(message)s"))
+    loghandler.setFormatter(logging.Formatter("FFF: %(levelname)s: %(asctime)s: %(filename)s(%(lineno)d): %(message)s"))
     logger.addHandler(loghandler)
     loghandler.setLevel(logging.DEBUG)
     logger.setLevel(logging.DEBUG)
@@ -42,7 +42,7 @@ class FanFicFareBase(InterfaceActionBase):
     description         = _('UI plugin to download FanFiction stories from various sites.')
     supported_platforms = ['windows', 'osx', 'linux']
     author              = 'Jim Miller'
-    version             = (2, 2, 17)
+    version             = (2, 3, 1)
     minimum_calibre_version = (1, 48, 0)
 
     #: This field defines the GUI plugin class that contains all the code

calibre-plugin/config.py

@@ -10,7 +10,7 @@ __docformat__ = 'restructuredtext en'
 import logging
 logger = logging.getLogger(__name__)
 
-import traceback, copy, threading
+import traceback, copy, threading, re
 from collections import OrderedDict
 
 try:
@@ -332,6 +332,7 @@ class ConfigWidget(QWidget):
         # Custom Columns tab
         # error column
         prefs['errorcol'] = unicode(convert_qvariant(self.cust_columns_tab.errorcol.itemData(self.cust_columns_tab.errorcol.currentIndex())))
+        prefs['save_all_errors'] = self.cust_columns_tab.save_all_errors.isChecked()
 
         # metadata column
         prefs['savemetacol'] = unicode(convert_qvariant(self.cust_columns_tab.savemetacol.itemData(self.cust_columns_tab.savemetacol.currentIndex())))
@@ -665,53 +666,94 @@ class PersonalIniTab(QWidget):
         label = QLabel(_('These settings provide more detailed control over what metadata will be displayed inside the ebook as well as let you set %(isa)s and %(u)s/%(p)s for different sites.')%no_trans)
         label.setWordWrap(True)
         self.l.addWidget(label)
-#        self.l.addSpacing(5)
-
-        label = QLabel(_("FanFicFare now includes find, color coding, and error checking for personal.ini editing.  Red generally indicates errors."))
-        label.setWordWrap(True)
-        self.l.addWidget(label)
-        
-        # self.label = QLabel('personal.ini:')
-        # self.l.addWidget(self.label)
-
-        # self.ini = QTextEdit(self)
-        # try:
-        #     self.ini.setFont(QFont("Courier",
-        #                            self.plugin_action.gui.font().pointSize()+1))
-        # except Exception as e:
-        #     logger.error("Couldn't get font: %s"%e)
-        # self.ini.setLineWrapMode(QTextEdit.NoWrap)
-        # self.ini.setText(prefs['personal.ini'])
-        # self.l.addWidget(self.ini)
+        self.l.addSpacing(5)
 
         self.personalini = prefs['personal.ini']
 
+        groupbox = QGroupBox(_("personal.ini"))
+        vert = QVBoxLayout()
+        groupbox.setLayout(vert)
+        self.l.addWidget(groupbox)
+
+        horz = QHBoxLayout()
+        vert.addLayout(horz)        
         self.ini_button = QPushButton(_('Edit personal.ini'), self)
         #self.ini_button.setToolTip(_("Edit personal.ini file."))
         self.ini_button.clicked.connect(self.add_ini_button)
-        self.l.addWidget(self.ini_button)
+        horz.addWidget(self.ini_button)
         
+        label = QLabel(_("FanFicFare now includes find, color coding, and error checking for personal.ini editing.  Red generally indicates errors."))
+        label.setWordWrap(True)
+        horz.addWidget(label)
+        
+        vert.addSpacing(5)
+
+        horz = QHBoxLayout()
+        vert.addLayout(horz)
+        self.ini_button = QPushButton(_('View "Safe" personal.ini'), self)
+        #self.ini_button.setToolTip(_("Edit personal.ini file."))
+        self.ini_button.clicked.connect(self.safe_ini_button)
+        horz.addWidget(self.ini_button)
+        
+        label = QLabel(_("View your personal.ini with usernames and passwords removed.  For safely sharing your personal.ini settings with others."))
+        label.setWordWrap(True)
+        horz.addWidget(label)
+        
+        self.l.addSpacing(5)
+        
+        groupbox = QGroupBox(_("defaults.ini"))
+        horz = QHBoxLayout()
+        groupbox.setLayout(horz)
+        self.l.addWidget(groupbox)
+        
+        view_label = _("View all of the plugin's configurable settings\nand their default settings.")
+        self.defaults = QPushButton(_('View Defaults')+' (plugin-defaults.ini)', self)
+        self.defaults.setToolTip(view_label)
+        self.defaults.clicked.connect(self.show_defaults)
+        horz.addWidget(self.defaults)
+
+        label = QLabel(view_label)
+        label.setWordWrap(True)
+        horz.addWidget(label)
+        
+        self.l.addSpacing(5)
+
+        groupbox = QGroupBox(_("Calibre Columns"))
+        vert = QVBoxLayout()
+        groupbox.setLayout(vert)
+        self.l.addWidget(groupbox)
+
+        horz = QHBoxLayout()
+        vert.addLayout(horz)
+        pass_label = _("If checked, when updating/overwriting an existing book, FanFicFare will have the Calibre Columns available to use in replace_metadata, title_page, etc.<br>Click the button below to see the Calibre Column namess.")%no_trans
+        self.cal_cols_pass_in = QCheckBox(_('Pass Calibre Columns into FanFicFare on Update/Overwrite')%no_trans,self)
+        self.cal_cols_pass_in.setToolTip(pass_label)
+        self.cal_cols_pass_in.setChecked(prefs['cal_cols_pass_in'])
+        horz.addWidget(self.cal_cols_pass_in)
+        
+        label = QLabel(pass_label)
+        label.setWordWrap(True)
+        horz.addWidget(label)
+
+        vert.addSpacing(5)
+        
+        horz = QHBoxLayout()
+        vert.addLayout(horz)
+        col_label = _("FanFicFare can pass the Calibre Columns into the download/update process.<br>This will show you the columns available by name.")
+        self.showcalcols = QPushButton(_('Show Calibre Column Names'), self)
+        self.showcalcols.setToolTip(col_label)
+        self.showcalcols.clicked.connect(self.show_showcalcols)
+        horz.addWidget(self.showcalcols)
+
+        label = QLabel(col_label)
+        label.setWordWrap(True)
+        horz.addWidget(label)
+
         label = QLabel(_("Changes will only be saved if you click 'OK' to leave Customize FanFicFare."))
         label.setWordWrap(True)
         self.l.addWidget(label)
-        
-        self.defaults = QPushButton(_('View Defaults')+' (plugin-defaults.ini)', self)
-        self.defaults.setToolTip(_("View all of the plugin's configurable settings\nand their default settings."))
-        self.defaults.clicked.connect(self.show_defaults)
-        self.l.addWidget(self.defaults)
-
-        self.cal_cols_pass_in = QCheckBox(_('Pass Calibre Columns into FanFicFare on Update/Overwrite')%no_trans,self)
-        self.cal_cols_pass_in.setToolTip(_("If checked, when updating/overwriting an existing book, FanFicFare will have the Calibre Columns available to use in replace_metadata, title_page, etc.<br>Click the button below to see the Calibre Column namess.")%no_trans)
-        self.cal_cols_pass_in.setChecked(prefs['cal_cols_pass_in'])
-        self.l.addWidget(self.cal_cols_pass_in)
-        
-        self.showcalcols = QPushButton(_('Show Calibre Column Names'), self)
-        self.showcalcols.setToolTip(_("FanFicFare can pass the Calibre Columns into the download/update process.<br>This will show you the columns available by name."))
-        self.showcalcols.clicked.connect(self.show_showcalcols)
-        self.l.addWidget(self.showcalcols)
 
         self.l.insertStretch(-1)
-        # let edit box fill the space.
         
     def show_defaults(self):
         IniTextDialog(self,
@@ -723,6 +765,18 @@ class PersonalIniTab(QWidget):
                        read_only=True,
                        save_size_name='fff:defaults.ini').exec_()
         
+    def safe_ini_button(self):
+        personalini = re.sub(r'((username|password) *[=:]).*$',r'\1XXXXXXXX',self.personalini,flags=re.MULTILINE)
+        
+        d = EditTextDialog(self,
+                           personalini,
+                           icon=self.windowIcon(),
+                           title=_("View 'Safe' personal.ini"),
+                           label=_("View your personal.ini with usernames and passwords removed.  For safely sharing your personal.ini settings with others."),
+                           save_size_name='fff:safe personal.ini',
+                           read_only=True)
+        d.exec_()
+        
     def add_ini_button(self):
         d = IniTextDialog(self,
                            self.personalini,
@@ -1287,6 +1341,7 @@ class CustomColumnsTab(QWidget):
         tooltip=_("When an update or overwrite of an existing story fails, record the reason in this column.\n(Text and Long Text columns only.)")
         label.setToolTip(tooltip)
         horz.addWidget(label)
+
         self.errorcol = QComboBox(self)
         self.errorcol.setToolTip(tooltip)
         self.errorcol.addItem('','none')
@@ -1295,6 +1350,15 @@ class CustomColumnsTab(QWidget):
                 self.errorcol.addItem(column['name'],key)
         self.errorcol.setCurrentIndex(self.errorcol.findData(prefs['errorcol']))
         horz.addWidget(self.errorcol)
+        
+        self.save_all_errors = QCheckBox(_('Save All Errors'),self)
+        self.save_all_errors.setToolTip(_('If unchecked, these errors will not be saved:%s')%(
+                '\n'+
+                '\n'.join((_("Not Overwriting, web site is not newer."),
+                           _("Already contains %d chapters.").replace('%d','X')))))
+        self.save_all_errors.setChecked(prefs['save_all_errors'])
+        horz.addWidget(self.save_all_errors)
+        
         self.l.addLayout(horz)
         
         horz = QHBoxLayout()
@@ -1310,6 +1374,10 @@ class CustomColumnsTab(QWidget):
                 self.savemetacol.addItem(column['name'],key)
         self.savemetacol.setCurrentIndex(self.savemetacol.findData(prefs['savemetacol']))
         horz.addWidget(self.savemetacol)
+
+        label = QLabel('')
+        horz.addWidget(label) # empty spacer for alignment with error column line.
+        
         self.l.addLayout(horz)
 
         #print("prefs['custom_cols'] %s"%prefs['custom_cols'])

calibre-plugin/dialogs.py

@@ -158,9 +158,10 @@ class RejectUrlEntry:
         return retval
 
 class NotGoingToDownload(Exception):
-    def __init__(self,error,icon='dialog_error.png'):
+    def __init__(self,error,icon='dialog_error.png',showerror=True):
         self.error=error
         self.icon=icon
+        self.showerror=showerror
 
     def __str__(self):
         return self.error
@@ -639,6 +640,7 @@ class LoopProgressDialog(QProgressDialog):
 
         except NotGoingToDownload as d:
             book['good']=False
+            book['showerror']=d.showerror
             book['comment']=unicode(d)
             book['icon'] = d.icon
 

calibre-plugin/fff_plugin.py

@@ -7,6 +7,22 @@ __license__   = 'GPL v3'
 __copyright__ = '2016, Jim Miller'
 __docformat__ = 'restructuredtext en'
 
+
+# import cProfile
+
+# def do_cprofile(func):
+#     def profiled_func(*args, **kwargs):
+#         profile = cProfile.Profile()
+#         try:
+#             profile.enable()
+#             result = func(*args, **kwargs)
+#             profile.disable()
+#             return result
+#         finally:
+#             profile.print_stats()
+#     return profiled_func
+
+
 import logging
 logger = logging.getLogger(__name__)
 
@@ -994,7 +1010,8 @@ class FanFicFarePlugin(InterfaceAction):
                                    show_copy_button=False):
                     rejecturllist.remove(url)
         return False
-            
+
+    # @do_cprofile
     def prep_download_loop(self,book,
                            options={'fileform':'epub',
                                     'collision':ADDNEW,
@@ -1015,6 +1032,7 @@ class FanFicFarePlugin(InterfaceAction):
         ## Check reject list.  Redundant with below for when story URL
         ## changes, but also kept here to avoid network hit in most
         ## common case where given url is story url.
+
         if self.reject_url(merge,book):
             return
 
@@ -1300,7 +1318,7 @@ class FanFicFarePlugin(InterfaceAction):
                         urlchaptercount = int(story.getMetadata('numChapters').replace(',',''))
                         if chaptercount == urlchaptercount:
                             if collision == UPDATE:
-                                raise NotGoingToDownload(_("Already contains %d chapters.")%chaptercount,'edit-undo.png')
+                                raise NotGoingToDownload(_("Already contains %d chapters.")%chaptercount,'edit-undo.png',showerror=False)
                         elif chaptercount > urlchaptercount:
                             raise NotGoingToDownload(_("Existing epub contains %d chapters, web site only has %d. Use Overwrite to force update.") % (chaptercount,urlchaptercount),'dialog_error.png')
                         elif chaptercount == 0:
@@ -1311,7 +1329,7 @@ class FanFicFarePlugin(InterfaceAction):
                     logger.debug("OVERWRITE file: "+db.format_abspath(book_id, formmapping[fileform], index_is_id=True))
                     fileupdated=datetime.fromtimestamp(os.stat(db.format_abspath(book_id, formmapping[fileform], index_is_id=True))[8])
                     logger.debug("OVERWRITE file updated: %s"%fileupdated)
-                    book['updated']=fileupdated
+                    book['fileupdated']=fileupdated
                     if not bgmeta:
                         # check make sure incoming is newer.
                         lastupdated=story.getMetadataRaw('dateUpdated')
@@ -1321,7 +1339,7 @@ class FanFicFarePlugin(InterfaceAction):
                         # updated does have time, use full timestamps.
                         if (lastupdated.time() == time.min and fileupdated.date() > lastupdated.date()) or \
                                 (lastupdated.time() != time.min and fileupdated > lastupdated):
-                            raise NotGoingToDownload(_("Not Overwriting, web site is not newer."),'edit-undo.png')
+                            raise NotGoingToDownload(_("Not Overwriting, web site is not newer."),'edit-undo.png',showerror=False)
 
                 # For update, provide a tmp file copy of the existing epub so
                 # it can't change underneath us.  Now also overwrite for logpage preserve.
@@ -1494,7 +1512,7 @@ class FanFicFarePlugin(InterfaceAction):
         custom_columns = self.gui.library_view.model().custom_columns
         if book['calibre_id'] and prefs['errorcol'] != '' and prefs['errorcol'] in custom_columns:
             label = custom_columns[prefs['errorcol']]['label']
-            if not book['good']:
+            if not book['good'] and (book['showerror'] or prefs['save_all_errors']):
                 logger.debug("record/update error message column %s %s"%(book['title'],book['url']))
                 self.set_custom(db, book['calibre_id'], 'comment', book['comment'], label=label, commit=True) # book['comment']
             else:
@@ -1677,14 +1695,14 @@ class FanFicFarePlugin(InterfaceAction):
                 if 'status' in book:
                     status = book['status']
                 else:
-                    status = 'Good'
+                    status = _('Good')
                 htmllog = htmllog + '<tr><td>' + '</td><td>'.join([escapehtml(status),escapehtml(book['title']),escapehtml(", ".join(book['author'])),escapehtml(book['comment']),book['url']]) + '</td></tr>'
 
             for book in bad_list:
                 if 'status' in book:
                     status = book['status']
                 else:
-                    status = 'Bad'
+                    status = _('Bad')
                 htmllog = htmllog + '<tr><td>' + '</td><td>'.join([escapehtml(status),escapehtml(book['title']),escapehtml(", ".join(book['author'])),escapehtml(book['comment']),book['url']]) + '</td></tr>'
 
             htmllog = htmllog + '</table></body></html>'
@@ -1777,7 +1795,7 @@ class FanFicFarePlugin(InterfaceAction):
                                status_prefix=_("Updated"))
 
     def update_error_column_loop(self,book,db=None,label=None):
-        if book['calibre_id'] and label:
+        if book['calibre_id'] and label and (book['showerror'] or prefs['save_all_errors']):
             logger.debug("add/update bad %s %s %s"%(book['title'],book['url'],book['comment']))
             self.set_custom(db, book['calibre_id'], 'comment', book['comment'], label=label, commit=True)
 
@@ -2194,6 +2212,10 @@ class FanFicFarePlugin(InterfaceAction):
         book['comments'] = '' # note this is the book comments.
 
         book['good'] = True
+        book['showerror'] = True # False when NotGoingToDownload is
+                                 # not-overwrite / not-update / skip
+                                 # -- what some would consider 'not an
+                                 # error'
         book['calibre_id'] = None
         book['begin'] = None
         book['end'] = None
@@ -2213,7 +2235,7 @@ class FanFicFarePlugin(InterfaceAction):
             book = self.convert_url_to_book(url)
             if book['url'] in uniqueurls:
                 book['good'] = False
-                book['comment'] = "Same story already included."
+                book['comment'] = _("Same story already included.")
             uniqueurls.add(book['url'])
             book['listorder']=i # BG d/l jobs don't come back in order.
                                 # Didn't matter until anthologies & 'marked' successes

calibre-plugin/inihighlighter.py

@@ -4,7 +4,7 @@ from __future__ import (unicode_literals, division,
                         print_function)
 
 __license__   = 'GPL v3'
-__copyright__ = '2015, Jim Miller'
+__copyright__ = '2016, Jim Miller'
 __docformat__ = 'restructuredtext en'
 
 import re
@@ -68,6 +68,10 @@ class IniHighlighter(QSyntaxHighlighter):
         self.teststoryRule = HighlightingRule( r"^\[teststory:([0-9]+|defaults)\]", Qt.darkCyan, blocknum=3 )
         self.highlightingRules.append( self.teststoryRule )
 
+        # storyUrl sections
+        self.storyUrlRule = HighlightingRule( r"^\[https?://.*\]", Qt.darkMagenta, blocknum=4 )
+        self.highlightingRules.append( self.storyUrlRule )
+
         # NOT comments -- but can be custom columns, so don't flag.
         #self.highlightingRules.append( HighlightingRule( r"(?<!^)#[^\n]*" , Qt.red ) )
         
@@ -96,6 +100,10 @@ class IniHighlighter(QSyntaxHighlighter):
             if blocknum == 3:
                 self.setFormat( 0, len(text), self.teststoryRule.highlight )
             
+            # storyUrl section rules:
+            if blocknum == 4:
+                self.setFormat( 0, len(text), self.storyUrlRule.highlight )
+            
         self.setCurrentBlockState( blocknum )
 
 class HighlightingRule():

calibre-plugin/jobs.py

@@ -23,6 +23,12 @@ from calibre.library.comments import sanitize_comments_html
 from calibre_plugins.fanficfare_plugin.wordcount import get_word_count
 from calibre_plugins.fanficfare_plugin.prefs import (SAVE_YES, SAVE_YES_UNLESS_SITE)
 
+# pulls in translation files for _() strings
+try:
+    load_translations()
+except NameError:
+    pass # load_translations() added in calibre 1.9
+
 # ------------------------------------------------------------------------------
 #
 #              Functions to perform downloads using worker jobs
@@ -82,7 +88,7 @@ def do_download_worker(book_list,
         book_list.append(job.result)
         book_id = job._book['calibre_id']
         count = count + 1
-        notification(float(count)/total, '%d of %d stories finished downloading'%(count,total))
+        notification(float(count)/total, _('%d of %d stories finished downloading')%(count,total))
         # Add this job's output to the current log
         logger.info('Logfile for book ID %s (%s)'%(book_id, job._book['title']))
         logger.info(job.details)
@@ -189,7 +195,7 @@ def do_download_for_worker(book,options,merge,notification=lambda x,y:x):
             ## No need to download at all.  Shouldn't ever get down here.
             if options['collision'] in (CALIBREONLY, CALIBREONLYSAVECOL):
                 logger.info("Skipping CALIBREONLY 'update' down inside worker--this shouldn't be happening...")
-                book['comment'] = 'Metadata collected.'
+                book['comment'] = _('Metadata collected.')
                 book['all_metadata'] = story.getAllMetadata(removeallentities=True)
                 if options['savemetacol'] != '':
                     book['savemetacol'] = story.dump_html_metadata()
@@ -214,14 +220,14 @@ def do_download_for_worker(book,options,merge,notification=lambda x,y:x):
                     # updated does have time, use full timestamps.
                     if (lastupdated.time() == time.min and fileupdated.date() > lastupdated.date()) or \
                             (lastupdated.time() != time.min and fileupdated > lastupdated):
-                        raise NotGoingToDownload(_("Not Overwriting, web site is not newer."),'edit-undo.png')
+                        raise NotGoingToDownload(_("Not Overwriting, web site is not newer."),'edit-undo.png',showerror=False)
 
                 
                 logger.info("write to %s"%outfile)
                 inject_cal_cols(book,story,configuration)
                 writer.writeStory(outfilename=outfile, forceOverwrite=True)
                 
-                book['comment'] = 'Download %s completed, %s chapters.'%(options['fileform'],story.getMetadata("numChapters"))
+                book['comment'] = _('Download %s completed, %s chapters.')%(options['fileform'],story.getMetadata("numChapters"))
                 book['all_metadata'] = story.getAllMetadata(removeallentities=True)
                 if options['savemetacol'] != '':
                     book['savemetacol'] = story.dump_html_metadata()
@@ -253,7 +259,7 @@ def do_download_for_worker(book,options,merge,notification=lambda x,y:x):
                             book['outfile'] = book['epub_for_update'] # for anthology merge ops.
                             return book
                         else: # not merge,
-                            raise NotGoingToDownload(_("Already contains %d chapters.")%chaptercount,'edit-undo.png')
+                            raise NotGoingToDownload(_("Already contains %d chapters.")%chaptercount,'edit-undo.png',showerror=False)
                     elif chaptercount > urlchaptercount:
                         raise NotGoingToDownload(_("Existing epub contains %d chapters, web site only has %d. Use Overwrite to force update.") % (chaptercount,urlchaptercount),'dialog_error.png')
                     elif chaptercount == 0:
@@ -304,6 +310,7 @@ def do_download_for_worker(book,options,merge,notification=lambda x,y:x):
             
         except NotGoingToDownload as d:
             book['good']=False
+            book['showerror']=d.showerror
             book['comment']=unicode(d)
             book['icon'] = d.icon
     
@@ -311,7 +318,7 @@ def do_download_for_worker(book,options,merge,notification=lambda x,y:x):
             book['good']=False
             book['comment']=unicode(e)
             book['icon']='dialog_error.png'
-            book['status'] = 'Error'
+            book['status'] = _('Error')
             logger.info("Exception: %s:%s"%(book,unicode(e)))
             traceback.print_exc()
             

calibre-plugin/plugin-defaults.ini

@@ -1,4 +1,4 @@
-# Copyright 2015 Fanficdownloader team, 2015 FanFicFare team
+# Copyright 2015 Fanficdownloader team, 2016 FanFicFare team
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -488,6 +488,33 @@ description_limit:500
 ## in the ebook for that chapter.
 continue_on_chapter_error:false
 
+## When given a thread URL, use threadmarks as chapter links when
+## there are at least this many threadmarks.  A number of older
+## threads have a single threadmark to an 'index' post.  Set to 1 to
+## use threadmarks whenever they exist.
+minimum_threadmarks:2
+
+## When 'first post' (or post URL) is being added as a chapter, give
+## the chapter this title.
+first_post_title:First Post
+
+## In normal operation, if given a post URL or a thread URL with less
+## than minimum_threadmarks, the given post or the first post of the
+## thread will be included as the first chapter (with chapter title
+## from first_post_title) unless that post is explicitly linked to in
+## the collected chapter list.  First post is not included when using
+## thread marks.
+##
+## If always_include_first_post:true, then the given or first post
+## will be included as above even if it is a link in the post or even
+## if threadmarks are used.  Can result in a duplicated chapter.
+always_include_first_post:false
+
+## In normal operation, forumtags will only be populated when
+## threadmarks are used for chapters (see minimum_threadmarks above).
+## When always_use_forumtags:true, always populate forumtags.
+always_use_forumtags:false
+
 ## Each output format has a section that overrides [defaults]
 [html]
 
@@ -1193,14 +1220,41 @@ dislikes_label:Dislikes
 ## program can prompt you, or you can save it in config.  In
 ## commandline version, this should go in your personal.ini, not
 ## defaults.ini.
-#username:YourName
+## finestories.com has started requiring login by email rather than
+## pen name.
+#username:youremail@yourdomain.dom
 #password:yourpassword
 
-# shows size as "10 KB", not word count
-extra_valid_entries:size
+## Clear FanFiction from defaults, site is original fiction.
+extratags:
 
-# don't show twitter icon.
-cover_exclusion_regexp:/res/css/bir.png
+extra_valid_entries:size,universe,universeUrl,universeHTML,sitetags,notice,codes,score
+#extra_titlepage_entries:size,universeHTML,sitetags,notice,score
+include_in_codes:sitetags
+
+## adds to include_subject_tags instead of replacing it.
+#extra_subject_tags:sitetags
+
+size_label:Size
+universe_label:Universe
+universeUrl_label:Universe URL
+universeHTML_label:Universe
+sitetags_label:Site Tags
+notice_label:Notice
+score_label:Score
+
+## Assume entryUrl, apply to "<a class='%slink' href='%s'>%s</a>" to
+## make entryHTML.
+make_linkhtml_entries:universe
+
+## storiesonline.net stories can be in a series or a universe, but not
+## both.  By default, universe will be populated in 'series' with
+## index=0
+universe_as_series: true
+
+## some sites include images that we don't ever want becoming the
+## cover image.  This lets you exclude them.
+cover_exclusion_regexp:/css/bir.png
 
 [forums.spacebattles.com]
 ## see [base_xenforoforum]
@@ -1280,9 +1334,21 @@ crossoverfandom_label:Crossover Fandom
 extra_titlepage_entries:universe,crossoverfandom
 
 [literotica.com]
-extra_valid_entries:eroticatags
+extra_valid_entries:eroticatags,averrating
 eroticatags_label:Erotica Tags
-extra_titlepage_entries: eroticatags
+averrating_label:Average Rating
+extra_titlepage_entries:eroticatags,averrating
+
+## Extract more erotica_tags from the meta tag of each chapter
+use_meta_keywords: true
+
+## For multiple chapter stories, attempt to clean up the chapter title. This will
+## remove the story title and change "Ch. 01" to "Chapter 1", "Pt. 01" to "Part 1"
+## or just use the text. If this can't be done, the full title is used.
+clean_chapter_titles: false
+
+## Add the chapter description at the start of each chapter.
+description_in_chapter: false
 
 [lotrfanfiction.com]
 extra_valid_entries: readings
@@ -1909,6 +1975,9 @@ extracategories:Harry Potter
 ## Site dedicated to these categories/characters/ships
 extracategories:Harry Potter
 
+extra_valid_entries:reads,reviews
+reads_label:Total Read Count
+
 [www.hpfanficarchive.com]
 ## Site dedicated to these categories/characters/ships
 extracategories:Harry Potter
@@ -2227,6 +2296,96 @@ extracategories:Stargate: Atlantis
 extra_valid_entries:reviews
 reviews_label:Reviews
 
+[buffygiles.velocitygrass.com]
+## Some sites do not require a login, but do require the user to
+## confirm they are adult for adult content.  In commandline version,
+## this should go in your personal.ini, not defaults.ini.
+#is_adult:true
+
+## Some sites require login (or login for some rated stories) The
+## program can prompt you, or you can save it in config.  In
+## commandline version, this should go in your personal.ini, not
+## defaults.ini.
+#username:YourName
+#password:yourpassword
+
+## Site dedicated to these categories/characters/ships
+extracharacters:Buffy,Giles
+
+[fanfiction.lucifael.com]
+## Some sites do not require a login, but do require the user to
+## confirm they are adult for adult content.  In commandline version,
+## this should go in your personal.ini, not defaults.ini.
+#is_adult:true
+
+## Some sites require login (or login for some rated stories) The
+## program can prompt you, or you can save it in config.  In
+## commandline version, this should go in your personal.ini, not
+## defaults.ini.
+#username:YourName
+#password:yourpassword
+
+[www.andromeda-web.com]
+## Some sites do not require a login, but do require the user to
+## confirm they are adult for adult content.  In commandline version,
+## this should go in your personal.ini, not defaults.ini.
+#is_adult:true
+
+## Some sites require login (or login for some rated stories) The
+## program can prompt you, or you can save it in config.  In
+## commandline version, this should go in your personal.ini, not
+## defaults.ini.
+#username:YourName
+#password:yourpassword
+
+## Site dedicated to these categories/characters/ships
+extracategories:Andromeda
+
+[www.artemis-fowl.com]
+## Some sites do not require a login, but do require the user to
+## confirm they are adult for adult content.  In commandline version,
+## this should go in your personal.ini, not defaults.ini.
+#is_adult:true
+
+## Some sites require login (or login for some rated stories) The
+## program can prompt you, or you can save it in config.  In
+## commandline version, this should go in your personal.ini, not
+## defaults.ini.
+#username:YourName
+#password:yourpassword
+
+## Site dedicated to these categories/characters/ships
+extracategories:Artemis Fowl
+
+[www.therabidreader.com]
+## Some sites do not require a login, but do require the user to
+## confirm they are adult for adult content.  In commandline version,
+## this should go in your personal.ini, not defaults.ini.
+#is_adult:true
+
+## Some sites require login (or login for some rated stories) The
+## program can prompt you, or you can save it in config.  In
+## commandline version, this should go in your personal.ini, not
+## defaults.ini.
+#username:YourName
+#password:yourpassword
+
+
+[www.naiceanilme.net]
+## Some sites do not require a login, but do require the user to
+## confirm they are adult for adult content.  In commandline version,
+## this should go in your personal.ini, not defaults.ini.
+#is_adult:true
+
+## Some sites require login (or login for some rated stories) The
+## program can prompt you, or you can save it in config.  In
+## commandline version, this should go in your personal.ini, not
+## defaults.ini.
+#username:YourName
+#password:yourpassword
+
+
+
 [overrides]
 ## It may sometimes be useful to override all of the specific format,
 ## site and site:format sections in your private configuration.  For

calibre-plugin/prefs.py

@@ -158,6 +158,7 @@ default_prefs['countpagesstats'] = []
 default_prefs['wordcountmissing'] = False
 
 default_prefs['errorcol'] = ''
+default_prefs['save_all_errors'] = True
 default_prefs['savemetacol'] = ''
 default_prefs['custom_cols'] = {}
 default_prefs['custom_cols_newonly'] = {}

fanficfare/__init__.py

@@ -27,7 +27,7 @@ except:
             import logging
             logger = logging.getLogger(__name__)
             loghandler=logging.StreamHandler()
-            loghandler.setFormatter(logging.Formatter("FFF:%(levelname)s:%(filename)s(%(lineno)d):%(message)s"))
+            loghandler.setFormatter(logging.Formatter("FFF: %(levelname)s: %(asctime)s: %(filename)s(%(lineno)d): %(message)s"))
             logger.addHandler(loghandler)
             loghandler.setLevel(logging.DEBUG)
             logger.setLevel(logging.DEBUG)

fanficfare/adapters/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright 2011 Fanficdownloader team, 2015 FanFicFare team
+# Copyright 2011 Fanficdownloader team, 2016 FanFicFare team
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -140,6 +140,14 @@ import adapter_masseffect2in
 import adapter_quotevcom
 import adapter_mcstoriescom
 
+import adapter_lucifaelff
+import adapter_buffygilescom
+#import adapter_rubyquillcom
+import adapter_andromedawebcom # Not all lables are captured
+import adapter_artemisfowlcom
+import adapter_rabidreadercom
+import adapter_naiceanilmenet
+
 ## This bit of complexity allows adapters to be added by just adding
 ## importing.  It eliminates the long if/else clauses we used to need
 ## to pick out the adapter.
@@ -169,8 +177,9 @@ def getNormalStoryURL(url):
         return None
 
 def getNormalStoryURLSite(url):
+    # print("getNormalStoryURLSite:%s"%url)
     if not getNormalStoryURL.__dummyconfig:
-        getNormalStoryURL.__dummyconfig = Configuration("test1.com","EPUB")
+        getNormalStoryURL.__dummyconfig = Configuration(["test1.com"],"EPUB",lightweight=True)
     # pulling up an adapter is pretty low over-head.  If
     # it fails, it's a bad url.
     try:

fanficfare/adapters/adapter_andromedawebcom.py

@@ -0,0 +1,302 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2016 FanFicFare team
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# ####### Not all lables are captured. they are not formtted correctly on the 
+# #######  webpage.
+
+# Software: eFiction
+import time
+import logging
+logger = logging.getLogger(__name__)
+import re
+import urllib2
+
+
+from ..htmlcleanup import stripHTML
+from .. import exceptions as exceptions
+
+from base_adapter import BaseSiteAdapter,  makeDate
+
+def getClass():
+    return AndromedaWebComAdapter # XXX
+
+# Class name has to be unique.  Our convention is camel case the
+# sitename with Adapter at the end.  www is skipped.
+class AndromedaWebComAdapter(BaseSiteAdapter):  # XXX
+
+    def __init__(self, config, url):
+        BaseSiteAdapter.__init__(self, config, url)
+
+        self.decode = ["Windows-1252",
+                       "utf8"] # 1252 is a superset of iso-8859-1.
+                               # Most sites that claim to be
+                               # iso-8859-1 (and some that claim to be
+                               # utf8) are really windows-1252.
+        self.username = "NoneGiven" # if left empty, site doesn't return any message at all.
+        self.password = ""
+        self.is_adult=False
+
+        # get storyId from url--url validation guarantees query is only sid=1234
+        self.story.setMetadata('storyId',self.parsedUrl.query.split('=',)[1])
+
+
+        # normalized story URL.
+        # XXX Most sites don't have the /fiction part.  Replace all to remove it usually.
+        self._setURL('http://' + self.getSiteDomain() + '/fiction/viewstory.php?sid='+self.story.getMetadata('storyId'))
+
+        # Each adapter needs to have a unique site abbreviation.
+        self.story.setMetadata('siteabbrev','awc') # XXX
+
+        # The date format will vary from site to site.
+        # http://docs.python.org/library/datetime.html#strftime-strptime-behavior
+        self.dateformat = "%d %b %Y" # XXX
+
+    @staticmethod # must be @staticmethod, don't remove it.
+    def getSiteDomain():
+        # The site domain.  Does have www here, if it uses it.
+        return 'www.andromeda-web.com'  # XXX
+
+    @classmethod
+    def getSiteExampleURLs(cls):
+        return "http://"+cls.getSiteDomain()+"/fiction/viewstory.php?sid=1234"
+
+    def getSiteURLPattern(self):
+        return re.escape("http://"+self.getSiteDomain()+"/fiction/viewstory.php?sid=")+r"\d+$"
+
+    ## Login seems to be reasonably standard across eFiction sites.
+    def needToLoginCheck(self, data):
+        if 'Registered Users Only' in data \
+                or 'There is no such account on our website' in data \
+                or "That password doesn't match the one in our database" in data:
+            return True
+        else:
+            return False
+
+    def performLogin(self, url):
+        params = {}
+
+        if self.password:
+            params['penname'] = self.username
+            params['password'] = self.password
+        else:
+            params['penname'] = self.getConfig("username")
+            params['password'] = self.getConfig("password")
+        params['cookiecheck'] = '1'
+        params['submit'] = 'Submit'
+
+        loginUrl = 'http://' + self.getSiteDomain() + '/user.php?action=login'
+        logger.debug("Will now login to URL (%s) as (%s)" % (loginUrl,
+                                                              params['penname']))
+
+        d = self._fetchUrl(loginUrl, params)
+
+        if "Member Account" not in d : #Member Account
+            logger.info("Failed to login to URL %s as %s" % (loginUrl,
+                                                              params['penname']))
+            raise exceptions.FailedToLogin(url,params['penname'])
+            return False
+        else:
+            return True
+
+    ## Getting the chapter list and the meta data, plus 'is adult' checking.
+    def extractChapterUrlsAndMetadata(self):
+
+        if self.is_adult or self.getConfig("is_adult"):
+            # Weirdly, different sites use different warning numbers.
+            # If the title search below fails, there's a good chance
+            # you need a different number.  print data at that point
+            # and see what the 'click here to continue' url says.
+            addurl = "&warning=2"
+        else:
+            addurl=""
+
+        # index=1 makes sure we see the story chapter index.  Some
+        # sites skip that for one-chapter stories.
+        url = self.url+'&index=1'+addurl
+        logger.debug("URL: "+url)
+
+        try:
+            data = self._fetchUrl(url)
+        except urllib2.HTTPError, e:
+            if e.code == 404:
+                raise exceptions.StoryDoesNotExist(self.url)
+            else:
+                raise e
+
+        if self.needToLoginCheck(data):
+            # need to log in for this one.
+            self.performLogin(url)
+            data = self._fetchUrl(url)
+
+        # Since the warning text can change by warning level, let's
+        # look for the warning pass url.  ksarchive uses
+        # &warning= -- actually, so do other sites.  Must be an
+        # eFiction book.
+
+        # fiction/viewstory.php?sid=1882&warning=4
+        # fiction/viewstory.php?sid=1654&ageconsent=ok&warning=2
+        #print data
+        m = re.search(r"'fiction/viewstory.php\?sid=10(&warning=2)'",data)
+        m = re.search(r"'fiction/viewstory.php\?sid=\d+((?:&ageconsent=ok)?&warning=\d+)'",data)
+        if m != None:
+            if self.is_adult or self.getConfig("is_adult"):
+                # We tried the default and still got a warning, so
+                # let's pull the warning number from the 'continue'
+                # link and reload data.
+                addurl = m.group(1)
+                # correct stupid & error in url.
+                addurl = addurl.replace("&","&")
+                url = self.url+'&index=1'+addurl
+                logger.debug("URL 2nd try: "+url)
+
+                try:
+                    data = self._fetchUrl(url)
+                except urllib2.HTTPError, e:
+                    if e.code == 404:
+                        raise exceptions.StoryDoesNotExist(self.url)
+                    else:
+                        raise e
+            else:
+                raise exceptions.AdultCheckRequired(self.url)
+
+        if "Access denied. This story has not been validated by the adminstrators of this site." in data:
+            raise exceptions.FailedToDownload(self.getSiteDomain() +" says: Access denied. This story has not been validated by the adminstrators of this site.")
+
+        # use BeautifulSoup HTML parser to make everything easier to find.
+        soup = self.make_soup(data)
+        # print data
+
+        # Now go hunting for all the meta data and the chapter list.
+
+        pagetitle = soup.find('div',{'id':'content'})
+
+        ## Title
+        a = pagetitle.find('a', href=re.compile(r'viewstory.php\?sid='+self.story.getMetadata('storyId')+"$"))
+
+        self.story.setMetadata('title',stripHTML(a))
+
+        # Find authorid and URL from... author url.
+        a = pagetitle.find('a', href=re.compile(r"viewuser.php\?uid=\d+"))
+        self.story.setMetadata('authorId',a['href'].split('=')[1])
+        self.story.setMetadata('authorUrl','http://'+self.host+'/'+a['href'])
+        self.story.setMetadata('author',a.string)
+
+        # Find the chapters:
+        for chapter in soup.findAll('a', href=re.compile(r'viewstory.php\?sid='+self.story.getMetadata('storyId')+"&chapter=\d+$")):
+            # just in case there's tags, like <i> in chapter titles.
+            self.chapterUrls.append((stripHTML(chapter),'http://'+self.host+'/fiction/'+chapter['href']+addurl))
+
+            self.story.setMetadata('numChapters',len(self.chapterUrls))
+
+        # eFiction sites don't help us out a lot with their meta data
+        # formating, so it's a little ugly.
+
+        # utility method
+        def defaultGetattr(d,k):
+            try:
+                return d[k]
+            except:
+                return ""
+
+        # <span class="label">Rated:</span> NC-17<br /> etc
+        labels = soup.findAll('span',{'class':'label'})
+        for labelspan in labels:
+            value = labelspan.nextSibling
+            label = labelspan.string
+
+            if 'Summary' in label:
+                ## Everything until the next span class='label'
+                svalue = ""
+                while 'label' not in defaultGetattr(value,'class'):
+                    svalue += unicode(value)
+                    value = value.nextSibling
+                self.setDescription(url,svalue)
+                #self.story.setMetadata('description',stripHTML(svalue))
+
+            if 'Rated' in label:
+                self.story.setMetadata('rating', value)
+
+            if 'Word count' in label:
+                self.story.setMetadata('numWords', value)
+
+            if 'Categories' in label:
+                cats = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=categories'))
+                for cat in cats:
+                    self.story.addToList('category',cat.string)
+
+            if 'Characters' in label:
+                chars = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=characters'))
+                for char in chars:
+                    self.story.addToList('characters',char.string)
+
+            if 'Genre' in label:
+                genres = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=class&type_id=1'))
+                for genre in genres:
+                    self.story.addToList('genre',genre.string)
+
+            if 'Warnings' in label:
+                warnings = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=class&type_id=3'))
+                for warning in warnings:
+                    self.story.addToList('warnings',warning.string)
+
+            if 'Completed' in label:
+                if 'Yes' in value:
+                    self.story.setMetadata('status', 'Completed')
+                else:
+                    self.story.setMetadata('status', 'In-Progress')
+
+            if 'Published' in label:
+                self.story.setMetadata('datePublished', makeDate(stripHTML(value), self.dateformat))
+
+            if 'Updated' in label:
+                # there's a stray [ at the end.
+                #value = value[0:-1]
+                self.story.setMetadata('dateUpdated', makeDate(stripHTML(value), self.dateformat))
+
+        try:
+            # Find Series name from series URL.
+            a = soup.find('a', href=re.compile(r"fiction/viewseries.php\?seriesid=\d+"))
+            series_name = a.string
+            series_url = 'http://'+self.host+'/'+a['href']
+
+            # use BeautifulSoup HTML parser to make everything easier to find.
+            seriessoup = self.make_soup(self._fetchUrl(series_url))
+            storyas = seriessoup.findAll('a', href=re.compile(r'^fiction/viewstory.php\?sid=\d+$'))
+            i=1
+            for a in storyas:
+                if a['href'] == ('fiction/viewstory.php?sid='+self.story.getMetadata('storyId')):
+                    self.setSeries(series_name, i)
+                    self.story.setMetadata('seriesUrl',series_url)
+                    break
+                i+=1
+
+        except:
+            # I find it hard to care if the series parsing fails
+            pass
+        
+    # grab the text for an individual chapter.
+    def getChapterText(self, url):
+
+        logger.debug('Getting chapter text from: %s' % url)
+
+        soup = self.make_soup(self._fetchUrl(url))
+
+        div = soup.find('div', {'class' : 'story'})
+
+        if None == div:
+            raise exceptions.FailedToDownload("Error downloading Chapter: %s!  Missing required element!" % url)
+
+        return self.utf8FromSoup(url,div)

fanficfare/adapters/adapter_artemisfowlcom.py

@@ -0,0 +1,302 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2016 FanFicFare team
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# ####### Not all lables are captured. they are not formtted correctly on the 
+# #######  webpage.
+
+# Software: eFiction
+import time
+import logging
+logger = logging.getLogger(__name__)
+import re
+import urllib2
+
+
+from ..htmlcleanup import stripHTML
+from .. import exceptions as exceptions
+
+from base_adapter import BaseSiteAdapter,  makeDate
+
+def getClass():
+    return ArtemisFowlComAdapter # XXX
+
+# Class name has to be unique.  Our convention is camel case the
+# sitename with Adapter at the end.  www is skipped.
+class ArtemisFowlComAdapter(BaseSiteAdapter):  # XXX
+
+    def __init__(self, config, url):
+        BaseSiteAdapter.__init__(self, config, url)
+
+        self.decode = ["Windows-1252",
+                       "utf8"] # 1252 is a superset of iso-8859-1.
+                               # Most sites that claim to be
+                               # iso-8859-1 (and some that claim to be
+                               # utf8) are really windows-1252.
+        self.username = "NoneGiven" # if left empty, site doesn't return any message at all.
+        self.password = ""
+        self.is_adult=False
+
+        # get storyId from url--url validation guarantees query is only sid=1234
+        self.story.setMetadata('storyId',self.parsedUrl.query.split('=',)[1])
+
+
+        # normalized story URL.
+        # XXX Most sites don't have the /fiction part.  Replace all to remove it usually.
+        self._setURL('http://' + self.getSiteDomain() + '/fanfiction/viewstory.php?sid='+self.story.getMetadata('storyId'))
+
+        # Each adapter needs to have a unique site abbreviation.
+        self.story.setMetadata('siteabbrev','afcff') # XXX
+
+        # The date format will vary from site to site.
+        # http://docs.python.org/library/datetime.html#strftime-strptime-behavior
+        self.dateformat = "%d/%m/%y" # XXX
+
+    @staticmethod # must be @staticmethod, don't remove it.
+    def getSiteDomain():
+        # The site domain.  Does have www here, if it uses it.
+        return 'www.artemis-fowl.com'  # XXX
+
+    @classmethod
+    def getSiteExampleURLs(cls):
+        return "http://"+cls.getSiteDomain()+"/fanfiction/viewstory.php?sid=1234"
+
+    def getSiteURLPattern(self):
+        return re.escape("http://"+self.getSiteDomain()+"/fanfiction/viewstory.php?sid=")+r"\d+$"
+
+    ## Login seems to be reasonably standard across eFiction sites.
+    def needToLoginCheck(self, data):
+        if 'Registered Users Only' in data \
+                or 'There is no such account on our website' in data \
+                or "That password doesn't match the one in our database" in data:
+            return True
+        else:
+            return False
+
+    def performLogin(self, url):
+        params = {}
+
+        if self.password:
+            params['penname'] = self.username
+            params['password'] = self.password
+        else:
+            params['penname'] = self.getConfig("username")
+            params['password'] = self.getConfig("password")
+        params['cookiecheck'] = '1'
+        params['submit'] = 'Submit'
+
+        loginUrl = 'http://' + self.getSiteDomain() + '/user.php?action=login'
+        logger.debug("Will now login to URL (%s) as (%s)" % (loginUrl,
+                                                              params['penname']))
+
+        d = self._fetchUrl(loginUrl, params)
+
+        if "Member Account" not in d : #Member Account
+            logger.info("Failed to login to URL %s as %s" % (loginUrl,
+                                                              params['penname']))
+            raise exceptions.FailedToLogin(url,params['penname'])
+            return False
+        else:
+            return True
+
+    ## Getting the chapter list and the meta data, plus 'is adult' checking.
+    def extractChapterUrlsAndMetadata(self):
+
+        if self.is_adult or self.getConfig("is_adult"):
+            # Weirdly, different sites use different warning numbers.
+            # If the title search below fails, there's a good chance
+            # you need a different number.  print data at that point
+            # and see what the 'click here to continue' url says.
+            addurl = "&warning=5"
+        else:
+            addurl=""
+
+        # index=1 makes sure we see the story chapter index.  Some
+        # sites skip that for one-chapter stories.
+        url = self.url+'&index=1'+addurl
+        logger.debug("URL: "+url)
+
+        try:
+            data = self._fetchUrl(url)
+        except urllib2.HTTPError, e:
+            if e.code == 404:
+                raise exceptions.StoryDoesNotExist(self.url)
+            else:
+                raise e
+
+        if self.needToLoginCheck(data):
+            # need to log in for this one.
+            self.performLogin(url)
+            data = self._fetchUrl(url)
+
+        # Since the warning text can change by warning level, let's
+        # look for the warning pass url.  ksarchive uses
+        # &warning= -- actually, so do other sites.  Must be an
+        # eFiction book.
+
+        # fanfiction/viewstory.php?sid=1882&warning=4
+        # fanfiction/viewstory.php?sid=1654&ageconsent=ok&warning=2
+        #print data
+        m = re.search(r"'fanfiction/viewstory.php\?sid=10(&warning=5)'",data)
+        m = re.search(r"'fanfiction/viewstory.php\?sid=\d+((?:&ageconsent=ok)?&warning=\d+)'",data)
+        if m != None:
+            if self.is_adult or self.getConfig("is_adult"):
+                # We tried the default and still got a warning, so
+                # let's pull the warning number from the 'continue'
+                # link and reload data.
+                addurl = m.group(1)
+                # correct stupid & error in url.
+                addurl = addurl.replace("&","&")
+                url = self.url+'&index=1'+addurl
+                logger.debug("URL 2nd try: "+url)
+
+                try:
+                    data = self._fetchUrl(url)
+                except urllib2.HTTPError, e:
+                    if e.code == 404:
+                        raise exceptions.StoryDoesNotExist(self.url)
+                    else:
+                        raise e
+            else:
+                raise exceptions.AdultCheckRequired(self.url)
+
+        if "Access denied. This story has not been validated by the adminstrators of this site." in data:
+            raise exceptions.FailedToDownload(self.getSiteDomain() +" says: Access denied. This story has not been validated by the adminstrators of this site.")
+
+        # use BeautifulSoup HTML parser to make everything easier to find.
+        soup = self.make_soup(data)
+        # print data
+
+        # Now go hunting for all the meta data and the chapter list.
+
+        pagetitle = soup.find('div',{'id':'pagetitle'})
+
+        ## Title
+        a = pagetitle.find('a', href=re.compile(r'viewstory.php\?sid='+self.story.getMetadata('storyId')+"$"))
+
+        self.story.setMetadata('title',stripHTML(a))
+
+        # Find authorid and URL from... author url.
+        a = pagetitle.find('a', href=re.compile(r"viewuser.php\?uid=\d+"))
+        self.story.setMetadata('authorId',a['href'].split('=')[1])
+        self.story.setMetadata('authorUrl','http://'+self.host+'/'+a['href'])
+        self.story.setMetadata('author',a.string)
+
+        # Find the chapters:
+        for chapter in soup.findAll('a', href=re.compile(r'viewstory.php\?sid='+self.story.getMetadata('storyId')+"&chapter=\d+$")):
+            # just in case there's tags, like <i> in chapter titles.
+            self.chapterUrls.append((stripHTML(chapter),'http://'+self.host+'/fanfiction/'+chapter['href']+addurl))
+
+            self.story.setMetadata('numChapters',len(self.chapterUrls))
+
+        # eFiction sites don't help us out a lot with their meta data
+        # formating, so it's a little ugly.
+
+        # utility method
+        def defaultGetattr(d,k):
+            try:
+                return d[k]
+            except:
+                return ""
+
+        # <span class="label">Rated:</span> NC-17<br /> etc
+        labels = soup.findAll('span',{'class':'label'})
+        for labelspan in labels:
+            value = labelspan.nextSibling
+            label = labelspan.string
+
+            if 'Summary' in label:
+                ## Everything until the next span class='label'
+                svalue = ""
+                while 'label' not in defaultGetattr(value,'class'):
+                    svalue += unicode(value)
+                    value = value.nextSibling
+                self.setDescription(url,svalue)
+                #self.story.setMetadata('description',stripHTML(svalue))
+
+            if 'Rated' in label:
+                self.story.setMetadata('rating', value)
+
+            if 'Word count' in label:
+                self.story.setMetadata('numWords', value)
+
+            if 'Categories' in label:
+                cats = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=categories'))
+                for cat in cats:
+                    self.story.addToList('category',cat.string)
+
+            if 'Characters' in label:
+                chars = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=characters'))
+                for char in chars:
+                    self.story.addToList('characters',char.string)
+
+            if 'Genre' in label:
+                genres = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=class&type_id=1'))
+                for genre in genres:
+                    self.story.addToList('genre',genre.string)
+
+            if 'Warnings' in label:
+                warnings = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=class&type_id=3'))
+                for warning in warnings:
+                    self.story.addToList('warnings',warning.string)
+
+            if 'Completed' in label:
+                if 'Yes' in value:
+                    self.story.setMetadata('status', 'Completed')
+                else:
+                    self.story.setMetadata('status', 'In-Progress')
+
+            if 'Published' in label:
+                self.story.setMetadata('datePublished', makeDate(stripHTML(value), self.dateformat))
+
+            if 'Updated' in label:
+                # there's a stray [ at the end.
+                #value = value[0:-1]
+                self.story.setMetadata('dateUpdated', makeDate(stripHTML(value), self.dateformat))
+
+        try:
+            # Find Series name from series URL.
+            a = soup.find('a', href=re.compile(r"fanfiction/viewseries.php\?seriesid=\d+"))
+            series_name = a.string
+            series_url = 'http://'+self.host+'/'+a['href']
+
+            # use BeautifulSoup HTML parser to make everything easier to find.
+            seriessoup = self.make_soup(self._fetchUrl(series_url))
+            storyas = seriessoup.findAll('a', href=re.compile(r'^fanfiction/viewstory.php\?sid=\d+$'))
+            i=1
+            for a in storyas:
+                if a['href'] == ('fanfiction/viewstory.php?sid='+self.story.getMetadata('storyId')):
+                    self.setSeries(series_name, i)
+                    self.story.setMetadata('seriesUrl',series_url)
+                    break
+                i+=1
+
+        except:
+            # I find it hard to care if the series parsing fails
+            pass
+        
+    # grab the text for an individual chapter.
+    def getChapterText(self, url):
+
+        logger.debug('Getting chapter text from: %s' % url)
+
+        soup = self.make_soup(self._fetchUrl(url))
+
+        div = soup.find('div', {'id' : 'story'})
+
+        if None == div:
+            raise exceptions.FailedToDownload("Error downloading Chapter: %s!  Missing required element!" % url)
+
+        return self.utf8FromSoup(url,div)

fanficfare/adapters/adapter_buffygilescom.py

@@ -0,0 +1,300 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2016 FanFicFare team
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# Software: eFiction
+import time
+import logging
+logger = logging.getLogger(__name__)
+import re
+import urllib2
+
+
+from ..htmlcleanup import stripHTML
+from .. import exceptions as exceptions
+
+from base_adapter import BaseSiteAdapter,  makeDate
+
+def getClass():
+    return BuffyGilesComAdapter
+
+# Class name has to be unique.  Our convention is camel case the
+# sitename with Adapter at the end.  www is skipped.
+class BuffyGilesComAdapter(BaseSiteAdapter):
+
+    def __init__(self, config, url):
+        BaseSiteAdapter.__init__(self, config, url)
+
+        self.decode = ["Windows-1252",
+                       "utf8"] # 1252 is a superset of iso-8859-1.
+                               # Most sites that claim to be
+                               # iso-8859-1 (and some that claim to be
+                               # utf8) are really windows-1252.
+        self.username = "NoneGiven" # if left empty, site doesn't return any message at all.
+        self.password = ""
+        self.is_adult=False
+
+        # get storyId from url--url validation guarantees query is only sid=1234
+        self.story.setMetadata('storyId',self.parsedUrl.query.split('=',)[1])
+
+
+        # normalized story URL.
+        # XXX Most sites don't have the /efiction part.  Replace all to remove it usually.
+        self._setURL('http://' + self.getSiteDomain() + '/efiction/viewstory.php?sid='+self.story.getMetadata('storyId'))
+
+        # Each adapter needs to have a unique site abbreviation.
+        self.story.setMetadata('siteabbrev','bufg')
+
+        # The date format will vary from site to site.
+        # http://docs.python.org/library/datetime.html#strftime-strptime-behavior
+        self.dateformat = "%d/%m/%y"
+
+    @staticmethod # must be @staticmethod, don't remove it.
+    def getSiteDomain():
+        # The site domain.  Does have www here, if it uses it.
+        return 'buffygiles.velocitygrass.com'
+
+    @classmethod
+    def getSiteExampleURLs(cls):
+        return "http://"+cls.getSiteDomain()+"/efiction/viewstory.php?sid=1234"
+
+    def getSiteURLPattern(self):
+        return re.escape("http://"+self.getSiteDomain()+"/efiction/viewstory.php?sid=")+r"\d+$"
+
+    ## Login seems to be reasonably standard across eFiction sites.
+    def needToLoginCheck(self, data):
+        if 'Registered Users Only' in data \
+                or 'There is no such account on our website' in data \
+                or "That password doesn't match the one in our database" in data:
+            return True
+        else:
+            return False
+
+    def performLogin(self, url):
+        params = {}
+
+        if self.password:
+            params['penname'] = self.username
+            params['password'] = self.password
+        else:
+            params['penname'] = self.getConfig("username")
+            params['password'] = self.getConfig("password")
+        params['cookiecheck'] = '1'
+        params['submit'] = 'Submit'
+
+        loginUrl = 'http://' + self.getSiteDomain() + '/user.php?action=login'
+        logger.debug("Will now login to URL (%s) as (%s)" % (loginUrl,
+                                                              params['penname']))
+
+        d = self._fetchUrl(loginUrl, params)
+
+        if "Member Account" not in d : #Member Account
+            logger.info("Failed to login to URL %s as %s" % (loginUrl,
+                                                              params['penname']))
+            raise exceptions.FailedToLogin(url,params['penname'])
+            return False
+        else:
+            return True
+
+    ## Getting the chapter list and the meta data, plus 'is adult' checking.
+    def extractChapterUrlsAndMetadata(self):
+
+        if self.is_adult or self.getConfig("is_adult"):
+            # Weirdly, different sites use different warning numbers.
+            # If the title search below fails, there's a good chance
+            # you need a different number.  print data at that point
+            # and see what the 'click here to continue' url says.
+            addurl = "&warning=5"
+        else:
+            addurl=""
+
+        # index=1 makes sure we see the story chapter index.  Some
+        # sites skip that for one-chapter stories.
+        url = self.url+'&index=1'+addurl
+        logger.debug("URL: "+url)
+
+        try:
+            data = self._fetchUrl(url)
+        except urllib2.HTTPError, e:
+            if e.code == 404:
+                raise exceptions.StoryDoesNotExist(self.url)
+            else:
+                raise e
+
+        if self.needToLoginCheck(data):
+            # need to log in for this one.
+            self.performLogin(url)
+            data = self._fetchUrl(url)
+
+        # Since the warning text can change by warning level, let's
+        # look for the warning pass url.  ksarchive uses
+        # &warning= -- actually, so do other sites.  Must be an
+        # eFiction book.
+
+        # efiction/viewstory.php?sid=1882&warning=4
+        # efiction/viewstory.php?sid=1654&ageconsent=ok&warning=5
+        #print data
+        m = re.search(r"'efiction/viewstory.php\?sid=542(&warning=5)'",data)
+        m = re.search(r"'efiction/viewstory.php\?sid=\d+((?:&ageconsent=ok)?&warning=\d+)'",data)
+        if m != None:
+            if self.is_adult or self.getConfig("is_adult"):
+                # We tried the default and still got a warning, so
+                # let's pull the warning number from the 'continue'
+                # link and reload data.
+                addurl = m.group(1)
+                # correct stupid & error in url.
+                addurl = addurl.replace("&","&")
+                url = self.url+'&index=1'+addurl
+                logger.debug("URL 2nd try: "+url)
+
+                try:
+                    data = self._fetchUrl(url)
+                except urllib2.HTTPError, e:
+                    if e.code == 404:
+                        raise exceptions.StoryDoesNotExist(self.url)
+                    else:
+                        raise e
+            else:
+                raise exceptions.AdultCheckRequired(self.url)
+
+        if "Access denied. This story has not been validated by the adminstrators of this site." in data:
+            raise exceptions.FailedToDownload(self.getSiteDomain() +" says: Access denied. This story has not been validated by the adminstrators of this site.")
+
+        # use BeautifulSoup HTML parser to make everything easier to find.
+        soup = self.make_soup(data)
+        # print data
+
+        # Now go hunting for all the meta data and the chapter list.
+
+        pagetitle = soup.find('div',{'id':'pagetitle'})
+
+        ## Title
+        a = pagetitle.find('a', href=re.compile(r'viewstory.php\?sid='+self.story.getMetadata('storyId')+"$"))
+
+        self.story.setMetadata('title',stripHTML(a))
+
+        # Find authorid and URL from... author url.
+        a = pagetitle.find('a', href=re.compile(r"viewuser.php\?uid=\d+"))
+        self.story.setMetadata('authorId',a['href'].split('=')[1])
+        self.story.setMetadata('authorUrl','http://'+self.host+'/'+a['href'])
+        self.story.setMetadata('author',a.string)
+
+        # Find the chapters:
+        for chapter in soup.findAll('a', href=re.compile(r'viewstory.php\?sid='+self.story.getMetadata('storyId')+"&chapter=\d+$")):
+            # just in case there's tags, like <i> in chapter titles.
+            self.chapterUrls.append((stripHTML(chapter),'http://'+self.host+'/efiction/'+chapter['href']+addurl))
+
+            self.story.setMetadata('numChapters',len(self.chapterUrls))
+
+        # eFiction sites don't help us out a lot with their meta data
+        # formating, so it's a little ugly.
+
+        # utility method
+        def defaultGetattr(d,k):
+            try:
+                return d[k]
+            except:
+                return ""
+
+        # <span class="label">Rated:</span> NC-17<br /> etc
+        labels = soup.findAll('span',{'class':'label'})
+        for labelspan in labels:
+            value = labelspan.nextSibling
+            label = labelspan.string
+
+            if 'Summary' in label:
+                ## Everything until the next span class='label'
+                svalue = ""
+                while 'label' not in defaultGetattr(value,'class'):
+                    svalue += unicode(value)
+                    value = value.nextSibling
+                self.setDescription(url,svalue)
+                #self.story.setMetadata('description',stripHTML(svalue))
+
+            if 'Rated' in label:
+                self.story.setMetadata('rating', value)
+
+            if 'Word count' in label:
+                self.story.setMetadata('numWords', value)
+
+            if 'Categories' in label:
+                cats = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=categories'))
+                for cat in cats:
+                    self.story.addToList('category',cat.string)
+
+            if 'Characters' in label:
+                chars = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=characters'))
+                for char in chars:
+                    self.story.addToList('characters',char.string)
+
+            if 'Genre' in label:
+                genres = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=class&type_id=1'))
+                for genre in genres:
+                    self.story.addToList('genre',genre.string)
+
+            if 'Warnings' in label:
+                warnings = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=class&type_id=3'))
+                for warning in warnings:
+                    self.story.addToList('warnings',warning.string)
+
+            if 'Completed' in label:
+                if 'Yes' in value:
+                    self.story.setMetadata('status', 'Completed')
+                else:
+                    self.story.setMetadata('status', 'In-Progress')
+
+            if 'Published' in label:
+                self.story.setMetadata('datePublished', makeDate(stripHTML(value), self.dateformat))
+
+            if 'Updated' in label:
+                # there's a stray [ at the end.
+                #value = value[0:-1]
+                self.story.setMetadata('dateUpdated', makeDate(stripHTML(value), self.dateformat))
+
+        try:
+            # Find Series name from series URL.
+            a = soup.find('a', href=re.compile(r"efiction/viewseries.php\?seriesid=\d+"))
+            series_name = a.string
+            series_url = 'http://'+self.host+'/'+a['href']
+
+            # use BeautifulSoup HTML parser to make everything easier to find.
+            seriessoup = self.make_soup(self._fetchUrl(series_url))
+            storyas = seriessoup.findAll('a', href=re.compile(r'^efiction/viewstory.php\?sid=\d+$'))
+            i=1
+            for a in storyas:
+                if a['href'] == ('efiction/viewstory.php?sid='+self.story.getMetadata('storyId')):
+                    self.setSeries(series_name, i)
+                    self.story.setMetadata('seriesUrl',series_url)
+                    break
+                i+=1
+
+        except:
+            # I find it hard to care if the series parsing fails
+            pass
+        
+    # grab the text for an individual chapter.
+    def getChapterText(self, url):
+
+        logger.debug('Getting chapter text from: %s' % url)
+
+        soup = self.make_soup(self._fetchUrl(url))
+
+        div = soup.find('div', {'id' : 'story'})
+
+        if None == div:
+            raise exceptions.FailedToDownload("Error downloading Chapter: %s!  Missing required element!" % url)
+
+        return self.utf8FromSoup(url,div)

fanficfare/adapters/adapter_buffynfaithnet.py

@@ -62,9 +62,6 @@ class BuffyNFaithNetAdapter(BaseSiteAdapter):
             # normalized story URL. gets rid of chapter if there, left with ch 1 URL on this site
             nurl = "http://"+self.getSiteDomain()+"/fanfictions/index.php?act=vie&id="+self.story.getMetadata('storyId')
             self._setURL(nurl)
-            #argh, this mangles the ampersands I need on metadata['storyUrl']
-            #will set it this way
-            self.story.setMetadata('storyUrl',nurl,condremoveentities=False)
         else:
             raise exceptions.InvalidStoryURL(url,
                                              self.getSiteDomain(),
@@ -159,7 +156,7 @@ class BuffyNFaithNetAdapter(BaseSiteAdapter):
         #first the site category (more of a genre to me, meh) and title, in this element:
         mt = doc.find('div',attrs={'class':'maintitle'})
         self.story.addToList('genre',mt.findAll('a')[1].string)
-        self.story.setMetadata('title',mt.findAll('a')[1].nextSibling[len(' » '):])
+        self.story.setMetadata('title',stripHTML(mt).split(u'»')[-1].strip())
         del mt
 
         #the actual category, for me, is 'Buffy: The Vampire Slayer'

fanficfare/adapters/adapter_fimfictionnet.py

@@ -272,7 +272,7 @@ class FimFictionNetSiteAdapter(BaseSiteAdapter):
 
         #groups
         if soup.find('button', {'id':'button-view-all-groups'}):
-            groupResponse = self._fetchUrl("http://www.fimfiction.net/ajax/groups/story_groups_list.php?story=%s" % (self.story.getMetadata("storyId")))
+            groupResponse = self._fetchUrl("https://www.fimfiction.net/ajax/stories/%s/groups" % (self.story.getMetadata("storyId")))
             groupData = json.loads(groupResponse)
             groupList = self.make_soup(groupData["content"])
         else:

fanficfare/adapters/adapter_finestoriescom.py

@@ -15,279 +15,32 @@
 # limitations under the License.
 #
 
-import time
 import logging
 logger = logging.getLogger(__name__)
-import re
-import urllib2
-
-
-from ..htmlcleanup import stripHTML
-from .. import exceptions as exceptions
-
-from base_adapter import BaseSiteAdapter,  makeDate
+from adapter_storiesonlinenet import StoriesOnlineNetAdapter
 
 def getClass():
     return FineStoriesComAdapter
 
 # Class name has to be unique.  Our convention is camel case the
 # sitename with Adapter at the end.  www is skipped.
-class FineStoriesComAdapter(BaseSiteAdapter):
+class FineStoriesComAdapter(StoriesOnlineNetAdapter):
 
-    def __init__(self, config, url):
-        BaseSiteAdapter.__init__(self, config, url)
-
-        self.username = "NoneGiven" # if left empty, site doesn't return any message at all.
-        self.password = ""
-        self.is_adult=False
-
-        # get storyId from url
-        self.story.setMetadata('storyId',self.parsedUrl.path.split('/',)[2].split(':')[0])
-        if 'storyInfo' in self.story.getMetadata('storyId'):
-            self.story.setMetadata('storyId',self.parsedUrl.query.split('=',)[1])
-
-        # normalized story URL.
-        self._setURL('http://' + self.getSiteDomain() + '/s/storyInfo.php?id='+self.story.getMetadata('storyId'))
-
-        # Each adapter needs to have a unique site abbreviation.
-        self.story.setMetadata('siteabbrev','fnst')
-
-        # The date format will vary from site to site.
-        # http://docs.python.org/library/datetime.html#strftime-strptime-behavior
-        self.dateformat = "%Y-%m-%d"
+    @classmethod
+    def getSiteAbbrev(self):
+        return 'fnst'
 
     @staticmethod # must be @staticmethod, don't remove it.
     def getSiteDomain():
         # The site domain.  Does have www here, if it uses it.
         return 'finestories.com'
 
-    @classmethod
-    def getSiteExampleURLs(cls):
-        return "http://"+cls.getSiteDomain()+"/s/1234 http://"+cls.getSiteDomain()+"/s/1234:4010 http://"+cls.getSiteDomain()+"/library/storyInfo.php?id=1234"
-
-    def getSiteURLPattern(self):
-        return re.escape("http://"+self.getSiteDomain())+r"/(s|library)?/(storyInfo.php\?id=)?\d+(:\d+)?(;\d+)?$"
-
     ## Login seems to be reasonably standard across eFiction sites.
     def needToLoginCheck(self, data):
         if 'Free Registration' in data \
+                or "Log In" in data \
                 or "Invalid Password!" in data \
                 or "Invalid User Name!" in data:
             return True
         else:
             return False
-
-    def performLogin(self, url):
-        params = {}
-
-        if self.password:
-            params['theusername'] = self.username
-            params['thepassword'] = self.password
-        else:
-            params['theusername'] = self.getConfig("username")
-            params['thepassword'] = self.getConfig("password")
-        params['rememberMe'] = '1'
-        params['page'] = 'http://'+self.getSiteDomain()+'/'
-        params['submit'] = 'Login'
-
-        loginUrl = 'http://' + self.getSiteDomain() + '/login.php'
-        logger.debug("Will now login to URL (%s) as (%s)" % (loginUrl,
-                                                              params['theusername']))
-
-        d = self._fetchUrl(loginUrl, params)
-
-        if "My Account" not in d : #Member Account
-            logger.info("Failed to login to URL %s as %s" % (loginUrl,
-                                                              params['theusername']))
-            raise exceptions.FailedToLogin(url,params['theusername'])
-            return False
-        else:
-            return True
-
-    ## Getting the chapter list and the meta data, plus 'is adult' checking.
-    def extractChapterUrlsAndMetadata(self):
-
-        # index=1 makes sure we see the story chapter index.  Some
-        # sites skip that for one-chapter stories.
-        url = self.url
-        logger.debug("URL: "+url)
-
-        try:
-            data = self._fetchUrl(url)
-        except urllib2.HTTPError, e:
-            if e.code == 404:
-                raise exceptions.StoryDoesNotExist(self.url)
-            else:
-                raise e
-
-        if self.needToLoginCheck(data):
-            # need to log in for this one.
-            self.performLogin(url)
-            data = self._fetchUrl(url)
-
-        if "Access denied. This story has not been validated by the adminstrators of this site." in data:
-            raise exceptions.AccessDenied(self.getSiteDomain() +" says: Access denied. This story has not been validated by the adminstrators of this site.")
-
-        # use BeautifulSoup HTML parser to make everything easier to find.
-        soup = self.make_soup(data)
-        # print data
-
-        # Now go hunting for all the meta data and the chapter list.
-
-        ## Title
-        a = soup.find('a', href=re.compile(r'/s/'+self.story.getMetadata('storyId')))
-        self.story.setMetadata('title',stripHTML(a))
-
-        # Find authorid and URL from... author url.
-        a = soup.find('a', href=re.compile(r"/a/\w+"))
-        self.story.setMetadata('authorId',a['href'].split('/')[2])
-        self.story.setMetadata('authorUrl','http://'+self.host+a['href'])
-        self.story.setMetadata('author',a.text)
-
-        # Find the chapters:
-        chapters = soup.findAll('a', href=re.compile(r'/s/'+self.story.getMetadata('storyId')+":\d+$"))
-        if len(chapters) != 0:
-            for chapter in chapters:
-                # just in case there's tags, like <i> in chapter titles.
-                self.chapterUrls.append((stripHTML(chapter),'http://'+self.host+chapter['href']))
-        else:
-            self.chapterUrls.append((self.story.getMetadata('title'),'http://'+self.host+'/s/'+self.story.getMetadata('storyId')))
-
-        self.story.setMetadata('numChapters',len(self.chapterUrls))
-
-        # surprisingly, the detailed page does not give enough details, so go to author's page
-
-        skip=0
-        i=0
-        while i == 0:
-            asoup = self.make_soup(self._fetchUrl(self.story.getMetadata('authorUrl')+"&skip="+unicode(skip)))
-
-            tds = asoup.findAll('td', {'class' : 'lc2'})
-            for lc2 in tds:
-                if lc2.find('a', href=re.compile(r'/s/'+self.story.getMetadata('storyId'))):
-                    i=1
-                    break
-                if tds[len(tds)-1] == lc2:
-                    skip=skip+10
-
-        for cat in lc2.findAll('div', {'class' : 'typediv'}):
-            self.story.addToList('category',cat.text)
-
-        self.story.setMetadata('size', lc2.findNext('td', {'class' : 'num'}).text)
-
-        lc4 = lc2.findNext('td', {'class' : 'lc4'})
-
-        try:
-            a = lc4.find('a', href=re.compile(r"/library/show_series.php\?id=\d+"))
-            i = a.parent.text.split('(')[1].split(')')[0]
-            self.setSeries(a.text, i)
-            self.story.setMetadata('seriesUrl','http://'+self.host+a['href'])
-        except:
-            pass
-        try:
-            a = lc4.find('a', href=re.compile(r"/library/universe.php\?id=\d+"))
-            self.story.addToList("category",a.text)
-        except:
-            pass
-
-        for a in lc4.findAll('span', {'class' : 'help'}) + lc4.findAll('script'):
-            a.extract()
-
-        self.setDescription('http://'+self.host+'/s/'+self.story.getMetadata('storyId'),lc4.text.split('[More Info')[0])
-
-        for b in lc4.findAll('b'):
-            label = b.text
-            value = b.nextSibling
-
-            if 'For Age' in label:
-                self.story.setMetadata('rating', value)
-
-            if 'Tags' in label:
-                for genre in value.split(', '):
-                    self.story.addToList('genre',genre)
-
-            ## Site uses a <script> to inject timestamp in locale plus <noscript> general version.
-            if 'Posted' in label:
-                value = b.find_next_sibling('noscript')
-                if '(' in value:
-                    date = makeDate(stripHTML(value.split(' (')[0]), self.dateformat)
-                else:
-                    date = makeDate(stripHTML(value), self.dateformat)
-                self.story.setMetadata('datePublished', date)
-                self.story.setMetadata('dateUpdated', date)
-
-            if 'Concluded' in label or 'Updated' in label:
-                value = b.find_next_sibling('noscript')
-                if '(' in value:
-                    date = makeDate(stripHTML(value.split(' (')[0]), self.dateformat)
-                else:
-                    date = makeDate(stripHTML(value), self.dateformat)
-                self.story.setMetadata('dateUpdated', date)
-
-        status = lc4.find('span', {'class' : 'ab'})
-        if  status != None:
-            self.story.setMetadata('status', 'In-Progress')
-            if "Last Activity" in status.text:
-                self.story.setMetadata('dateUpdated', makeDate(status.text.split('Activity: ')[1].split(')')[0], self.dateformat))
-        else:
-            self.story.setMetadata('status', 'Completed')
-
-
-    # grab the text for an individual chapter.
-    def getChapterText(self, url):
-
-        logger.debug('Getting chapter text from: %s' % url)
-
-        soup = self.make_soup(self._fetchUrl(url))
-
-        div = soup.find('article')
-
-        if None == div:
-            raise exceptions.FailedToDownload("Error downloading Chapter: %s!  Missing required element!" % url)
-
-        # some big chapters are split over several pages
-        pager = div.find('span', {'class' : 'pager'})
-        if pager != None:
-            urls=pager.findAll('a')
-            urls=urls[:len(urls)-1]
-
-            for ur in urls:
-                soup = self.make_soup(self._fetchUrl("http://"+self.getSiteDomain()+ur['href']))
-
-                div1 = soup.find('article')
-
-                #print("div.contents:%s"%(div.contents,))
-                # appending next section
-                last=div.findAll('p')
-                next=div1.find('span', {'class' : 'conTag'}).nextSibling
-                last[len(last)-1]=last[len(last)-1].append(next)
-
-                self.clean_chapter(div1)
-                #print("div.contents:%s"%(div.contents,))
-                for t in div1.contents:
-                    div.append(t)
-
-        self.clean_chapter(div)
-
-        return self.utf8FromSoup(url,div)
-    def clean_chapter(self,art):
-        # discard included chapter heading.
-        # discard included date
-        # discard share block
-        # continued/continues
-        # discard next link
-        for tag in art.find_all('h2') + \
-                art.find_all('div', class_="date") + \
-                art.find_all('div', class_="vform") + \
-                art.find_all('span', class_="conTag") + \
-                art.find_all('h3', class_="end"):
-            tag.extract()
-
-        # remove pager blocks.
-        for pager in art.find_all('span', class_="pager"):
-            # remove br tags before and after pager.
-            #print("br list prev: %s"%len(pager.find_previous_siblings('br')))
-            #print("br list next: %s"%len(pager.find_next_siblings('br')))
-            for tag in pager.find_next_siblings('br')[:2] + pager.find_previous_siblings('br')[:2]:
-                tag.extract()
-            pager.extract()

fanficfare/adapters/adapter_hpfandomnet.py

@@ -136,10 +136,11 @@ class HPFandomNetAdapterAdapter(BaseSiteAdapter): # XXX
 
         authsoup = self.make_soup(authdata)
 
-        reviewsa = authsoup.find('a', href=re.compile(r"reviews\.php\?sid="+self.story.getMetadata('storyId')+r".*"))
+        reviewsa = authsoup.find_all('a', href=re.compile(r"reviews\.php\?sid="+self.story.getMetadata('storyId')+r".*"))
         # <table><tr><td><p><b><a ...>
-        metablock = reviewsa.findParent("table")
+        metablock = reviewsa[0].findParent("table")
         #print("metablock:%s"%metablock)
+        self.story.setMetadata('reviews',stripHTML(reviewsa[-1]))
 
         ## Title
         titlea = metablock.find('a', href=re.compile("viewstory.php"))
@@ -148,6 +149,7 @@ class HPFandomNetAdapterAdapter(BaseSiteAdapter): # XXX
             raise exceptions.FailedToDownload("Story URL (%s) not found on author's page, can't use chapter URLs"%url)
         self.story.setMetadata('title',stripHTML(titlea))
 
+        total_reads = 0
         # Find the chapters: !!! hpfandom.net differs from every other
         # eFiction site--the sid on viewstory for chapters is
         # *different* for each chapter
@@ -156,10 +158,16 @@ class HPFandomNetAdapterAdapter(BaseSiteAdapter): # XXX
             # just in case there's tags, like <i> in chapter titles.
             #print("====chapter===%s"%m.group(1))
             self.chapterUrls.append((stripHTML(chapter),'http://'+self.host+'/eff/'+m.group(1)))
-
+            try:
+                total_reads += int(stripHTML((chapter.find_parent('tr').find_all('td')[-1])))
+            except:
+                pass # don't care
         if len(self.chapterUrls) == 0:
             self.chapterUrls.append((stripHTML(self.story.getMetadata('title')),url))
 
+        if total_reads > 0:
+            self.story.setMetadata('reads',total_reads)
+
         self.story.setMetadata('numChapters',len(self.chapterUrls))
 
         # eFiction sites don't help us out a lot with their meta data

fanficfare/adapters/adapter_literotica.py

@@ -21,7 +21,6 @@ logger = logging.getLogger(__name__)
 import re
 import urllib2
 import urlparse
-import time
 
 from bs4.element import Comment
 from ..htmlcleanup import stripHTML
@@ -33,13 +32,15 @@ class LiteroticaSiteAdapter(BaseSiteAdapter):
 
     def __init__(self, config, url):
         BaseSiteAdapter.__init__(self, config, url)
+        logger.debug("LiteroticaComAdapter:__init__ - url='%s'" % url)
 
         self.decode = ["utf8",
                        "Windows-1252"] # 1252 is a superset of iso-8859-1.
-                               # Most sites that claim to be
-                               # iso-8859-1 (and some that claim to be
-                               # utf8) are really windows-1252.
+                            # Most sites that claim to be
+                            # iso-8859-1 (and some that claim to be
+                            # utf8) are really windows-1252.
 
+        # Each adapter needs to have a unique site abbreviation.
         self.story.setMetadata('siteabbrev','litero')
 
         # normalize to first chapter.  Not sure if they ever have more than 2 digits.
@@ -62,7 +63,7 @@ class LiteroticaSiteAdapter(BaseSiteAdapter):
 
         # The date format will vary from site to site.
         # http://docs.python.org/library/datetime.html#strftime-strptime-behavior
-        self.dateformat = '%m/%d/%y'
+        self.dateformat = "%m/%d/%y"
 
     @staticmethod
     def getSiteDomain():
@@ -96,6 +97,18 @@ class LiteroticaSiteAdapter(BaseSiteAdapter):
     def getSiteURLPattern(self):
         return r"https?://(www|german|spanish|french|dutch|italian|romanian|portuguese|other)(\.i)?\.literotica\.com/s/([a-zA-Z0-9_-]+)"
 
+    def getCategories(self, soup):
+        if self.getConfig("use_meta_keywords"):
+            categories = soup.find("meta", {"name":"keywords"})['content'].split(', ')
+            categories = [c for c in categories if not self.story.getMetadata('title') in c]
+            if self.story.getMetadata('author') in categories:
+                categories.remove(self.story.getMetadata('author'))
+            logger.debug("Meta = %s" % categories)
+            for category in categories:
+    #            logger.debug("\tCategory=%s" % category)
+#                 self.story.addToList('category', category.title())
+                self.story.addToList('eroticatags', category.title())
+
     def extractChapterUrlsAndMetadata(self):
         """
         NOTE: Some stories can have versions,
@@ -119,6 +132,7 @@ class LiteroticaSiteAdapter(BaseSiteAdapter):
             raise exceptions.AdultCheckRequired(self.url)
 
         logger.debug("Chapter/Story URL: <%s> " % self.url)
+
         try:
             data1 = self._fetchUrl(self.url)
             soup1 = self.make_soup(data1)
@@ -145,6 +159,7 @@ class LiteroticaSiteAdapter(BaseSiteAdapter):
             soupAuth = self.make_soup(dataAuth)
             #strip comments from soup
             [comment.extract() for comment in soupAuth.findAll(text=lambda text:isinstance(text, Comment))]
+#            logger.debug(soupAuth)
         except urllib2.HTTPError, e:
             if e.code == 404:
                 raise exceptions.StoryDoesNotExist(authorurl)
@@ -155,6 +170,15 @@ class LiteroticaSiteAdapter(BaseSiteAdapter):
         ## site has started using //domain.name/asdf urls remove https?: from front
         ## site has started putting https back on again.
         storyLink = soupAuth.find('a', href=re.compile(r'(https?:)?'+re.escape(self.url[self.url.index(':')+1:])))
+#         storyLink = soupAuth.find('a', href=self.url)#[self.url.index(':')+1:])
+
+        if storyLink is not None:
+            # pull the published date from the author page
+            # default values from single link.  Updated below if multiple chapter.
+            logger.debug("Found story on the author page.")
+            date = storyLink.parent.parent.findAll('td')[-1].text
+            self.story.setMetadata('datePublished', makeDate(date, self.dateformat))
+            self.story.setMetadata('dateUpdated',makeDate(date, self.dateformat))
 
         if storyLink is not None:
             urlTr = storyLink.parent.parent
@@ -166,101 +190,184 @@ class LiteroticaSiteAdapter(BaseSiteAdapter):
             raise exceptions.FailedToDownload("Couldn't find story <%s> on author's page <%s>" % (self.url, authorurl))
 
         if isSingleStory:
-            self.story.setMetadata('title', storyLink.text)
+#             self.chapterUrls = [(soup1.h1.string, self.url)]
+#             self.story.setMetadata('title', soup1.h1.string)
+
+            self.story.setMetadata('title', storyLink.text.strip('/'))
+            logger.debug('Title: "%s"' % storyLink.text.strip('/'))
             self.story.setMetadata('description', urlTr.findAll("td")[1].text)
-            self.story.addToList('eroticatags', urlTr.findAll("td")[2].text)
+            self.story.addToList('category', urlTr.findAll("td")[2].text)
+#             self.story.addToList('eroticatags', urlTr.findAll("td")[2].text)
             date = urlTr.findAll('td')[-1].text
             self.story.setMetadata('datePublished', makeDate(date, self.dateformat))
             self.story.setMetadata('dateUpdated',makeDate(date, self.dateformat))
             self.chapterUrls = [(storyLink.text, self.url)]
+            averrating = stripHTML(storyLink.parent)
+            ## title (0.00)
+            averrating = averrating[averrating.rfind('(')+1:averrating.rfind(')')]
+            try:
+                self.story.setMetadata('averrating', float(averrating))
+            except:
+                pass
+#             self.story.setMetadata('averrating',averrating)
+        # parse out the list of chapters
         else:
             seriesTr = urlTr.previousSibling
             while 'ser-ttl' not in seriesTr['class']:
                 seriesTr = seriesTr.previousSibling
             m = re.match("^(?P<title>.*?):\s(?P<numChapters>\d+)\sPart\sSeries$", seriesTr.find("strong").text)
             self.story.setMetadata('title', m.group('title'))
+            seriesTitle = m.group('title')
 
             ## Walk the chapters
             chapterTr = seriesTr.nextSibling
             self.chapterUrls = []
             dates = []
             descriptions = []
+            ratings = []
+            chapters = []
             while chapterTr is not None and 'sl' in chapterTr['class']:
-                descriptions.append(chapterTr.findAll("td")[1].text)
+                description = "%d. %s" % (len(descriptions)+1,stripHTML(chapterTr.findAll("td")[1]))
+                description = stripHTML(chapterTr.findAll("td")[1])
                 chapterLink = chapterTr.find("td", "fc").find("a")
-                if not chapterLink["href"].startswith('http'):
-                    chapterLink["href"] = "http:" + chapterLink["href"]
-                self.chapterUrls.append((chapterLink.text, chapterLink["href"]))
                 self.story.addToList('eroticatags', chapterTr.findAll("td")[2].text)
-                dates.append(makeDate(chapterTr.findAll('td')[-1].text, self.dateformat))
+                pub_date = makeDate(chapterTr.findAll('td')[-1].text, self.dateformat)
+                dates.append(pub_date)
                 chapterTr = chapterTr.nextSibling
+                
+                chapter_title = chapterLink.text
+                if self.getConfig("clean_chapter_titles"):
+                    logger.debug('\tChapter Name: "%s"' % chapterLink.string)
+                    logger.debug('\tChapter Name: "%s"' % chapterLink.text)
+                    if chapterLink.text.lower().startswith(seriesTitle.lower()):
+                        chapter = chapterLink.text[len(seriesTitle):].strip()
+                        logger.debug('\tChapter: "%s"' % chapter)
+                        if chapter == '':
+                            chapter_title = 'Chapter %d' % (len(self.chapterUrls) + 1)
+                        else:
+                            separater_char = chapter[0]
+                            logger.debug('\tseparater_char: "%s"' % separater_char)
+                            chapter = chapter[1:].strip() if separater_char in [":", "-"] else chapter
+                            logger.debug('\tChapter: "%s"' % chapter)
+                            if chapter.lower().startswith('ch.'):
+                                chapter = chapter[len('ch.'):]
+                                try:
+                                    chapter_title = 'Chapter %d' % int(chapter)
+                                except:
+                                    chapter_title = 'Chapter %s' % chapter
+                            elif chapter.lower().startswith('pt.'):
+                                chapter = chapter[len('pt.'):]
+                                try:
+                                    chapter_title = 'Part %d' % int(chapter)
+                                except:
+                                    chapter_title = 'Part %s' % chapter
+                            elif separater_char in [":", "-"]:
+                                chapter_title = chapter
+    
+    #                 if chapter_title == '':
+    #                     chapter_title = chapterLink.string
 
-            ## Set description to joint chapter descriptions
-            self.story.setMetadata('description', " / ".join(descriptions))
+                # pages include full URLs.
+                chapurl = chapterLink['href']
+                if chapurl.startswith('//'):
+                    chapurl = self.parsedUrl.scheme + ':' + chapurl
+                logger.debug("Chapter URL: " + chapurl)
+                logger.debug("Chapter Title: " + chapter_title)
+                logger.debug("Chapter description: " + description)
+                chapters.append((chapter_title, chapurl, description, pub_date))
+#                 self.chapterUrls.append((chapter_title, chapurl))
+                numrating = stripHTML(chapterLink.parent)
+                ## title (0.00)
+                numrating = numrating[numrating.rfind('(')+1:numrating.rfind(')')]
+                try:
+                    ratings.append(float(numrating))
+                except:
+                    pass
 
+            chapters = sorted(chapters, key=lambda chapter: chapter[3])
+            for i, chapter in enumerate(chapters):
+                self.chapterUrls.append((chapter[0], chapter[1]))
+                descriptions.append("%d. %s" % (i + 1, chapter[2]))
             ## Set the oldest date as publication date, the newest as update date
             dates.sort()
             self.story.setMetadata('datePublished', dates[0])
             self.story.setMetadata('dateUpdated', dates[-1])
+            self.story.setMetadata('datePublished', chapters[0][3])
+            self.story.setMetadata('dateUpdated', chapters[-1][3])
+            ## Set description to joint chapter descriptions
+            self.setDescription(authorurl,"<p>"+"</p>\n<p>".join(descriptions)+"</p>")
 
-            # normalize on first chapter URL.
-            self._setURL(self.chapterUrls[0][1])
+            if len(ratings) > 0:
+                self.story.setMetadata('averrating','%4.2f' % (sum(ratings) / float(len(ratings))))
+
+        # normalize on first chapter URL.
+        self._setURL(self.chapterUrls[0][1])
+
+        # reset storyId to first chapter.
+        self.story.setMetadata('storyId',self.parsedUrl.path.split('/',)[2])
 
         self.story.setMetadata('numChapters', len(self.chapterUrls))
 
-        # set storyId to 'title-author' to avoid duplicates
-        # self.story.setMetadata('storyId',
-        #     re.sub("[^a-z0-9]", "", self.story.getMetadata('title').lower())
-        #     + "-"
-        #     + re.sub("[^a-z0-9]", "", self.story.getMetadata('author').lower()))
+        self.story.setMetadata('category', soup1.find('div', 'b-breadcrumbs').findAll('a')[1].string)
+        self.getCategories(soup1)
+#         self.story.setMetadata('description', soup1.find('meta', {'name': 'description'})['content'])
 
         return
 
+
+    def getPageText(self, raw_page, url):
+        logger.debug('Getting page text')
+#         logger.debug(soup)
+        raw_page = raw_page.replace('<div class="b-story-body-x x-r15"><div><p>','<div class="b-story-body-x x-r15"><div>')
+#         logger.debug("\tChapter text: %s" % raw_page)
+        page_soup = self.make_soup(raw_page)
+        [comment.extract() for comment in page_soup.findAll(text=lambda text:isinstance(text, Comment))]
+        story2 = page_soup.find('div', 'b-story-body-x').div
+#         logger.debug("getPageText- name div div...")
+#         logger.debug(soup)
+#         story2.append(page_soup.new_tag('br'))
+        div = self.utf8FromSoup(url, story2)
+#        logger.debug(div)
+
+        fullhtml = unicode(div)
+#         logger.debug(fullhtml)
+        fullhtml = re.sub(r'<br />\s*<br />', r'</p><p>', fullhtml)
+        fullhtml = re.sub(r'^<div>', r'', fullhtml)
+        fullhtml = re.sub(r'</div>$', r'', fullhtml)
+        fullhtml = re.sub(r'(<p><br/></p>\s+)+$', r'', fullhtml)
+#         logger.debug(fullhtml)
+        return fullhtml
+
     def getChapterText(self, url):
-        logger.debug('Getting chapter text from <%s>' % url)
-        data1 = self._fetchUrl(url)
-        # brute force approach to replace the wrapping <p> tag.  If
-        # done by changing tag name, it causes problems with nested
-        # <p> tags.
-        data1 = data1.replace('<div class="b-story-body-x x-r15"><div><p>','<div class="b-story-body-x x-r15"><div>')
-        soup1 = self.make_soup(data1)
 
-        #strip comments from soup
-        [comment.extract() for comment in soup1.findAll(text=lambda text:isinstance(text, Comment))]
+        logger.debug('Getting chapter text from: %s' % url)
 
-        # get story text
-        story1 = soup1.find('div', 'b-story-body-x').div
-        #print("story1:%s"%story1)
-        # story1.name='div'
-        story1.append(soup1.new_tag('br'))
-        storytext = self.utf8FromSoup(url,story1)
+        raw_page = self._fetchUrl(url)
+        page_soup = self.make_soup(raw_page)
+        pages = page_soup.find('select', {'name' : 'page'})
+        page_nums = [page.text for page in pages.findAll('option')] if pages else 0
 
-        # find num pages
-        pgs = int(soup1.find("span", "b-pager-caption-t r-d45").string.split(' ')[0])
-        logger.debug("pages: "+unicode(pgs))
+        fullhtml = "" 
+        self.getCategories(page_soup)
+        if self.getConfig("description_in_chapter"):
+            chapter_description = page_soup.find("meta", {"name" : "description"})['content']
+            logger.debug("\tChapter description: %s" % chapter_description)
+            fullhtml += '<p><b>Description:</b> %s</p><hr />' % chapter_description
+        fullhtml += self.getPageText(raw_page, url)
+        if pages:
+            for page_no in xrange(2, len(page_nums) + 1):
+                page_url = url +  "?page=%s" % page_no
+                logger.debug("page_url= %s" % page_url)
+                raw_page = self._fetchUrl(page_url)
+                fullhtml += self.getPageText(raw_page, url)
+        
+#        fullhtml = self.utf8FromSoup(url, bs.BeautifulSoup(fullhtml))
+#        fullhtml = re.sub(r'^<div>', r'', fullhtml)
+#        fullhtml = re.sub(r'</div>$', r'', fullhtml)
+#        if None == div:
+#            raise exceptions.FailedToDownload("Error downloading Chapter: %s!  Missing required element!" % url)
 
-        # get all the pages
-        for i in xrange(2, pgs+1):
-            try:
-                logger.debug("fetching page "+unicode(i))
-                time.sleep(0.5)
-                data2 = self._fetchUrl(url, {'page': i})
-                # brute force approach to replace the wrapping <p> tag.  If
-                # done by changing tag name, it causes problems with nested
-                # <p> tags.
-                data2 = data2.replace('<div class="b-story-body-x x-r15"><div><p>','<div class="b-story-body-x x-r15"><div>')
-                soup2 = self.make_soup(data2)
-                [comment.extract() for comment in soup2.findAll(text=lambda text:isinstance(text, Comment))]
-                story2 = soup2.find('div', 'b-story-body-x').div
-                # story2.name='div'
-                story2.append(soup2.new_tag('br'))
-                storytext += self.utf8FromSoup(url,story2)
-            except urllib2.HTTPError, e:
-                if e.code == 404:
-                    raise exceptions.StoryDoesNotExist(url)
-                else:
-                    raise e
-        return storytext
+        return fullhtml
 
 
 def getClass():

fanficfare/adapters/adapter_lucifaelff.py

@@ -0,0 +1,299 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2016 FanFicFare team
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# Software: eFiction
+import time
+import logging
+logger = logging.getLogger(__name__)
+import re
+import urllib2
+
+from bs4.element import Comment
+from ..htmlcleanup import stripHTML
+from .. import exceptions as exceptions
+
+from base_adapter import BaseSiteAdapter,  makeDate
+
+def getClass():
+    return Lucifaelff
+
+# Class name has to be unique.  Our convention is camel case the
+# sitename with Adapter at the end.  www is skipped.
+class Lucifaelff(BaseSiteAdapter):
+
+    def __init__(self, config, url):
+        BaseSiteAdapter.__init__(self, config, url)
+
+        self.decode = ["Windows-1252",
+                       "utf8"] # 1252 is a superset of iso-8859-1.
+                               # Most sites that claim to be
+                               # iso-8859-1 (and some that claim to be
+                               # utf8) are really windows-1252.
+        self.username = "NoneGiven" # if left empty, site doesn't return any message at all.
+        self.password = ""
+        self.is_adult=False
+
+        # get storyId from url--url validation guarantees query is only sid=1234
+        self.story.setMetadata('storyId',self.parsedUrl.query.split('=',)[1])
+
+
+        # normalized story URL.
+        self._setURL('http://' + self.getSiteDomain() + '/viewstory.php?sid='+self.story.getMetadata('storyId'))
+
+        # Each adapter needs to have a unique site abbreviation.
+        self.story.setMetadata('siteabbrev','luci')
+
+        # The date format will vary from site to site.
+        # http://docs.python.org/library/datetime.html#strftime-strptime-behavior
+        self.dateformat = "%d/%m/%Y"
+
+    @staticmethod # must be @staticmethod, don't remove it.
+    def getSiteDomain():
+        # The site domain.  Does have www here, if it uses it.
+        return 'fanfiction.lucifael.com'
+
+    @classmethod
+    def getSiteExampleURLs(cls):
+        return "http://"+cls.getSiteDomain()+"/viewstory.php?sid=1234"
+
+    def getSiteURLPattern(self):
+        return re.escape("http://"+self.getSiteDomain()+"/viewstory.php?sid=")+r"\d+$"
+
+    ## Login seems to be reasonably standard across eFiction sites.
+    def needToLoginCheck(self, data):
+        if 'Registered Users Only' in data \
+                or 'There is no such account on our website' in data \
+                or "That password doesn't match the one in our database" in data:
+            return True
+        else:
+            return False
+
+    def performLogin(self, url):
+        params = {}
+
+        if self.password:
+            params['penname'] = self.username
+            params['password'] = self.password
+        else:
+            params['penname'] = self.getConfig("username")
+            params['password'] = self.getConfig("password")
+        params['cookiecheck'] = '1'
+        params['submit'] = 'Submit'
+
+        loginUrl = 'http://' + self.getSiteDomain() + '/user.php?action=login'
+        logger.debug("Will now login to URL (%s) as (%s)" % (loginUrl,
+                                                              params['penname']))
+
+        d = self._fetchUrl(loginUrl, params)
+
+        if "Member Account" not in d : #Member Account
+            logger.info("Failed to login to URL %s as %s" % (loginUrl,
+                                                              params['penname']))
+            raise exceptions.FailedToLogin(url,params['penname'])
+            return False
+        else:
+            return True
+
+    ## Getting the chapter list and the meta data, plus 'is adult' checking.
+    def extractChapterUrlsAndMetadata(self):
+
+        if self.is_adult or self.getConfig("is_adult"):
+            # Weirdly, different sites use different warning numbers.
+            # If the title search below fails, there's a good chance
+            # you need a different number.  print data at that point
+            # and see what the 'click here to continue' url says.
+            addurl = "&ageconsent=ok&warning=4"
+        else:
+            addurl=""
+
+        # index=1 makes sure we see the story chapter index.  Some
+        # sites skip that for one-chapter stories.
+        url = self.url
+        logger.debug("URL: "+url)
+
+        try:
+            data = self._fetchUrl(url)
+        except urllib2.HTTPError, e:
+            if e.code == 404:
+                raise exceptions.StoryDoesNotExist(self.url)
+            else:
+                raise e
+
+
+        if "Access denied. This story has not been validated by the adminstrators of this site." in data:
+            # need to log in for this one.
+            self.performLogin(url)
+            data = self._fetchUrl(url)
+
+        # Since the warning text can change by warning level, let's
+        # look for the warning pass url.  ksarchive uses
+        # &warning= -- actually, so do other sites.  Must be an
+        # eFiction book.
+
+        # viewstory.php?sid=1882&warning=4
+        # viewstory.php?sid=1654&ageconsent=ok&warning=5
+        #print data
+        #m = re.search(r"'viewstory.php\?sid=1882(&warning=4)'",data)
+        m = re.search(r"'viewstory.php\?sid=\d+((?:&ageconsent=ok)?&warning=\d+)'",data)
+        if m != None:
+            if self.is_adult or self.getConfig("is_adult"):
+                # We tried the default and still got a warning, so
+                # let's pull the warning number from the 'continue'
+                # link and reload data.
+                addurl = m.group(1)
+                # correct stupid & error in url.
+                addurl = addurl.replace("&","&")
+                url = self.url+'&index=1'+addurl
+                logger.debug("URL 2nd try: "+url)
+
+                try:
+                    data = self._fetchUrl(url)
+                except urllib2.HTTPError, e:
+                    if e.code == 404:
+                        raise exceptions.StoryDoesNotExist(self.url)
+                    else:
+                        raise e
+            else:
+                raise exceptions.AdultCheckRequired(self.url)
+
+        if "Access denied. This story has not been validated by the adminstrators of this site." in data:
+            raise exceptions.FailedToDownload(self.getSiteDomain() +" says: Access denied. This story has not been validated by the adminstrators of this site.")
+
+        # use BeautifulSoup HTML parser to make everything easier to find.
+        soup = self.make_soup(data)
+        # print data
+
+        # Now go hunting for all the meta data and the chapter list.
+
+        pagetitle = soup.find('div',{'id':'pagetitle'})
+
+        ## Title
+        a = pagetitle.find('a', href=re.compile(r'viewstory.php\?sid='+self.story.getMetadata('storyId')+"$"))
+        self.story.setMetadata('title',stripHTML(a))
+
+        # Find authorid and URL from... author url.
+        a = pagetitle.find('a', href=re.compile(r"viewuser.php\?uid=\d+"))
+        self.story.setMetadata('authorId',a['href'].split('=')[1])
+        self.story.setMetadata('authorUrl','http://'+self.host+'/'+a['href'])
+        self.story.setMetadata('author',a.string)
+
+        # Find the chapters:
+        for chapter in soup.findAll('a', href=re.compile(r'viewstory.php\?sid='+self.story.getMetadata('storyId')+"&chapter=\d+$")):
+            # just in case there's tags, like <i> in chapter titles.
+            self.chapterUrls.append((stripHTML(chapter),'http://'+self.host+'/'+chapter['href']+addurl))
+
+        self.story.setMetadata('numChapters',len(self.chapterUrls))
+
+        # eFiction sites don't help us out a lot with their meta data
+        # formating, so it's a little ugly.
+
+        # utility method
+        def defaultGetattr(d,k):
+            try:
+                return d[k]
+            except:
+                return ""
+
+        # <span class="label">Rated:</span> NC-17<br /> etc
+        labels = soup.findAll('span',{'class':'label'})
+        for labelspan in labels:
+            value = labelspan.nextSibling
+            label = labelspan.string
+
+            if 'Summary' in label:
+                ## Everything until the next span class='label'
+                svalue = ""
+                while 'label' not in defaultGetattr(value,'class'):
+                    svalue += unicode(value)
+                    value = value.nextSibling
+                self.setDescription(url,svalue)
+                #self.story.setMetadata('description',stripHTML(svalue))
+
+            if 'Rated' in label:
+                self.story.setMetadata('rating', value)
+
+            if 'Word count' in label:
+                self.story.setMetadata('numWords', value)
+
+            if 'Categories' in label:
+                cats = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=categories'))
+                for cat in cats:
+                    self.story.addToList('category',cat.string)
+
+            if 'Characters' in label:
+                chars = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=characters'))
+                for char in chars:
+                    self.story.addToList('characters',char.string)
+
+            if 'Genre' in label:
+                genres = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=class&type_id=1'))
+                for genre in genres:
+                    self.story.addToList('genre',genre.string)
+
+            if 'Warnings' in label:
+                warnings = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=class&type_id=3'))
+                for warning in warnings:
+                    self.story.addToList('warnings',warning.string)
+
+            if 'Completed' in label:
+                if 'Yes' in value:
+                    self.story.setMetadata('status', 'Completed')
+                else:
+                    self.story.setMetadata('status', 'In-Progress')
+
+            if 'Published' in label:
+                self.story.setMetadata('datePublished', makeDate(stripHTML(value), self.dateformat))
+
+            if 'Updated' in label:
+                # there's a stray [ at the end.
+                #value = value[0:-1]
+                self.story.setMetadata('dateUpdated', makeDate(stripHTML(value), self.dateformat))
+
+        try:
+            # Find Series name from series URL.
+            a = soup.find('a', href=re.compile(r"viewseries.php\?seriesid=\d+"))
+            series_name = a.string
+            series_url = 'http://'+self.host+'/'+a['href']
+
+            # use BeautifulSoup HTML parser to make everything easier to find.
+            seriessoup = self.make_soup(self._fetchUrl(series_url))
+            storyas = seriessoup.findAll('a', href=re.compile(r'^viewstory.php\?sid=\d+$'))
+            i=1
+            for a in storyas:
+                if a['href'] == ('viewstory.php?sid='+self.story.getMetadata('storyId')):
+                    self.setSeries(series_name, i)
+                    self.story.setMetadata('seriesUrl',series_url)
+                    break
+                i+=1
+
+        except:
+            # I find it hard to care if the series parsing fails
+            pass
+
+    # grab the text for an individual chapter.
+    def getChapterText(self, url):
+
+        logger.debug('Getting chapter text from: %s' % url)
+
+        soup = self.make_soup(self._fetchUrl(url))
+
+        div = soup.find('div', {'id' : 'story'})
+
+        if None == div:
+            raise exceptions.FailedToDownload("Error downloading Chapter: %s!  Missing required element!" % url)
+
+        return self.utf8FromSoup(url,div)

fanficfare/adapters/adapter_mcstoriescom.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright 2013 Fanficdownloader team, 2015 FanFicFare team
+# Copyright 2013 Fanficdownloader team, 2016 FanFicFare team
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -91,7 +91,7 @@ class MCStoriesComSiteAdapter(BaseSiteAdapter):
             data1 = self._fetchUrl(self.url)
             soup1 = self.make_soup(data1)
             #strip comments from soup
-            [comment.extract() for comment in soup1.findAll(text=lambda text:isinstance(text, Comment))]
+            [comment.extract() for comment in soup1.find_all(text=lambda text:isinstance(text, Comment))]
         except urllib2.HTTPError, e:
             if e.code == 404:
                 raise exceptions.StoryDoesNotExist(self.url)
@@ -112,18 +112,18 @@ class MCStoriesComSiteAdapter(BaseSiteAdapter):
 
         # Description
         synopsis = soup1.find('section', class_='synopsis')
-        description = "\n\n".join([p.text for p in synopsis.findAll('p')])
+        description = "\n\n".join([p.text for p in synopsis.find_all('p')])
         self.story.setMetadata('description', description)
 
         # Tags
         codesDiv = soup1.find('div', class_="storyCodes")
-        for a in codesDiv.findAll('a'):
+        for a in codesDiv.find_all('a'):
             self.story.addToList('eroticatags', a.text)
 
         # Publish and update dates
         publishdate = None
         updatedate = None
-        datelines = soup1.findAll('h3', class_='dateline')
+        datelines = soup1.find_all('h3', class_='dateline')
         for dateline in datelines:
             if dateline.text.startswith('Added '):
                 publishdate = makeDate(dateline.text, "Added " + self.dateformat)
@@ -139,7 +139,7 @@ class MCStoriesComSiteAdapter(BaseSiteAdapter):
 
         if chapterTable is not None:
             # Multi-chapter story
-            chapterRows = chapterTable.findAll('tr')
+            chapterRows = chapterTable.find_all('tr')
 
             for row in chapterRows:
                 chapterCell = row.td
@@ -172,13 +172,13 @@ class MCStoriesComSiteAdapter(BaseSiteAdapter):
         soup1 = self.make_soup(data1)
 
         #strip comments from soup
-        [comment.extract() for comment in soup1.findAll(text=lambda text:isinstance(text, Comment))]
+        [comment.extract() for comment in soup1.find_all(text=lambda text:isinstance(text, Comment))]
 
         # get story text
         story1 = soup1.find('article', id='mcstories')
 
         # Remove duplicate name and author headers
-        [h3.extract() for h3 in story1.findAll('h3')]
+        [h3.extract() for h3 in story1.find_all('h3',class_=re.compile(r'(title|chapter|byline)'))]
 
         storytext = self.utf8FromSoup(url, story1)
 

fanficfare/adapters/adapter_mugglenetcom.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright 2011 Fanficdownloader team, 2015 FanFicFare team
+# Copyright 2011 Fanficdownloader team, 2016 FanFicFare team
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,58 +16,12 @@
 #
 
 # Software: eFiction
-import time
-import logging
-logger = logging.getLogger(__name__)
-import re
-import urllib2
+from base_efiction_adapter import BaseEfictionAdapter
 
-
-from ..htmlcleanup import stripHTML
-from .. import exceptions as exceptions
-
-from base_adapter import BaseSiteAdapter,  makeDate
-
-# This function is called by the downloader in all adapter_*.py files
-# in this dir to register the adapter class.  So it needs to be
-# updated to reflect the class below it.  That, plus getSiteDomain()
-# take care of 'Registering'.
-def getClass():
-    return MuggleNetComAdapter # XXX
-
-# Class name has to be unique.  Our convention is camel case the
-# sitename with Adapter at the end.  www is skipped.
-class MuggleNetComAdapter(BaseSiteAdapter): # XXX
-
-    def __init__(self, config, url):
-        BaseSiteAdapter.__init__(self, config, url)
-
-        self.decode = ["Windows-1252",
-                       "utf8"] # 1252 is a superset of iso-8859-1.
-                               # Most sites that claim to be
-                               # iso-8859-1 (and some that claim to be
-                               # utf8) are really windows-1252.
-        self.username = "NoneGiven" # if left empty, site doesn't return any message at all.
-        self.password = ""
-        self.is_adult=False
-
-        # get storyId from url--url validation guarantees query is only sid=1234
-        self.story.setMetadata('storyId',self.parsedUrl.query.split('=',)[1])
-
-
-        # normalized story URL.
-        self._setURL('http://' + self.getSiteDomain() + '/viewstory.php?sid='+self.story.getMetadata('storyId'))
-
-        # Each adapter needs to have a unique site abbreviation.
-        self.story.setMetadata('siteabbrev','mgln') # XXX
-
-        # The date format will vary from site to site.
-        # http://docs.python.org/library/datetime.html#strftime-strptime-behavior
-        self.dateformat = "%m/%d/%y" # XXX
+class MuggleNetComAdapter(BaseEfictionAdapter):
 
     @staticmethod # must be @staticmethod, don't remove it.
     def getSiteDomain():
-        # The site domain.
         return 'fanfiction.mugglenet.com'
 
     @classmethod
@@ -75,251 +29,12 @@ class MuggleNetComAdapter(BaseSiteAdapter): # XXX
         return ['fanfiction.mugglenet.com','fanfic.mugglenet.com']
 
     @classmethod
-    def getSiteExampleURLs(cls):
-        return "http://"+cls.getSiteDomain()+"/viewstory.php?sid=1234"
+    def getSiteAbbrev(self):
+        return 'mgln'
 
-    def getSiteURLPattern(self):
-        return re.escape("http://")+r"fanfic(tion)?\.mugglenet\.com"+re.escape("/viewstory.php?sid=")+r"\d+$"
+    @classmethod
+    def getDateFormat(self):
+        return "%m/%d/%y"
 
-    ## Login seems to be reasonably standard across eFiction sites.
-    def needToLoginCheck(self, data):
-        if "class='errortext'>Registered Users Only" in data \
-                or 'There is no such account on our website' in data \
-                or "That password doesn't match the one in our database" in data:
-            return True
-        else:
-            return False
-
-    def performLogin(self, url):
-        params = {}
-
-        if self.password:
-            params['penname'] = self.username
-            params['password'] = self.password
-        else:
-            params['penname'] = self.getConfig("username")
-            params['password'] = self.getConfig("password")
-        params['cookiecheck'] = '1'
-        params['submit'] = 'Submit'
-
-        loginUrl = 'http://' + self.getSiteDomain() + '/user.php?action=login&sid='+self.story.getMetadata('storyId')
-        logger.debug("Will now login to URL (%s) as (%s)" % (loginUrl,
-                                                              params['penname']))
-
-        d = self._fetchUrl(loginUrl, params)
-
-        if "Member Account" not in d : #Member Account
-            logger.info("Failed to login to URL %s as %s" % (loginUrl,
-                                                              params['penname']))
-            raise exceptions.FailedToLogin(url,params['penname'])
-            return False
-        else:
-            return True
-
-    ## Getting the chapter list and the meta data, plus 'is adult' checking.
-    def extractChapterUrlsAndMetadata(self):
-
-        if self.is_adult or self.getConfig("is_adult"):
-            # Weirdly, different sites use different warning numbers.
-            # If the title search below fails, there's a good chance
-            # you need a different number.  print data at that point
-            # and see what the 'click here to continue' url says.
-            # http://fanfiction.mugglenet.com/viewstory.php?sid=91079&ageconsent=ok&warning=3
-            addurl = "&ageconsent=ok&warning=3" # XXX  &warning=5
-        else:
-            addurl=""
-
-        # index=1 makes sure we see the story chapter index.  Some
-        # sites skip that for one-chapter stories.
-        url = self.url+'&index=1'+addurl
-        logger.debug("URL: "+url)
-
-        try:
-            data = self._fetchUrl(url)
-        except urllib2.HTTPError, e:
-            if e.code == 404:
-                raise exceptions.StoryDoesNotExist(self.url)
-            else:
-                raise e
-
-        if self.needToLoginCheck(data):
-            # need to log in for this one.
-            self.performLogin(url)
-            data = self._fetchUrl(url)
-            #print("\nurl:%s\ndata:\n%s\n"%(url,data))
-
-        # The actual text that is used to announce you need to be an
-        # adult varies from site to site.  Again, print data before
-        # the title search to troubleshoot.
-
-        # Since the warning text can change by warning level, let's
-        # look for the warning pass url.  nfacommunity uses
-        # &warning= -- actually, so do other sites.  Must be an
-        # eFiction book.
-
-        # viewstory.php?sid=1882&warning=4
-        # viewstory.php?sid=1654&ageconsent=ok&warning=5
-        #print data
-        #m = re.search(r"'viewstory.php\?sid=1882(&warning=4)'",data)
-        m = re.search(r"'viewstory.php\?sid=%s((?:&ageconsent=ok)?&warning=\d+)'"%self.story.getMetadata('storyId'),data)
-        if m != None:
-            if self.is_adult or self.getConfig("is_adult"):
-                # We tried the default and still got a warning, so
-                # let's pull the warning number from the 'continue'
-                # link and reload data.
-                addurl = m.group(1)
-                # correct stupid & error in url.
-                addurl = addurl.replace("&","&")
-                url = self.url+'&index=1'+addurl
-                logger.debug("URL 2nd try: "+url)
-
-                try:
-                    data = self._fetchUrl(url)
-                except urllib2.HTTPError, e:
-                    if e.code == 404:
-                        raise exceptions.StoryDoesNotExist(self.url)
-                    else:
-                        raise e
-            else:
-                raise exceptions.AdultCheckRequired(self.url)
-
-        if "Access denied. This story has not been validated by the adminstrators of this site." in data:
-            raise exceptions.AccessDenied(self.getSiteDomain() +" says: Access denied. This story has not been validated by the adminstrators of this site.")
-
-        # use BeautifulSoup HTML parser to make everything easier to find.
-        soup = self.make_soup(data)
-        # print data
-
-        # Now go hunting for all the meta data and the chapter list.
-
-        ## Title
-        a = soup.find('a', href=re.compile(r'viewstory.php\?sid='+self.story.getMetadata('storyId')+"$"))
-        self.story.setMetadata('title',stripHTML(a))
-
-        # Find authorid and URL from... author url.
-        a = soup.find('a', href=re.compile(r"viewuser.php\?uid=\d+"))
-        self.story.setMetadata('authorId',a['href'].split('=')[1])
-        self.story.setMetadata('authorUrl','http://'+self.host+'/'+a['href'])
-        self.story.setMetadata('author',a.string)
-
-        # Find the chapters:
-        for chapter in soup.findAll('a', href=re.compile(r'viewstory.php\?sid='+self.story.getMetadata('storyId')+"&chapter=\d+$")):
-            # just in case there's tags, like <i> in chapter titles.
-            self.chapterUrls.append((stripHTML(chapter),'http://'+self.host+'/'+chapter['href']+addurl))
-
-        self.story.setMetadata('numChapters',len(self.chapterUrls))
-
-
-        # Not good enough-- content can contain a ('), which ends the content prematurely.
-        # metadesc = soup.find('meta',{'name':'description'})
-        # print("removeAllEntities(metadesc['content']):\n%s\n"%removeAllEntities(metadesc['content']))
-        start='<span class="label">Summary: </span>'
-        end='<span class="label">Rated:</span>'
-        summarydata = data[data.index(start)+len(start):data.index(end)]
-        #print("summarydata:\n%s\n"%summarydata)
-        self.setDescription(url,self.make_soup(summarydata))
-
-        # eFiction sites don't help us out a lot with their meta data
-        # formating, so it's a little ugly.
-
-        # utility method
-        def defaultGetattr(d,k):
-            try:
-                return d[k]
-            except:
-                return ""
-
-        # <span class="label">Rated:</span> NC-17<br /> etc
-        labels = soup.findAll('span',{'class':'label'})
-        for labelspan in labels:
-            value = labelspan.nextSibling
-            label = labelspan.string
-
-            if 'Rated' in label:
-                self.story.setMetadata('rating', value)
-
-            if 'Word count' in label:
-                self.story.setMetadata('numWords', value)
-
-            if 'Categories' in label:
-                cats = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=categories'))
-                catstext = [cat.string for cat in cats]
-                for cat in catstext:
-                    self.story.addToList('category',cat.string)
-
-            if 'Characters' in label:
-                chars = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=characters'))
-                charstext = [char.string for char in chars]
-                for char in charstext:
-                    self.story.addToList('characters',char.string)
-
-            ## Not all sites use Genre, but there's no harm to
-            ## leaving it in.  Check to make sure the type_id number
-            ## is correct, though--it's site specific.
-            if 'Genre' in label:
-                genres = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=class&type_id=2')) # XXX
-                genrestext = [genre.string for genre in genres]
-                self.genre = ', '.join(genrestext)
-                for genre in genrestext:
-                    self.story.addToList('genre',genre.string)
-
-            ## Not all sites use Warnings, but there's no harm to
-            ## leaving it in.  Check to make sure the type_id number
-            ## is correct, though--it's site specific.
-            if 'Warnings' in label:
-                warnings = labelspan.parent.findAll('a',href=re.compile(r'browse.php\?type=class&type_id=2')) # XXX
-                warningstext = [warning.string for warning in warnings]
-                self.warning = ', '.join(warningstext)
-                for warning in warningstext:
-                    self.story.addToList('warnings',warning.string)
-
-            if 'Completed' in label:
-                if 'Yes' in value:
-                    self.story.setMetadata('status', 'Completed')
-                else:
-                    self.story.setMetadata('status', 'In-Progress')
-
-            if 'Published' in label:
-                self.story.setMetadata('datePublished', makeDate(stripHTML(value), self.dateformat))
-
-            if 'Updated' in label:
-                # there's a stray [ at the end.
-                #value = value[0:-1]
-                self.story.setMetadata('dateUpdated', makeDate(stripHTML(value), self.dateformat))
-
-        try:
-            # Find Series name from series URL.
-            a = soup.find('a', href=re.compile(r"viewseries.php\?seriesid=\d+"))
-            series_name = a.string
-            series_url = 'http://'+self.host+'/'+a['href']
-
-            # use BeautifulSoup HTML parser to make everything easier to find.
-            seriessoup = self.make_soup(self._fetchUrl(series_url))
-            storyas = seriessoup.findAll('a', href=re.compile(r'viewstory.php\?sid=\d+'))
-            i=1
-            for a in storyas:
-                # skip 'report this' and 'TOC' links
-                if 'contact.php' not in a['href'] and 'index' not in a['href']:
-                    if a['href'] == ('viewstory.php?sid='+self.story.getMetadata('storyId')):
-                        self.setSeries(series_name, i)
-                        self.story.setMetadata('seriesUrl',series_url)
-                        break
-                    i+=1
-
-        except:
-            # I find it hard to care if the series parsing fails
-            pass
-
-    # grab the text for an individual chapter.
-    def getChapterText(self, url):
-
-        logger.debug('Getting chapter text from: %s' % url)
-
-        soup = self.make_soup(self._fetchUrl(url))
-
-        div = soup.find('div', {'id' : 'story'})
-
-        if None == div:
-            raise exceptions.FailedToDownload("Error downloading Chapter: %s!  Missing required element!" % url)
-
-        return self.utf8FromSoup(url,div)
+def getClass():
+    return MuggleNetComAdapter

fanficfare/adapters/adapter_naiceanilmenet.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2016 FanFicFare team
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# Software: eFiction
+from base_efiction_adapter import BaseEfictionAdapter
+
+class NaiceaNilmeNetAdapter(BaseEfictionAdapter):
+
+    @staticmethod
+    def getSiteDomain():
+        return 'www.naiceanilme.net'
+
+    @classmethod
+    def getSiteAbbrev(self):
+        return 'nnnet'
+
+    @classmethod
+    def getDateFormat(self):
+        return "%m/%d/%y"
+
+def getClass():
+    return NaiceaNilmeNetAdapter

fanficfare/adapters/adapter_portkeyorg.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright 2011 Fanficdownloader team, 2015 FanFicFare team
+# Copyright 2011 Fanficdownloader team, 2016 FanFicFare team
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -270,7 +270,10 @@ class PortkeyOrgAdapter(BaseSiteAdapter): # XXX
         tag = soup.find('td', {'class' : 'story'})
         if tag == None and "<center><b>Chapter does not exist!</b></center>" in data:
             logger.error("Chapter is missing at: %s"%url)
-            return  self.utf8FromSoup(url,self.make_soup("<div><p><center><b>Chapter does not exist!</b></center></p><p>Chapter is missing at: <a href='%s'>%s</a></p></div>"%(url,url)))
+            return  self.utf8FromSoup(url,self.make_soup("<div><p><center><b>Site says: Chapter does not exist!</b></center></p><p>Chapter is missing at: <a href='%s'>%s</a></p></div>"%(url,url)))
+        elif tag == None and "<center><b>This chapter has corrupted or a blank chapter was uploaded. Please contact the author and request that they re-upload the chapter</b></center>" in data:
+            logger.error("Chapter is missing at: %s"%url)
+            return  self.utf8FromSoup(url,self.make_soup("<div><p><center><b>Site says: This chapter has corrupted or a blank chapter was uploaded.</b></center></p><p>Chapter is missing at: <a href='%s'>%s</a></p></div>"%(url,url)))
         tag.name='div' # force to be a div to avoid problems with nook.
 
         centers = tag.findAll('center')

fanficfare/adapters/adapter_quotevcom.py

@@ -1,3 +1,5 @@
+#  -*- coding: utf-8 -*-
+
 import re
 import urlparse
 import urllib2
@@ -58,10 +60,10 @@ class QuotevComAdapter(BaseSiteAdapter):
         if not element:
             raise exceptions.StoryDoesNotExist(self.url)
 
-        self.story.setMetadata('title', element.find('h1').get_text())
-
-        # quotev html is all about formatting without any content tagging
-        authdiv = soup.find('div', {'style':"text-align:left;"})
+        title = element.find('h1')
+        self.story.setMetadata('title', title.get_text())
+        
+        authdiv = title.next_sibling # soup.find('div', {'style':"font-size:0.7em;color:#aaa;margin-top:-10px;text-align:center;margin-left:45px;cursor:pointer"})
         if authdiv:
             #print("div:%s"%authdiv.find_all('a'))
             for a in authdiv.find_all('a'):
@@ -76,7 +78,7 @@ class QuotevComAdapter(BaseSiteAdapter):
         self.setDescription(self.url, soup.find('div', id='qdesct'))
         imgmeta = soup.find('meta',{'property':"og:image" })
         if imgmeta:
-            self.setCoverImage(self.url, urlparse.urljoin(self.url, imgmeta['content']))
+            self.coverurl = self.setCoverImage(self.url, urlparse.urljoin(self.url, imgmeta['content']))[1]
 
         for a in soup.find_all('a', {'href': re.compile(SITE_DOMAIN+'/stories/c/')}):
             self.story.addToList('category', a.get_text())
@@ -89,9 +91,9 @@ class QuotevComAdapter(BaseSiteAdapter):
         if len(elements) > 1:
             self.story.setMetadata('dateUpdated', datetime.datetime.fromtimestamp(float(elements[1]['ts'])))
 
-        metadiv = elements[0].parent
-        
-        if 'completed' in stripHTML(metadiv):
+        metadiv = elements[0].parent.parent
+        # print stripHTML(metadiv)
+        if u'· completed ·' in stripHTML(metadiv):
             self.story.setMetadata('status', 'Completed')
         else:
             self.story.setMetadata('status', 'In-Progress')        
@@ -102,16 +104,13 @@ class QuotevComAdapter(BaseSiteAdapter):
             parts = datum.split()
             if len(parts) < 2 or parts[1] not in self.getConfig('extra_valid_entries'):
                 continue
-            # Not a valid metadatum
-            # if not len(parts) == 2:
-            #     continue
 
             key, value = parts[1], parts[0]
             self.story.setMetadata(key, value.replace(',', '').replace('.', ''))
 
         favspans = soup.find('a',{'id':'fav_btn'}).find_all('span')
         if len(favspans) > 1:
-            self.story.setMetadata('favorites', stripHTML(favspans[1]).replace(',', ''))
+            self.story.setMetadata('favorites', stripHTML(favspans[-1]).replace(',', ''))
             
         commentspans = soup.find('a',{'id':'comment_btn'}).find_all('span')
         #print("commentspans:%s"%commentspans)
@@ -119,7 +118,8 @@ class QuotevComAdapter(BaseSiteAdapter):
             self.story.setMetadata('comments', stripHTML(commentspans[0]).replace(',', ''))
 
         for a in soup.find('div', id='rselect')('a'):
-            self.chapterUrls.append((a.get_text(), urlparse.urljoin(self.url, a['href'])))
+            if 'javascript' not in a['href']:
+                self.chapterUrls.append((a.get_text(), urlparse.urljoin(self.url, a['href'])))
 
         self.story.setMetadata('numChapters', len(self.chapterUrls))
         
@@ -127,8 +127,15 @@ class QuotevComAdapter(BaseSiteAdapter):
         data = self._fetchUrl(url)
         soup = self.make_soup(data)
 
-        element = soup.find('div', id='rescontent')
-        for a in element('a'):
+        rescontent = soup.find('div', id='rescontent')
+        
+        # attempt to find and include chapter specific images.
+        img = soup.find('div',{'id':'quizHeader'}).find('img')
+        #print("img['src'](%s) != self.coverurl(%s)"%(img['src'],self.coverurl))
+        if img['src'] != self.coverurl:
+            rescontent.insert(0,img)
+        
+        for a in rescontent('a'):
             a.unwrap()
 
-        return self.utf8FromSoup(url, element)
+        return self.utf8FromSoup(url, rescontent)

fanficfare/adapters/adapter_rabidreadercom.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2016 FanFicFare team
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# Software: eFiction
+from base_efiction_adapter import BaseEfictionAdapter
+
+class RabidReaderComAdapter(BaseEfictionAdapter):
+
+    @staticmethod
+    def getSiteDomain():
+        return 'www.therabidreader.com'
+
+    @classmethod
+    def getSiteAbbrev(self):
+        return 'rrcom'
+
+    @classmethod
+    def getDateFormat(self):
+        return "%d %b %Y"
+
+def getClass():
+    return RabidReaderComAdapter

fanficfare/adapters/adapter_storiesonlinenet.py

@@ -36,6 +36,7 @@ class StoriesOnlineNetAdapter(BaseSiteAdapter):
 
     def __init__(self, config, url):
         BaseSiteAdapter.__init__(self, config, url)
+        logger.debug("StoriesOnlineNetAdapter.__init__ - url='%s'" % url)
 
         self.username = "NoneGiven" # if left empty, site doesn't return any message at all.
         self.password = ""
@@ -50,12 +51,16 @@ class StoriesOnlineNetAdapter(BaseSiteAdapter):
         self._setURL('http://' + self.getSiteDomain() + '/s/'+self.story.getMetadata('storyId'))
 
         # Each adapter needs to have a unique site abbreviation.
-        self.story.setMetadata('siteabbrev','strol')
+        self.story.setMetadata('siteabbrev',self.getSiteAbbrev())
 
         # The date format will vary from site to site.
         # http://docs.python.org/library/datetime.html#strftime-strptime-behavior
         self.dateformat = "%Y-%m-%d"
 
+    @classmethod
+    def getSiteAbbrev(self):
+        return 'strol'
+
     @staticmethod # must be @staticmethod, don't remove it.
     def getSiteDomain():
         # The site domain.  Does have www here, if it uses it.
@@ -66,7 +71,7 @@ class StoriesOnlineNetAdapter(BaseSiteAdapter):
         return "http://"+cls.getSiteDomain()+"/s/1234 http://"+cls.getSiteDomain()+"/s/1234:4010"
 
     def getSiteURLPattern(self):
-        return re.escape("http://"+self.getSiteDomain())+r"/s/\d+((:\d+)?(;\d+)?$|(:i)?$)?"
+        return re.escape("http://"+self.getSiteDomain())+r"/(s|library)/(storyInfo.php\?id=)?(?P<id>\d+)((:\d+)?(;\d+)?$|(:i)?$)?"
 
     ## Login seems to be reasonably standard across eFiction sites.
     def needToLoginCheck(self, data):
@@ -142,6 +147,8 @@ class StoriesOnlineNetAdapter(BaseSiteAdapter):
             raise exceptions.AccessDenied(self.getSiteDomain() +" says: Access denied. This story has not been validated by the adminstrators of this site.")
         elif "Error! The story you're trying to access is being filtered by your choice of contents filtering." in data:
             raise exceptions.FailedToDownload(self.getSiteDomain() +" says: Error! The story you're trying to access is being filtered by your choice of contents filtering.")
+        elif "Error! Daily Limit Reached" in data:
+            raise exceptions.FailedToDownload(self.getSiteDomain() +" says: Error! Daily Limit Reached")
 
         # use BeautifulSoup HTML parser to make everything easier to find.
         soup = self.make_soup(data)
@@ -178,7 +185,8 @@ class StoriesOnlineNetAdapter(BaseSiteAdapter):
         page=0
         i=0
         while i == 0:
-            asoup = self.make_soup(self._fetchUrl(self.story.getList('authorUrl')[0]+"/"+unicode(page)))
+            data = self._fetchUrl(self.story.getList('authorUrl')[0]+"/"+unicode(page))
+            asoup = self.make_soup(data)
 
             a = asoup.findAll('td', {'class' : 'lc2'})
             for lc2 in a:
@@ -203,6 +211,7 @@ class StoriesOnlineNetAdapter(BaseSiteAdapter):
 
         try:
             a = lc4.find('a', href=re.compile(r"/series/\d+/.*"))
+            logger.debug("Looking for series - a='{0}'".format(a))
             if a:
                 # if there's a number after the series name, series_contents is a two element list:
                 # [<a href="...">Title</a>, u' (2)']
@@ -215,7 +224,8 @@ class StoriesOnlineNetAdapter(BaseSiteAdapter):
                 series_soup = self.make_soup(self._fetchUrl(seriesUrl))
                 if series_soup:
                     logger.debug("Retrieving Series - looking for name")
-                    series_name = series_soup.find('span', {'id' : 'ptitle'}).text.partition(' — ')[0]
+                    series_name = stripHTML(series_soup.find('span', {'id' : 'ptitle'}))
+                    series_name = re.sub(r' . a series by.*$','',series_name)
                     logger.debug("Series name: '{0}'".format(series_name))
                 self.setSeries(series_name, i)
                 desc = lc4.contents[2]
@@ -232,7 +242,7 @@ class StoriesOnlineNetAdapter(BaseSiteAdapter):
                         # The id is prefixed with the letter "u".
                         universe_id = universe.find('a')['id'][1:]
                         logger.debug("universe_id='%s'" % universe_id)
-                        universe_name = universe.find('div', {'class' : 'ser-name'}).text.partition(' ')[2]
+                        universe_name = stripHTML(universe.find('div', {'class' : 'ser-name'})).partition(' ')[2]
                         logger.debug("universe_name='%s'" % universe_name)
                         # If there is link to the story, we have the right universe
                         story_a = universe.find('a', href=re.compile('/s/'+self.story.getMetadata('storyId')))
@@ -244,6 +254,7 @@ class StoriesOnlineNetAdapter(BaseSiteAdapter):
                 else:
                     logger.debug("No universe page")
         except:
+            raise
             pass
         try:
             a = lc4.find('a', href=re.compile(r"/universe/\d+/.*"))
@@ -259,7 +270,8 @@ class StoriesOnlineNetAdapter(BaseSiteAdapter):
                 logger.debug("Retrieving Universe - have page")
                 if universe_soup:
                     logger.debug("Retrieving Universe - looking for name")
-                    universe_name = universe_soup.find('h1', {'id' : 'ptitle'}).text.partition('—')[0]
+                    universe_name = stripHTML(universe_soup.find('h1', {'id' : 'ptitle'}))
+                    universe_name = re.sub(r' . A Universe from the Mind.*$','',universe_name)
                     logger.debug("Universes name: '{0}'".format(universe_name))
 
                 self.story.setMetadata('universeUrl',universeUrl)
@@ -271,6 +283,7 @@ class StoriesOnlineNetAdapter(BaseSiteAdapter):
             else:
                 logger.debug("Do not have a universe")
         except:
+            raise
             pass
 
         self.setDescription('http://'+self.host+'/s/'+self.story.getMetadata('storyId'),desc)
@@ -290,7 +303,7 @@ class StoriesOnlineNetAdapter(BaseSiteAdapter):
 
             if 'Tags' in label or 'Codes' in label:
                 for code in re.split(r'\s*,\s*', value.strip()):
-                     self.story.addToList('sitetags',code)
+                    self.story.addToList('sitetags',code)
 
             if 'Posted' in label:
                 self.story.setMetadata('datePublished', makeDate(stripHTML(value), self.dateformat))

fanficfare/adapters/adapter_test1.py

@@ -34,6 +34,8 @@ class TestSiteAdapter(BaseSiteAdapter):
         self.story.setMetadata('storyId',self.parsedUrl.query.split('=',)[1])
         self.username=''
         self.is_adult=False
+        # happens inside BaseSiteAdapter.__init__
+        # self._setURL(url)
 
     @staticmethod
     def getSiteDomain():
@@ -117,7 +119,6 @@ class TestSiteAdapter(BaseSiteAdapter):
         else:
             self.story.setMetadata(u'title',"Test Story Title "+idstr)
             self.story.setMetadata('author','Test Author aa')
-        self.story.setMetadata('storyUrl',self.url)
         self.setDescription(self.url,u'Description '+self.crazystring+u''' Done
 <p>
 Some more longer description.  "I suck at summaries!"  "Better than it sounds!"  "My first fic"

fanficfare/adapters/adapter_thehexfilesnet.py

@@ -193,14 +193,10 @@ class TheHexFilesNetAdapter(BaseSiteAdapter):
         if None == soup:
             raise exceptions.FailedToDownload("Error downloading Chapter: %s!  Missing required element!" % url)
 
-        # Ugh.  chapter html doesn't haven't anything useful around it to demarcate.
-        for a in soup.findAll('table'):
+        content = soup.find('table',{'class':'table'}).find('td') # td inside <table class='table'>
+        content.name='div'
+        
+        for a in content.findAll('table'):
             a.extract()
 
-        for a in soup.findAll('head'):
-            a.extract()
-
-        html = soup.find('html')
-        html.name='div'
-
-        return self.utf8FromSoup(url,soup)
+        return self.utf8FromSoup(url,content)

fanficfare/adapters/adapter_tthfanficorg.py

@@ -131,7 +131,7 @@ class TwistingTheHellmouthSiteAdapter(BaseSiteAdapter):
             #print("data:%s"%data)
             soup = self.make_soup(data)
         except urllib2.HTTPError, e:
-            if e.code == 404:
+            if e.code in (404,410):
                 raise exceptions.StoryDoesNotExist(url)
             else:
                 raise e
@@ -257,10 +257,11 @@ class TwistingTheHellmouthSiteAdapter(BaseSiteAdapter):
         for cat in verticaltable.findAll('a', href=re.compile(r"^/Category-")):
             # assumes only one -Centered and one Pairing: cat can ever
             # be applied to one story.
-            if self.getConfig('centeredcat_to_characters') and cat.string.endswith('-Centered'):
+            # Seen at least once: incorrect (empty) cat link, thus "and cat.string"
+            if self.getConfig('centeredcat_to_characters') and cat.string and cat.string.endswith('-Centered'):
                 char = cat.string[:-len('-Centered')]
                 self.story.addToList('characters',char)
-            elif self.getConfig('pairingcat_to_characters_ships') and cat.string.startswith('Pairing: '):
+            elif self.getConfig('pairingcat_to_characters_ships') and cat.string and cat.string.startswith('Pairing: '):
                 pair = cat.string[len('Pairing: '):]
                 self.story.addToList('characters',pair)
                 if char:

fanficfare/adapters/base_adapter.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright 2011 Fanficdownloader team, 2015 FanFicFare team
+# Copyright 2011 Fanficdownloader team, 2016 FanFicFare team
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -187,7 +187,7 @@ class BaseSiteAdapter(Configurable):
         self.parsedUrl = up.urlparse(url)
         self.host = self.parsedUrl.netloc
         self.path = self.parsedUrl.path        
-        self.story.setMetadata('storyUrl',self.url)
+        self.story.setMetadata('storyUrl',self.url,condremoveentities=False)
 
 ## website encoding(s)--in theory, each website reports the character
 ## encoding they use for each page.  In practice, some sites report it
@@ -236,11 +236,11 @@ class BaseSiteAdapter(Configurable):
         '''
         cachekey=self._get_cachekey(url, parameters, headers)
         if usecache and self._has_cachekey(cachekey):
-            logger.debug("#####################################\npagecache HIT: %s"%cachekey)
+            logger.debug("#####################################\npagecache HIT: %s"%safe_url(cachekey))
             data,redirecturl = self._get_from_pagecache(cachekey)
             return data
         
-        logger.debug("#####################################\npagecache MISS: %s"%cachekey)
+        logger.debug("#####################################\npagecache MISS: %s"%safe_url(cachekey))
         self.do_sleep(extrasleep)
 
         ## u2.Request assumes POST when data!=None.  Also assumes data
@@ -279,7 +279,7 @@ class BaseSiteAdapter(Configurable):
         '''
         cachekey=self._get_cachekey(url, parameters)
         if usecache and self._has_cachekey(cachekey):
-            logger.debug("#####################################\npagecache HIT: %s"%cachekey)
+            logger.debug("#####################################\npagecache HIT: %s"%safe_url(cachekey))
             data,redirecturl = self._get_from_pagecache(cachekey)
             class FakeOpened:
                 def __init__(self,data,url):
@@ -289,7 +289,7 @@ class BaseSiteAdapter(Configurable):
                 def read(self): return self.data
             return (data,FakeOpened(data,redirecturl))
         
-        logger.debug("#####################################\npagecache MISS: %s"%cachekey)
+        logger.debug("#####################################\npagecache MISS: %s"%safe_url(cachekey))
         self.do_sleep(extrasleep)
         if parameters != None:
             opened = self.opener.open(url.replace(' ','%20'),urllib.urlencode(parameters),float(self.getConfig('connect_timeout',30.0)))
@@ -338,15 +338,15 @@ class BaseSiteAdapter(Configurable):
                 return (self._decode(data),opened)
             except u2.HTTPError, he:
                 excpt=he
-                if he.code in (403,404):
-                    logger.warn("Caught an exception reading URL: %s  Exception %s."%(unicode(url),unicode(he)))
+                if he.code in (403,404,410):
+                    logger.warn("Caught an exception reading URL: %s  Exception %s."%(unicode(safe_url(url)),unicode(he)))
                     break # break out on 404
             except Exception, e:
                 excpt=e
-                logger.warn("Caught an exception reading URL: %s sleeptime(%s) Exception %s."%(unicode(url),sleeptime,unicode(e)))
+                logger.warn("Caught an exception reading URL: %s sleeptime(%s) Exception %s."%(unicode(safe_url(url)),sleeptime,unicode(e)))
                 
-        logger.error("Giving up on %s" %url)
-        logger.exception(excpt)
+        logger.error("Giving up on %s" %safe_url(url))
+        logger.debug(excpt, exc_info=True)
         raise(excpt)
 
     # Limit chapters to download.  Input starts at 1, list starts at 0
@@ -571,11 +571,14 @@ class BaseSiteAdapter(Configurable):
         #print("include_images:"+self.getConfig('include_images'))
         if self.getConfig('include_images'):
             acceptable_attributes.extend(('src','alt','longdesc'))
-            for img in soup.findAll('img'):
-                # some pre-existing epubs have img tags that had src stripped off.
-                if img.has_attr('src'):
-                    (img['src'],img['longdesc'])=self.story.addImgUrl(url,img['src'],fetch,
-                                                                      coverexclusion=self.getConfig('cover_exclusion_regexp'))
+            try:
+                for img in soup.find_all('img'):
+                    # some pre-existing epubs have img tags that had src stripped off.
+                    if img.has_attr('src'):
+                        (img['src'],img['longdesc'])=self.story.addImgUrl(url,img['src'],fetch,
+                                                                          coverexclusion=self.getConfig('cover_exclusion_regexp'))
+            except AttributeError as ae:
+                logger.info("Parsing for img tags failed--probably poor input HTML.  Skipping images.")
 
         for attr in self.get_attr_keys(soup):
             if attr not in acceptable_attributes:
@@ -688,3 +691,8 @@ def makeDate(string,dateform):
             
     return datetime.datetime.strptime(string.encode('utf-8'),dateform.encode('utf-8'))
 
+# .? for AO3's ']' in param names.
+safe_url_re = re.compile(r'(?P<attr>(password|name|login).?=)[^&]*(?P<amp>&|$)',flags=re.MULTILINE)
+def safe_url(url):
+    # return url with password attr (if present) obscured.
+    return re.sub(safe_url_re,r'\g<attr>XXXXXXXX\g<amp>',url)

fanficfare/adapters/base_efiction_adapter.py

@@ -51,7 +51,7 @@ _WRONGPASSWORD = "That password doesn't match the one in our database"
 _USERACCOUNT = 'Member Account'
 
 # Regular expressions
-_REGEX_WARING_PARAM = re.compile("warning=(?P<warningId>\d+)")
+_REGEX_WARNING_PARAM = re.compile("warning=(?P<warningId>\d+)")
 _REGEX_CHAPTER_B = re.compile("^(?P<chapterId>\d+)\.")
 _REGEX_CHAPTER_PARAM = re.compile("chapter=(?P<chapterId>\d+)$")
 _REGEX_CHAPTER_FRAGMENT = re.compile("^#(?P<chapterId>\d+)$")
@@ -345,6 +345,8 @@ class BaseEfictionAdapter(BaseSiteAdapter):
                     self.triedLoggingIn = True
                 else:
                     raise exceptions.FailedToLogin(self.url, unicode(errorDiv))
+            elif "This story has not been validated" in stripHTML(errorDiv):
+                raise exceptions.AccessDenied(self.getSiteDomain() +" says: "+stripHTML(errorDiv))
             else:
                 warningLink = errorDiv.find("a")
                 if warningLink is not None and ( \
@@ -354,15 +356,15 @@ class BaseEfictionAdapter(BaseSiteAdapter):
                         if not (self.is_adult or self.getConfig("is_adult")):
                             raise exceptions.AdultCheckRequired(self.url)
                         # XXX Using this method, we're independent of # getHighestWarningLevel
-                        printUrl += "&ageconsent=ok&warning=%s" % (_REGEX_WARING_PARAM.search(warningLink['href']).group(1))
+                        printUrl += "&ageconsent=ok&warning=%s" % (_REGEX_WARNING_PARAM.search(warningLink['href']).group(1))
                         # printUrl += "&ageconsent=ok&warning=%s" % self.getHighestWarningLevel()
                         soup = self._fetch_to_soup(printUrl)
                         errorDiv = soup.find("div", "errortext")
                         self.triedAcceptWarnings = True
                     else:
-                        raise exception.FailedToDownload(self.url, unicode(errorDiv))
+                        raise exceptions.FailedToDownload("Error with URL: %s (%s)" % (self.url,stripHTML(errorDiv)))
                 else:
-                    raise exception.FailedToDownload(self.url, unicode(errorDiv))
+                    raise exceptions.FailedToDownload("Error with URL: %s (%s)" % (self.url,stripHTML(errorDiv)))
 
         # title and author
         pagetitleDiv = soup.find("div", {"id": "pagetitle"})
@@ -382,7 +384,7 @@ class BaseEfictionAdapter(BaseSiteAdapter):
             while nextEl is not None and not (\
                         type(nextEl) is bs.Tag \
                         and nextEl.name == "span" \
-                        and 'label' in nextEl['class'] \
+                        and 'label' in nextEl.get('class',[]) \
                         ):
                 ## must string copy nextEl or nextEl will change trees
                 if (type(nextEl) is bs.Tag):

fanficfare/adapters/base_xenforoforum_adapter.py

@@ -49,9 +49,9 @@ class BaseXenForoForumAdapter(BaseSiteAdapter):
         m = re.match(self.getSiteURLPattern(),url)
         if m:
             #logger.debug("groupdict:%s"%m.groupdict())
-            if m.group('post'):
-                self.story.setMetadata('storyId',m.group('post'))
-                self._setURL(self.getURLPrefix() + '/posts/'+m.group('post')+'/')
+            if m.group('anchorpost'):
+                self.story.setMetadata('storyId',m.group('anchorpost'))
+                self._setURL(self.getURLPrefix() + '/posts/'+m.group('anchorpost')+'/')
             else:
                 self.story.setMetadata('storyId',m.group('id'))
                 # normalized story URL.
@@ -83,7 +83,7 @@ class BaseXenForoForumAdapter(BaseSiteAdapter):
         return cls.getURLPrefix()+"/threads/some-story-name.123456/ "+cls.getURLPrefix()+"/posts/123456/"
 
     def getSiteURLPattern(self):
-        return r"https?://"+re.escape(self.getSiteDomain())+r"/(?P<tp>threads|posts)/(.+\.)?(?P<id>\d+)/?[^#]*?(#post-(?P<post>\d+))?$"
+        return r"https?://"+re.escape(self.getSiteDomain())+r"/(?P<tp>threads|posts)/(.+\.)?(?P<id>\d+)/?[^#]*?(#post-(?P<anchorpost>\d+))?$"
 
     def use_pagecache(self):
         '''
@@ -150,7 +150,7 @@ class BaseXenForoForumAdapter(BaseSiteAdapter):
                 raise
 
         # use BeautifulSoup HTML parser to make everything easier to find.
-        soup = self.make_soup(data)
+        topsoup = soup = self.make_soup(data)
 
         a = soup.find('h3',{'class':'userText'}).find('a')
         self.story.addToList('authorId',a['href'].split('/')[1])
@@ -160,6 +160,9 @@ class BaseXenForoForumAdapter(BaseSiteAdapter):
         h1 = soup.find('div',{'class':'titleBar'}).h1
         self.story.setMetadata('title',stripHTML(h1))
 
+        first_post_title = self.getConfig('first_post_title','First Post')
+
+        threadmark_chaps = False
         if '#' in useurl:
             anchorid = useurl.split('#')[1]
             soup = soup.find('li',id=anchorid)
@@ -176,7 +179,11 @@ class BaseXenForoForumAdapter(BaseSiteAdapter):
                     ## SV changed their threadmarks.  Not isolated to
                     ## SV only incase SB or QQ make the same change.
                     markas = soupmarks.find('div',{'class':'threadmarks'}).find_all('a',{'class':'PreviewTooltip'})
-                if len(markas) > 1:
+                if len(markas) >= int(self.getConfig('minimum_threadmarks',2)):
+                    threadmark_chaps = True
+                    if self.getConfig('always_include_first_post'):
+                        self.chapterUrls.append((first_post_title,useurl))
+                    
                     for (atag,url,name) in [ (x,x['href'],stripHTML(x)) for x in markas ]:
                         date = self.make_date(atag.find_next_sibling('div',{'class':'extra'}))
                         if not self.story.getMetadataRaw('datePublished') or date < self.story.getMetadataRaw('datePublished'):
@@ -186,16 +193,16 @@ class BaseXenForoForumAdapter(BaseSiteAdapter):
 
                         self.chapterUrls.append((name,self.getURLPrefix()+'/'+url))
 
-                    ## only use tags if threadmarks for chapters.
-                    ##  a bit arbitrary, but likely.
-                    for tag in soup.findAll('a',{'class':'tag'}):
-                        tstr = stripHTML(tag)
-                        if self.getConfig('capitalize_forumtags'):
-                            tstr = tstr.title()
-                        self.story.addToList('forumtags',tstr)
-
             soup = soup.find('li',{'class':'message'}) # limit first post for date stuff below. ('#' posts above)
 
+        if threadmark_chaps or self.getConfig('always_use_forumtags'):
+            ## only  use  tags if  threadmarks  for  chapters or
+            for tag in topsoup.findAll('a',{'class':'tag'}):
+                tstr = stripHTML(tag)
+                if self.getConfig('capitalize_forumtags'):
+                    tstr = tstr.title()
+                self.story.addToList('forumtags',tstr)
+            
         # Now go hunting for the 'chapter list'.
         bq = soup.find('blockquote') # assume first posting contains TOC urls.
 
@@ -211,8 +218,9 @@ class BaseXenForoForumAdapter(BaseSiteAdapter):
 
         # otherwise, use first post links--include first post since
         # that's often also the first chapter.
+
         if not self.chapterUrls:
-            self.chapterUrls.append(("First Post",useurl))
+            self.chapterUrls.append((first_post_title,useurl))
             for (url,name) in [ (x['href'],stripHTML(x)) for x in bq.find_all('a') ]:
                 #logger.debug("found chapurl:%s"%url)
                 if not url.startswith('http'):
@@ -230,9 +238,9 @@ class BaseXenForoForumAdapter(BaseSiteAdapter):
 
                     logger.debug("(ch:%s)used chapurl:%s"%(len(self.chapterUrls)+1,url))
                     self.chapterUrls.append((name,url))
-                    if url == useurl and 'First Post' == self.chapterUrls[0][0]:
+                    if url == useurl and first_post_title == self.chapterUrls[0][0] \
+                            and not self.getConfig('always_include_first_post',False):
                         # remove "First Post" if included in list.
-                        logger.debug("delete dup 'First Post' chapter: %s %s"%self.chapterUrls[0])
                         del self.chapterUrls[0]
 
             # Didn't use threadmarks, so take created/updated dates

fanficfare/cli.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright 2015 Fanficdownloader team, 2015 FanFicFare team
+# Copyright 2015 Fanficdownloader team, 2016 FanFicFare team
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -31,7 +31,7 @@ if sys.version_info < (2, 5):
     sys.exit(1)
 
 if sys.version_info >= (2, 7):
-    # suppresses default logger.  Logging is setup in fanficdownload/__init__.py so it works in calibre, too.
+    # suppresses default logger.  Logging is setup in fanficfare/__init__.py so it works in calibre, too.
     rootlogger = logging.getLogger()
     loghandler = logging.NullHandler()
     loghandler.setFormatter(logging.Formatter('(=====)(levelname)s:%(message)s'))
@@ -39,11 +39,11 @@ if sys.version_info >= (2, 7):
 
 try:
     # running under calibre
-    from calibre_plugins.fanfictiondownloader_plugin.fanficfare import adapters, writers, exceptions
-    from calibre_plugins.fanfictiondownloader_plugin.fanficfare.configurable import Configuration
-    from calibre_plugins.fanfictiondownloader_plugin.fanficfare.epubutils import (
+    from calibre_plugins.fanficfare_plugin.fanficfare import adapters, writers, exceptions
+    from calibre_plugins.fanficfare_plugin.fanficfare.configurable import Configuration
+    from calibre_plugins.fanficfare_plugin.fanficfare.epubutils import (
         get_dcsource_chaptercount, get_update_data, reset_orig_chapters_epub)
-    from calibre_plugins.fanfictiondownloader_plugin.fanficfare.geturls import get_urls_from_page
+    from calibre_plugins.fanficfare_plugin.fanficfare.geturls import get_urls_from_page
 except ImportError:
     from fanficfare import adapters, writers, exceptions
     from fanficfare.configurable import Configuration
@@ -355,6 +355,7 @@ def do_download(arg,
             # regular download
             if options.metaonly:
                 pprint.pprint(adapter.getStoryMetadataOnly().getAllMetadata())
+                pprint.pprint(adapter.chapterUrls)
 
             output_filename = write_story(configuration, adapter, options.format, options.metaonly)
 

fanficfare/configurable.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright 2015 Fanficdownloader team, 2015 FanFicFare team
+# Copyright 2015 Fanficdownloader team, 2016 FanFicFare team
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -111,8 +111,6 @@ def get_valid_list_entries():
                  'authorId',
                  'authorUrl',
                  'lastupdate',
-                 'keep_html_attrs',
-                 'replace_tags_with_spans',
                  ])
 
 boollist=['true','false']
@@ -125,6 +123,10 @@ def get_valid_set_options():
     '''
     dict() of names of boolean options, but as a tuple with
     valid sites, valid formats and valid values (None==all)
+
+    This is to further restrict keywords to certain sections and/or
+    values.  get_valid_keywords() below is the list of allowed
+    keywords.  Any keyword listed here must also be listed there.
     '''
 
     valdict = {'collect_series':(None,None,boollist),
@@ -158,12 +160,16 @@ def get_valid_set_options():
 
                'force_login':(['phoenixsong.net'],None,boollist),
                'non_breaking_spaces':(['fictionmania.tv'],None,boollist),
-               'universe_as_series':(['storiesonline.net'],None,boollist),
+               'universe_as_series':(['storiesonline.net','finestories.com'],None,boollist),
                'strip_text_links':(['bloodshedverse.com'],None,boollist),
                'centeredcat_to_characters':(['tthfanfic.org'],None,boollist),
                'pairingcat_to_characters_ships':(['tthfanfic.org'],None,boollist),
                'romancecat_to_characters_ships':(['tthfanfic.org'],None,boollist),
 
+               'use_meta_keywords':(['literotica.com'],None,boollist),
+               'clean_chapter_titles':(['literotica.com'],None,boollist),
+               'description_in_chapter':(['literotica.com'],None,boollist),
+
                # eFiction Base adapters allow bulk_load
                # kept forgetting to add them, so now it's automatic.
                'bulk_load':(adapters.get_bulk_load_sites(),
@@ -177,8 +183,11 @@ def get_valid_set_options():
                'grayscale_images':(None,['epub','html'],boollist),
                'no_image_processing':(None,['epub','html'],boollist),
 
+               'capitalize_forumtags':(base_xenforo_list,None,boollist),
                'continue_on_chapter_error':(base_xenforo_list,None,boollist),
-               '':(base_xenforo_list,None,boollist),
+               'minimum_threadmarks':(base_xenforo_list,None,None),
+               'first_post_title':(base_xenforo_list,None,None),
+               'always_include_first_post':(base_xenforo_list,None,boollist),
                }
 
     return dict(valdict)
@@ -318,6 +327,9 @@ def get_valid_keywords():
                  'centeredcat_to_characters',
                  'pairingcat_to_characters_ships',
                  'romancecat_to_characters_ships',
+                 'use_meta_keywords',
+                 'clean_chapter_titles',
+                 'description_in_chapter',
                  'titlepage_end',
                  'titlepage_entries',
                  'titlepage_entry',
@@ -339,8 +351,12 @@ def get_valid_keywords():
                  'wrap_width',
                  'zip_filename',
                  'zip_output',
-                 'continue_on_chapter_error',
                  'capitalize_forumtags',
+                 'continue_on_chapter_error',
+                 'minimum_threadmarks',
+                 'first_post_title',
+                 'always_include_first_post',
+                 '',
                  ])
 
 # *known* entry keywords -- or rather regexps for them.
@@ -365,10 +381,12 @@ def make_generate_cover_settings(param):
 
 class Configuration(ConfigParser.SafeConfigParser):
 
-    def __init__(self, sections, fileform):
+    def __init__(self, sections, fileform, lightweight=False):
         site = sections[-1] # first section is site DN.
         ConfigParser.SafeConfigParser.__init__(self)
 
+        self.lightweight = lightweight
+        
         self.linenos=dict() # key by section or section,key -> lineno
         
         ## [injected] section has even less priority than [defaults]
@@ -403,8 +421,25 @@ class Configuration(ConfigParser.SafeConfigParser):
         
         self.validEntries = get_valid_entries()
 
-    def addConfigSection(self,section):
-        self.sectionslist.insert(0,section)
+        self.url_config_set = False
+
+    def addUrlConfigSection(self,url):
+        if not self.lightweight: # don't need when just checking for normalized URL.
+            # replace if already set once.
+            if self.url_config_set:
+                self.sectionslist[self.sectionslist.index('overrides')+1]=url
+            else:
+                self.addConfigSection(url,'overrides')
+                self.url_config_set=True
+
+    def addConfigSection(self,section,before=None):
+        if section not in self.sectionslist: # don't add if already present.
+            if before is None:
+                self.sectionslist.insert(0,section)
+            else:
+                ## because sectionslist is hi-pri first, lo-pri last,
+                ## 'before' means after in the list.
+                self.sectionslist.insert(self.sectionslist.index(before)+1,section)
 
     def isListType(self,key):
         return key in self.listTypeEntries or self.hasConfig("include_in_"+key)
@@ -604,7 +639,10 @@ class Configuration(ConfigParser.SafeConfigParser):
     def test_config(self):
         errors=[]
 
-        teststory_re = re.compile(r'^teststory:(defaults|[0-9]+)$')
+        ## too complicated right now to enforce
+        ## get_valid_set_options() warnings on teststory and
+        ## [storyUrl] sections.
+        allow_all_sections_re = re.compile(r'^(teststory:(defaults|[0-9]+)|https?://.*)$')
         allowedsections = get_valid_sections()
 
         clude_metadata_re = re.compile(r'(add_to_)?(in|ex)clude_metadata_(pre|post)')
@@ -614,12 +652,13 @@ class Configuration(ConfigParser.SafeConfigParser):
 
         custom_columns_settings_re = re.compile(r'(add_to_)?custom_columns_settings')
         
-        generate_cover_settings_re = re.compile(r'(add_to_)?generate_cover_settings')        
-
+        generate_cover_settings_re = re.compile(r'(add_to_)?generate_cover_settings')
+        
         valdict = get_valid_set_options()
         
         for section in self.sections():
-            if section not in allowedsections and not teststory_re.match(section):
+            allow_all_section = allow_all_sections_re.match(section)
+            if section not in allowedsections and not allow_all_section:
                 errors.append((self.get_lineno(section),"Bad Section Name: [%s]"%section))
             else:
                 sitename = section.replace('www.','')
@@ -657,26 +696,25 @@ class Configuration(ConfigParser.SafeConfigParser):
                         # timeline=>#ccolumn,n
                         # "FanFiction"=>#collection
 
-                        def make_sections(x):
-                            return '['+'], ['.join(x)+']'
-                        if keyword in valdict:
-                            (valsites,valformats,vals)=valdict[keyword]
-                            if valsites != None and sitename != None and sitename not in valsites:
-                                errors.append((self.get_lineno(section,keyword),"%s not valid in section [%s] -- only valid in %s sections."%(keyword,section,make_sections(valsites))))
-                            if valformats != None and formatname != None and formatname not in valformats:
-                                errors.append((self.get_lineno(section,keyword),"%s not valid in section [%s] -- only valid in %s sections."%(keyword,section,make_sections(valformats))))
-                            if value not in vals:
-                                errors.append((self.get_lineno(section,keyword),"%s not a valid value for %s"%(value,keyword)))
+                        if not allow_all_section:
+                            def make_sections(x):
+                                return '['+'], ['.join(x)+']'
+                            if keyword in valdict:
+                                (valsites,valformats,vals)=valdict[keyword]
+                                if valsites != None and sitename != None and sitename not in valsites:
+                                    errors.append((self.get_lineno(section,keyword),"%s not valid in section [%s] -- only valid in %s sections."%(keyword,section,make_sections(valsites))))
+                                if valformats != None and formatname != None and formatname not in valformats:
+                                    errors.append((self.get_lineno(section,keyword),"%s not valid in section [%s] -- only valid in %s sections."%(keyword,section,make_sections(valformats))))
+                                if vals != None and value not in vals:
+                                    errors.append((self.get_lineno(section,keyword),"%s not a valid value for %s"%(value,keyword)))
 
-                            
                         ## skipping output_filename_safepattern
                         ## regex--not used with plugin and this isn't
                         ## used with CLI/web yet.
 
                     except Exception as e:
-                        errors.append((self.get_lineno(section,keyword),"Error:%s in (%s:%s)"%(e,keyword,value)))
-                
-        
+                        errors.append((self.get_lineno(section,keyword),"Error:%s in (%s:%s)"%(e,keyword,value)))                
+
         return errors
 
 # extended by adapter, writer and story for ease of calling configuration.
@@ -685,6 +723,12 @@ class Configurable(object):
     def __init__(self, configuration):
         self.configuration = configuration
 
+    def is_lightweight(self):
+        return self.configuration.lightweight
+
+    def addUrlConfigSection(self,url):
+        self.configuration.addUrlConfigSection(url)
+        
     def isListType(self,key):
         return self.configuration.isListType(key)
 

fanficfare/defaults.ini

@@ -1,4 +1,4 @@
-# Copyright 2015 Fanficdownloader team, 2015 FanFicFare team
+# Copyright 2015 Fanficdownloader team, 2016 FanFicFare team
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -487,6 +487,33 @@ description_limit:500
 ## in the ebook for that chapter.
 continue_on_chapter_error:false
 
+## When given a thread URL, use threadmarks as chapter links when
+## there are at least this many threadmarks.  A number of older
+## threads have a single threadmark to an 'index' post.  Set to 1 to
+## use threadmarks whenever they exist.
+minimum_threadmarks:2
+
+## When 'first post' (or post URL) is being added as a chapter, give
+## the chapter this title.
+first_post_title:First Post
+
+## In normal operation, if given a post URL or a thread URL with less
+## than minimum_threadmarks, the given post or the first post of the
+## thread will be included as the first chapter (with chapter title
+## from first_post_title) unless that post is explicitly linked to in
+## the collected chapter list.  First post is not included when using
+## thread marks.
+##
+## If always_include_first_post:true, then the given or first post
+## will be included as above even if it is a link in the post or even
+## if threadmarks are used.  Can result in a duplicated chapter.
+always_include_first_post:false
+
+## In normal operation, forumtags will only be populated when
+## threadmarks are used for chapters (see minimum_threadmarks above).
+## When always_use_forumtags:true, always populate forumtags.
+always_use_forumtags:false
+
 ## Each output format has a section that overrides [defaults]
 [html]
 
@@ -1181,14 +1208,41 @@ dislikes_label:Dislikes
 ## program can prompt you, or you can save it in config.  In
 ## commandline version, this should go in your personal.ini, not
 ## defaults.ini.
-#username:YourName
+## finestories.com has started requiring login by email rather than
+## pen name.
+#username:youremail@yourdomain.dom
 #password:yourpassword
 
-# shows size as "10 KB", not word count
-extra_valid_entries:size
+## Clear FanFiction from defaults, site is original fiction.
+extratags:
 
-# don't show twitter icon.
-cover_exclusion_regexp:/res/css/bir.png
+extra_valid_entries:size,universe,universeUrl,universeHTML,sitetags,notice,codes,score
+#extra_titlepage_entries:size,universeHTML,sitetags,notice,score
+include_in_codes:sitetags
+
+## adds to include_subject_tags instead of replacing it.
+#extra_subject_tags:sitetags
+
+size_label:Size
+universe_label:Universe
+universeUrl_label:Universe URL
+universeHTML_label:Universe
+sitetags_label:Site Tags
+notice_label:Notice
+score_label:Score
+
+## Assume entryUrl, apply to "<a class='%slink' href='%s'>%s</a>" to
+## make entryHTML.
+make_linkhtml_entries:universe
+
+## storiesonline.net stories can be in a series or a universe, but not
+## both.  By default, universe will be populated in 'series' with
+## index=0
+universe_as_series: true
+
+## some sites include images that we don't ever want becoming the
+## cover image.  This lets you exclude them.
+cover_exclusion_regexp:/css/bir.png
 
 [forums.spacebattles.com]
 ## see [base_xenforoforum]
@@ -1268,9 +1322,21 @@ crossoverfandom_label:Crossover Fandom
 extra_titlepage_entries:universe,crossoverfandom
 
 [literotica.com]
-extra_valid_entries:eroticatags
+extra_valid_entries:eroticatags,averrating
 eroticatags_label:Erotica Tags
-extra_titlepage_entries: eroticatags
+averrating_label:Average Rating
+extra_titlepage_entries:eroticatags,averrating
+
+## Extract more erotica_tags from the meta tag of each chapter
+use_meta_keywords: true
+
+## For multiple chapter stories, attempt to clean up the chapter title. This will
+## remove the story title and change "Ch. 01" to "Chapter 1", "Pt. 01" to "Part 1"
+## or just use the text. If this can't be done, the full title is used.
+clean_chapter_titles: false
+
+## Add the chapter description at the start of each chapter.
+description_in_chapter: false
 
 [lotrfanfiction.com]
 extra_valid_entries: readings
@@ -1891,6 +1957,9 @@ extracategories:Harry Potter
 ## Site dedicated to these categories/characters/ships
 extracategories:Harry Potter
 
+extra_valid_entries:reads,reviews
+reads_label:Total Read Count
+
 [www.hpfanficarchive.com]
 ## Site dedicated to these categories/characters/ships
 extracategories:Harry Potter
@@ -2209,6 +2278,96 @@ extracategories:Stargate: Atlantis
 extra_valid_entries:reviews
 reviews_label:Reviews
 
+[buffygiles.velocitygrass.com]
+## Some sites do not require a login, but do require the user to
+## confirm they are adult for adult content.  In commandline version,
+## this should go in your personal.ini, not defaults.ini.
+#is_adult:true
+
+## Some sites require login (or login for some rated stories) The
+## program can prompt you, or you can save it in config.  In
+## commandline version, this should go in your personal.ini, not
+## defaults.ini.
+#username:YourName
+#password:yourpassword
+
+## Site dedicated to these categories/characters/ships
+extracharacters:Buffy,Giles
+
+[fanfiction.lucifael.com]
+## Some sites do not require a login, but do require the user to
+## confirm they are adult for adult content.  In commandline version,
+## this should go in your personal.ini, not defaults.ini.
+#is_adult:true
+
+## Some sites require login (or login for some rated stories) The
+## program can prompt you, or you can save it in config.  In
+## commandline version, this should go in your personal.ini, not
+## defaults.ini.
+#username:YourName
+#password:yourpassword
+
+[www.andromeda-web.com]
+## Some sites do not require a login, but do require the user to
+## confirm they are adult for adult content.  In commandline version,
+## this should go in your personal.ini, not defaults.ini.
+#is_adult:true
+
+## Some sites require login (or login for some rated stories) The
+## program can prompt you, or you can save it in config.  In
+## commandline version, this should go in your personal.ini, not
+## defaults.ini.
+#username:YourName
+#password:yourpassword
+
+## Site dedicated to these categories/characters/ships
+extracategories:Andromeda
+
+[www.artemis-fowl.com]
+## Some sites do not require a login, but do require the user to
+## confirm they are adult for adult content.  In commandline version,
+## this should go in your personal.ini, not defaults.ini.
+#is_adult:true
+
+## Some sites require login (or login for some rated stories) The
+## program can prompt you, or you can save it in config.  In
+## commandline version, this should go in your personal.ini, not
+## defaults.ini.
+#username:YourName
+#password:yourpassword
+
+## Site dedicated to these categories/characters/ships
+extracategories:Artemis Fowl
+
+[www.therabidreader.com]
+## Some sites do not require a login, but do require the user to
+## confirm they are adult for adult content.  In commandline version,
+## this should go in your personal.ini, not defaults.ini.
+#is_adult:true
+
+## Some sites require login (or login for some rated stories) The
+## program can prompt you, or you can save it in config.  In
+## commandline version, this should go in your personal.ini, not
+## defaults.ini.
+#username:YourName
+#password:yourpassword
+
+
+[www.naiceanilme.net]
+## Some sites do not require a login, but do require the user to
+## confirm they are adult for adult content.  In commandline version,
+## this should go in your personal.ini, not defaults.ini.
+#is_adult:true
+
+## Some sites require login (or login for some rated stories) The
+## program can prompt you, or you can save it in config.  In
+## commandline version, this should go in your personal.ini, not
+## defaults.ini.
+#username:YourName
+#password:yourpassword
+
+
+
 [overrides]
 ## It may sometimes be useful to override all of the specific format,
 ## site and site:format sections in your private configuration.  For

fanficfare/geturls.py

@@ -35,7 +35,7 @@ from exceptions import UnknownSite
 def get_urls_from_page(url,configuration=None,normalize=False):
 
     if not configuration:
-        configuration = Configuration("test1.com","EPUB")
+        configuration = Configuration(["test1.com"],"EPUB",lightweight=True)
 
     data = None
     adapter = None
@@ -84,7 +84,7 @@ def get_urls_from_html(data,url=None,configuration=None,normalize=False,restrict
     urls = collections.OrderedDict()
 
     if not configuration:
-        configuration = Configuration("test1.com","EPUB")
+        configuration = Configuration(["test1.com"],"EPUB",lightweight=True)
 
     soup = BeautifulSoup(data,"html5lib")
     if restrictsearch:
@@ -128,7 +128,7 @@ def get_urls_from_text(data,configuration=None,normalize=False):
     data=unicode(data)
 
     if not configuration:
-        configuration = Configuration("test1.com","EPUB")
+        configuration = Configuration(["test1.com"],"EPUB",lightweight=True)
     
     for href in re.findall('http[s]?://(?:[a-zA-Z]|[0-9]|[$-_@.&+]|[!*\(\),]|(?:%[0-9a-fA-F][0-9a-fA-F]))+', data):
         # this (should) catch normal story links, some javascript

fanficfare/story.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright 2011 Fanficdownloader team, 2015 FanFicFare team
+# Copyright 2011 Fanficdownloader team, 2016 FanFicFare team
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -380,8 +380,8 @@ def set_in_ex_clude(setting):
 ## metakey[,metakey]=>pattern=>replacement[&&metakey=>regexp]
 def make_replacements(replace):
     retval=[]
-    for fullline in replace.splitlines():
-        line=fullline
+    for repl_line in replace.splitlines():
+        line=repl_line
         try:
             (metakeys,regexp,replacement,condkey,condregexp)=(None,None,None,None,None)
             if "&&" in line:
@@ -403,10 +403,10 @@ def make_replacements(replace):
                 # replacement string.  The .ini parser eats any
                 # trailing spaces.
                 replacement=replacement.replace(SPACE_REPLACE,' ')
-                retval.append([metakeys,regexp,replacement,condkey,condregexp])
+                retval.append([repl_line,metakeys,regexp,replacement,condkey,condregexp])
         except Exception as e:
-            logger.error("Problem with Replacement Line:%s"%fullline)
-            raise exceptions.PersonalIniFailed(e,'replace_metadata unpacking failed',fullline)
+            logger.error("Problem with Replacement Line:%s"%repl_line)
+            raise exceptions.PersonalIniFailed(e,'replace_metadata unpacking failed',repl_line)
 #            raise
     return retval
 
@@ -419,38 +419,51 @@ class Story(Configurable):
             self.metadata = {'version':os.environ['CURRENT_VERSION_ID']}
         except:
             self.metadata = {'version':'4.4'}
+        self.replacements = []
         self.in_ex_cludes = {}
         self.chapters = [] # chapters will be namedtuple of Chapter(url,title,html,etc)
         self.chapter_first = None
         self.chapter_last = None
         self.imgurls = []
         self.imgtuples = []
+        # save processed metadata, dicts keyed by 'key', then (removeentities,dorepl)
+        # {'key':{(removeentities,dorepl):"value",(...):"value"},'key':... }
+        self.processed_metadata_cache = {}
 
         self.cover=None # *href* of new cover image--need to create html.
         self.oldcover=None # (oldcoverhtmlhref,oldcoverhtmltype,oldcoverhtmldata,oldcoverimghref,oldcoverimgtype,oldcoverimgdata)
         self.calibrebookmark=None # cheesy way to carry calibre bookmark file forward across update.
         self.logfile=None # cheesy way to carry log file forward across update.
 
-        ## Look for config parameter, split and add each to metadata field.
-        for (config,metadata) in [("extracategories","category"),
-                                  ("extragenres","genre"),
-                                  ("extracharacters","characters"),
-                                  ("extraships","ships"),
-                                  ("extrawarnings","warnings")]:
-            for val in self.getConfigList(config):
-                self.addToList(metadata,val)
+        self.replacements_prepped = False
 
-        self.replacements = make_replacements(self.getConfig('replace_metadata'))
-
-        in_ex_clude_list = ['include_metadata_pre','exclude_metadata_pre',
-                            'include_metadata_post','exclude_metadata_post']
-        for ie in in_ex_clude_list:
-            ies = self.getConfig(ie)
-            # print("%s %s"%(ie,ies))
-            if ies:
-                iel = []
-                self.in_ex_cludes[ie] = set_in_ex_clude(ies)
+    def prepare_replacements(self):
+        if not self.replacements_prepped and not self.is_lightweight():
+            # logger.debug("prepare_replacements")
+            # logger.debug("sections:%s"%self.configuration.sectionslist)
+            
+            ## Look for config parameter, split and add each to metadata field.
+            for (config,metadata) in [("extracategories","category"),
+                                      ("extragenres","genre"),
+                                      ("extracharacters","characters"),
+                                      ("extraships","ships"),
+                                      ("extrawarnings","warnings")]:
+                for val in self.getConfigList(config):
+                    self.addToList(metadata,val)
+    
+            self.replacements =  make_replacements(self.getConfig('replace_metadata'))
+    
+            in_ex_clude_list = ['include_metadata_pre','exclude_metadata_pre',
+                                'include_metadata_post','exclude_metadata_post']
+            for ie in in_ex_clude_list:
+                ies = self.getConfig(ie)
+                # print("%s %s"%(ie,ies))
+                if ies:
+                    iel = []
+                    self.in_ex_cludes[ie] = set_in_ex_clude(ies)
+            self.replacements_prepped = True
 
+    
     def set_chapters_range(self,first=None,last=None):
         self.chapter_first=first
         self.chapter_last=last
@@ -460,6 +473,9 @@ class Story(Configurable):
 
     def setMetadata(self, key, value, condremoveentities=True):
 
+        # delete 
+        if key in self.processed_metadata_cache:
+            del self.processed_metadata_cache[key]
         # keep as list type, but set as only value.
         if self.isList(key):
             self.addToList(key,value,condremoveentities=condremoveentities,clear=True)
@@ -482,8 +498,18 @@ class Story(Configurable):
             self.addToList('lastupdate',value.strftime("Last Update Year/Month: %Y/%m"),clear=True)
             self.addToList('lastupdate',value.strftime("Last Update: %Y/%m/%d"))
 
+        if key == 'storyUrl' and value:
+            self.addUrlConfigSection(value) # adapter/writer share the
+                                            # same configuration.
+                                            # ignored if config
+                                            # is_lightweight()
+            self.replacements_prepped = False
 
     def do_in_ex_clude(self,which,value,key):
+        # sets self.replacements and self.in_ex_cludes if needed
+        # do_in_ex_clude is always called from doReplacements, so redundant.
+        # self.prepare_replacements()
+        
         if value and which in self.in_ex_cludes:
             include = 'include' in which
             keyfound = False
@@ -512,8 +538,10 @@ class Story(Configurable):
                 value = None
         return value
 
-
     def doReplacements(self,value,key,return_list=False,seen_list=[]):
+        # sets self.replacements and self.in_ex_cludes if needed
+        self.prepare_replacements()
+
         value = self.do_in_ex_clude('include_metadata_pre',value,key)
         value = self.do_in_ex_clude('exclude_metadata_pre',value,key)
 
@@ -523,7 +551,7 @@ class Story(Configurable):
                 # print("bailing on %s"%replaceline)
                 continue
             #print("replacement tuple:%s"%replaceline)
-            (metakeys,regexp,replacement,condkey,condregexp) = replaceline
+            (repl_line,metakeys,regexp,replacement,condkey,condregexp) = replaceline
             if (metakeys == None or key in metakeys) \
                     and isinstance(value,basestring) \
                     and regexp.search(value):
@@ -541,21 +569,28 @@ class Story(Configurable):
                     if SPLIT_META in replacement:
                         retlist = []
                         for splitrepl in replacement.split(SPLIT_META):
-                            retlist.extend(self.doReplacements(regexp.sub(splitrepl,value),
+                            try:
+                                tval = regexp.sub(splitrepl,value)
+                            except:
+                                logger.error("Exception with replacement line,value:(%s),(%s)"%(repl_line,value))
+                                raise
+                            retlist.extend(self.doReplacements(tval,
                                                                key,
                                                                return_list=True,
                                                                seen_list=seen_list+[replaceline]))
                         break
                     else:
                         # print("replacement,value:%s,%s->%s"%(replacement,value,regexp.sub(replacement,value)))
-                        value = regexp.sub(replacement,value)
-                        retlist = [value]
+                        try:
+                            value = regexp.sub(replacement,value)
+                            retlist = [value]
+                        except:
+                            logger.error("Exception with replacement line,value:(%s),(%s)"%(repl_line,value))
+                            raise
 
         for val in retlist:
             retlist = map(partial(self.do_in_ex_clude,'include_metadata_post',key=key),retlist)
             retlist = map(partial(self.do_in_ex_clude,'exclude_metadata_post',key=key),retlist)
-        # value = self.do_in_ex_clude('include_metadata_post',value,key)
-        # value = self.do_in_ex_clude('exclude_metadata_post',value,key)
 
         if return_list:
             return retlist
@@ -636,13 +671,16 @@ class Story(Configurable):
         if not self.isValidMetaEntry(key):
             return value
 
-        if self.isList(key):
+        # check for a cached value to speed processing
+        if key in self.processed_metadata_cache \
+                and (removeallentities,doreplacements) in self.processed_metadata_cache[key]:
+            return self.processed_metadata_cache[key][(removeallentities,doreplacements)]
+        elif self.isList(key):
             # join_string = self.getConfig("join_string_"+key,u", ").replace(SPACE_REPLACE,' ')
             # value = join_string.join(self.getList(key, removeallentities, doreplacements=True))
             value = self.join_list(key,self.getList(key, removeallentities, doreplacements=True))
             if doreplacements:
                 value = self.doReplacements(value,key+"_LIST")
-            return value
         elif self.metadata.has_key(key):
             value = self.metadata[key]
             if value:
@@ -667,11 +705,16 @@ class Story(Configurable):
             if doreplacements:
                 value=self.doReplacements(value,key)
             if removeallentities and value != None:
-                return removeAllEntities(value)
-            else:
-                return value
+                value = removeAllEntities(value)
         else: #if self.getConfig("default_value_"+key):
-            return self.getConfig("default_value_"+key)
+            value = self.getConfig("default_value_"+key)
+
+        # save a cached value to speed processing
+        if key not in self.processed_metadata_cache:
+            self.processed_metadata_cache[key] = {}
+        self.processed_metadata_cache[key][(removeallentities,doreplacements)] = value
+        
+        return value
 
     def getAllMetadata(self,
                        removeallentities=False,
@@ -1024,9 +1067,9 @@ class Story(Configurable):
 
         prefix='ffdl'
         if imgurl not in self.imgurls:
-            parsedUrl = urlparse.urlparse(imgurl)
 
             try:
+                parsedUrl = urlparse.urlparse(imgurl)
                 if self.getConfig('no_image_processing'):
                     (data,ext,mime) = no_convert_image(imgurl,
                                                        fetch(imgurl))
@@ -1118,5 +1161,5 @@ def unique_list(seq):
     try:
         return [x for x in seq if not (x in seen or seen_add(x))]
     except:
-        print("unique_list exception seq:%s"%seq)
+        logger.debug("unique_list exception seq:%s"%seq)
         raise

setup.py

@@ -23,7 +23,7 @@ setup(
     # Versions should comply with PEP440.  For a discussion on single-sourcing
     # the version across setup.py and the project code, see
     # https://packaging.python.org/en/latest/single_source_version.html
-    version="2.2.17",
+    version="2.3.1",
 
     description='A tool for downloading fanfiction to eBook formats',
     long_description=long_description,

webservice/app.yaml

@@ -1,6 +1,6 @@
 # ffd-retief-hrd fanficfare
 application: fanficfare
-version: 2-2-17
+version: 2-3-01
 runtime: python27
 api_version: 1
 threadsafe: true

webservice/index.html

@@ -35,7 +35,7 @@
 	    If you have any problems with this application, please
 	    report them in
 	    the <a href="http://groups.google.com/group/fanfic-downloader">FanFicFare Google Group</a>.  The
-	    <a href="http://2-2-16.fanficfare.appspot.com">previous version
+	    <a href="http://2-3-00.fanficfare.appspot.com">previous version
 	    </a> is also available for you to use if necessary.
 	  </p>
 	  <div id='error'>

webservice/main.py

@@ -210,18 +210,18 @@ class FileServer(webapp2.RequestHandler):
             # to hold the whole in memory just for the
             # compress/uncompress
             if download.format != 'epub':
-                def dc(data):
+                def decompress(data):
                     try:
                         return zlib.decompress(data)
                     # if error, assume it's a chunk from before we started compessing.
                     except zlib.error:
                         return data
             else:
-                def dc(data):
+                def decompress(data):
                     return data
 
             for datum in data:
-                self.response.out.write(dc(datum.blob))
+                self.response.out.write(decompress(datum.blob))
 
         except Exception, e:
             fic = DownloadMeta()
@@ -286,8 +286,8 @@ class ClearRecentServer(webapp2.RequestHandler):
             if results:
                 for d in results:
                     d.delete()
-                    for c in d.data_chunks:
-                        c.delete()
+                    for chunk in d.data_chunks:
+                        chunk.delete()
                     num = num + 1
                     logging.debug('Delete '+d.url)
             else:
@@ -494,8 +494,8 @@ class FanfictionDownloaderTask(UserConfigServer):
         # use existing record if available.
         # fileId should have record from /fdown.
         download = getDownloadMeta(id=fileId,url=url,user=user,format=format,new=True)
-        for c in download.data_chunks:
-            c.delete()
+        for chunk in download.data_chunks:
+            chunk.delete()
         download.put()
 
         logging.info('Creating adapter...')
@@ -542,21 +542,22 @@ class FanfictionDownloaderTask(UserConfigServer):
             # compressed individually to avoid having to hold the
             # whole in memory just for the compress/uncompress.
             if format != 'epub':
-                def c(data):
+                def compress(data):
                     return zlib.compress(data)
             else:
-                def c(data):
+                def compress(data):
                     return data
 
             # delete existing chunks first
-            for c in download.data_chunks:
-                c.delete()
+            for chunk in download.data_chunks:
+                chunk.delete()
                 
             index=0
             while( len(data) > 0 ):
+                # logging.info("len(data): %s" % len(data))
                 DownloadData(download=download,
                              index=index,
-                             blob=c(data[:1000000])).put()
+                             blob=compress(data[:1000000])).put()
                 index += 1
                 data = data[1000000:]
             download.completed=True