import bs4 import calendar import ClientNetworkingDomain import ClientNetworkingJobs import collections import HydrusConstants as HC import HydrusData import HydrusExceptions import HydrusGlobals as HG import HydrusSerialisable import HydrusTags import json import os import re import threading import time import urlparse try: import html5lib HTML5LIB_IS_OK = True except ImportError: HTML5LIB_IS_OK = False try: import lxml LXML_IS_OK = True except ImportError: LXML_IS_OK = False def ConvertParseResultToPrettyString( result ): ( ( name, content_type, additional_info ), parsed_text ) = result if content_type == HC.CONTENT_TYPE_URLS: ( url_type, priority ) = additional_info if url_type == HC.URL_TYPE_DESIRED: return 'downloadable/pursuable url: ' + parsed_text elif url_type == HC.URL_TYPE_SOURCE: return 'associable/source url: ' + parsed_text elif url_type == HC.URL_TYPE_NEXT: return 'next page url: ' + parsed_text elif content_type == HC.CONTENT_TYPE_MAPPINGS: try: tag = HydrusTags.CleanTag( HydrusTags.CombineTag( additional_info, parsed_text ) ) except: tag = 'unparsable tag, will likely be discarded' return 'tag: ' + tag elif content_type == HC.CONTENT_TYPE_HASH: return additional_info + ' hash: ' + parsed_text.encode( 'hex' ) elif content_type == HC.CONTENT_TYPE_TIMESTAMP: timestamp_type = additional_info try: timestamp = int( parsed_text ) timestamp_string = HydrusData.ConvertTimestampToPrettyTime( timestamp ) except: timestamp_string = 'could not convert to integer' if timestamp_type == HC.TIMESTAMP_TYPE_SOURCE: return 'source time: ' + timestamp_string elif content_type == HC.CONTENT_TYPE_TITLE: priority = additional_info return 'watcher page title (priority ' + str( priority ) + '): ' + parsed_text elif content_type == HC.CONTENT_TYPE_VETO: return 'veto: ' + name raise NotImplementedError() def ConvertParsableContentToPrettyString( parsable_content, include_veto = False ): pretty_strings = [] content_type_to_additional_infos = HydrusData.BuildKeyToSetDict( ( ( ( content_type, name ), additional_infos ) for ( name, content_type, additional_infos ) in parsable_content ) ) data = list( content_type_to_additional_infos.items() ) data.sort() for ( ( content_type, name ), additional_infos ) in data: if content_type == HC.CONTENT_TYPE_URLS: for ( url_type, priority ) in additional_infos: if url_type == HC.URL_TYPE_DESIRED: pretty_strings.append( 'downloadable/pursuable url' ) elif url_type == HC.URL_TYPE_SOURCE: pretty_strings.append( 'associable/source url' ) elif url_type == HC.URL_TYPE_NEXT: pretty_strings.append( 'gallery next page url' ) elif content_type == HC.CONTENT_TYPE_MAPPINGS: namespaces = [ namespace for namespace in additional_infos if namespace != '' ] if '' in additional_infos: namespaces.append( 'unnamespaced' ) pretty_strings.append( 'tags: ' + ', '.join( namespaces ) ) elif content_type == HC.CONTENT_TYPE_HASH: if len( additional_infos ) == 1: ( hash_type, ) = additional_infos pretty_strings.append( 'hash: ' + hash_type ) else: hash_types = list( additional_infos ) hash_types.sort() pretty_strings.append( 'hashes: ' + ', '.join( hash_types ) ) elif content_type == HC.CONTENT_TYPE_TIMESTAMP: for timestamp_type in additional_infos: if timestamp_type == HC.TIMESTAMP_TYPE_SOURCE: pretty_strings.append( 'source time' ) elif content_type == HC.CONTENT_TYPE_TITLE: pretty_strings.append( 'watcher page title' ) elif content_type == HC.CONTENT_TYPE_VETO: if include_veto: pretty_strings.append( 'veto: ' + name ) if len( pretty_strings ) == 0: return 'nothing' else: return ', '.join( pretty_strings ) def GetChildrenContent( job_key, children, data, referral_url ): content = [] for child in children: try: if isinstance( child, ParseNodeContentLink ): child_content = child.Parse( job_key, data, referral_url ) elif isinstance( child, ContentParser ): child_content = child.Parse( {}, data ) except HydrusExceptions.VetoException: return [] content.extend( child_content ) return content def GetHashesFromParseResults( results ): hash_results = [] for ( ( name, content_type, additional_info ), parsed_text ) in results: if content_type == HC.CONTENT_TYPE_HASH: hash_results.append( ( additional_info, parsed_text ) ) return hash_results def GetHTMLTagString( tag ): all_strings = [ s for s in tag.strings if len( s ) > 0 ] if len( all_strings ) == 0: result = '' else: result = all_strings[0] return result def GetNamespacesFromParsableContent( parsable_content ): content_type_to_additional_infos = HydrusData.BuildKeyToSetDict( ( ( content_type, additional_infos ) for ( name, content_type, additional_infos ) in parsable_content ) ) namespaces = content_type_to_additional_infos[ HC.CONTENT_TYPE_MAPPINGS ] # additional_infos is a set of namespaces return namespaces def GetSoup( html ): if HTML5LIB_IS_OK: parser = 'html5lib' elif LXML_IS_OK: parser = 'lxml' else: message = 'This client does not have access to either lxml or html5lib, and so it cannot parse html. Please install one of these parsing libraries and restart the client.' raise HydrusExceptions.ParseException( message ) return bs4.BeautifulSoup( html, parser ) def GetTagsFromParseResults( results ): tag_results = [] for ( ( name, content_type, additional_info ), parsed_text ) in results: if content_type == HC.CONTENT_TYPE_MAPPINGS: tag_results.append( HydrusTags.CombineTag( additional_info, parsed_text ) ) tag_results = HydrusTags.CleanTags( tag_results ) return tag_results def GetTimestampFromParseResults( results, desired_timestamp_type ): timestamp_results = [] for ( ( name, content_type, additional_info ), parsed_text ) in results: if content_type == HC.CONTENT_TYPE_TIMESTAMP: timestamp_type = additional_info if timestamp_type == desired_timestamp_type: try: timestamp = int( parsed_text ) except: continue if timestamp_type == HC.TIMESTAMP_TYPE_SOURCE: timestamp = min( HydrusData.GetNow() - 30, timestamp ) timestamp_results.append( timestamp ) if len( timestamp_results ) == 0: return None else: return min( timestamp_results ) def GetTitleFromAllParseResults( all_parse_results ): titles = [] for results in all_parse_results: for ( ( name, content_type, additional_info ), parsed_text ) in results: if content_type == HC.CONTENT_TYPE_TITLE: priority = additional_info titles.append( ( priority, parsed_text ) ) if len( titles ) > 0: titles.sort( reverse = True ) # highest priority first ( priority, title ) = titles[0] return title else: return None def GetURLsFromParseResults( results, desired_url_types, only_get_top_priority = False ): url_results = collections.defaultdict( list ) for ( ( name, content_type, additional_info ), parsed_text ) in results: if content_type == HC.CONTENT_TYPE_URLS: ( url_type, priority ) = additional_info if url_type in desired_url_types: url_results[ priority ].append( parsed_text ) if only_get_top_priority: # ( priority, url_list ) pairs url_results = list( url_results.items() ) # ordered by descending priority url_results.sort( reverse = True ) # url_lists of descending priority if len( url_results ) > 0: ( priority, url_list ) = url_results[0] else: url_list = [] else: url_list = [] for u_l in url_results.values(): url_list.extend( u_l ) urls_seen = set() possible_dupe_urls = url_list url_list = [] for url in possible_dupe_urls: if url not in urls_seen: urls_seen.add( url ) url_list.append( url ) return url_list def MakeParsedTextPretty( parsed_text ): try: parsed_text = unicode( parsed_text ) except UnicodeDecodeError: parsed_text = repr( parsed_text ) return parsed_text def RenderJSONParseRule( parse_rule ): if parse_rule is None: s = 'get all items' elif isinstance( parse_rule, int ): index = parse_rule num = index + 1 s = 'get the ' + HydrusData.ConvertIntToPrettyOrdinalString( num ) + ' item' else: s = 'get the "' + HydrusData.ToUnicode( parse_rule ) + '" entry' return s class ParseFormula( HydrusSerialisable.SerialisableBase ): def __init__( self, string_match = None, string_converter = None ): if string_match is None: string_match = StringMatch() if string_converter is None: string_converter = StringConverter( example_string = 'parsed information' ) self._string_match = string_match self._string_converter = string_converter def _GetParsePrettySeparator( self ): return os.linesep def _ParseRawContents( self, parsing_context, data ): raise NotImplementedError() def Parse( self, parsing_context, data ): raw_texts = self._ParseRawContents( parsing_context, data ) texts = [] for raw_text in raw_texts: try: self._string_match.Test( raw_text ) text = self._string_converter.Convert( raw_text ) texts.append( text ) except HydrusExceptions.ParseException: continue return texts def ParsePretty( self, parsing_context, data ): texts = self.Parse( parsing_context, data ) pretty_texts = [ MakeParsedTextPretty( text ) for text in texts ] pretty_texts = [ '*** ' + HydrusData.ConvertIntToPrettyString( len( pretty_texts ) ) + ' RESULTS BEGIN ***' ] + pretty_texts + [ '*** RESULTS END ***' ] separator = self._GetParsePrettySeparator() result = separator.join( pretty_texts ) return result def ParsesSeparatedContent( self ): return False def ToPrettyString( self ): raise NotImplementedError() def ToPrettyMultilineString( self ): raise NotImplementedError() class ParseFormulaCompound( ParseFormula ): SERIALISABLE_TYPE = HydrusSerialisable.SERIALISABLE_TYPE_PARSE_FORMULA_COMPOUND SERIALISABLE_NAME = 'Compound Parsing Formula' SERIALISABLE_VERSION = 1 def __init__( self, formulae = None, sub_phrase = None, string_match = None, string_converter = None ): ParseFormula.__init__( self, string_match, string_converter ) if formulae is None: formulae = HydrusSerialisable.SerialisableList() formulae.append( ParseFormulaHTML() ) if sub_phrase is None: sub_phrase = '\\1' self._formulae = formulae self._sub_phrase = sub_phrase def _GetSerialisableInfo( self ): serialisable_formulae = HydrusSerialisable.SerialisableList( self._formulae ).GetSerialisableTuple() serialisable_string_match = self._string_match.GetSerialisableTuple() serialisable_string_converter = self._string_converter.GetSerialisableTuple() return ( serialisable_formulae, self._sub_phrase, serialisable_string_match, serialisable_string_converter ) def _InitialiseFromSerialisableInfo( self, serialisable_info ): ( serialisable_formulae, self._sub_phrase, serialisable_string_match, serialisable_string_converter ) = serialisable_info self._formulae = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_formulae ) self._string_match = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_string_match ) self._string_converter = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_string_converter ) def _ParseRawContents( self, parsing_context, data ): def get_stream_data( index, s ): if len( s ) == 0: return '' elif len( s ) < index: return s[-1] else: return s[ index ] streams = [] for formula in self._formulae: stream = formula.Parse( parsing_context, data ) if len( stream ) == 0: # no contents were found for one of the /1 replace components, so no valid strings can be made. return [] streams.append( stream ) num_raw_contents_to_make = max( ( len( stream ) for stream in streams ) ) raw_contents = [] for stream_index in range( num_raw_contents_to_make ): raw_content = self._sub_phrase for ( stream_num, stream ) in enumerate( streams, 1 ): # starts counting from 1 sub_component = '\\' + str( stream_num ) replace_string = get_stream_data( stream_index, stream ) raw_content = raw_content.replace( sub_component, replace_string ) raw_contents.append( raw_content ) return raw_contents def ToPrettyString( self ): return 'COMPOUND with ' + HydrusData.ConvertIntToPrettyString( len( self._formulae ) ) + ' formulae.' def ToPrettyMultilineString( self ): s = [] for formula in self._formulae: s.append( formula.ToPrettyMultilineString() ) s.append( 'and substitute into ' + self._sub_phrase ) separator = os.linesep * 2 text = '--COMPOUND--' + os.linesep * 2 + separator.join( s ) return text def ToTuple( self ): return ( self._formulae, self._sub_phrase, self._string_match, self._string_converter ) HydrusSerialisable.SERIALISABLE_TYPES_TO_OBJECT_TYPES[ HydrusSerialisable.SERIALISABLE_TYPE_PARSE_FORMULA_COMPOUND ] = ParseFormulaCompound class ParseFormulaContextVariable( ParseFormula ): SERIALISABLE_TYPE = HydrusSerialisable.SERIALISABLE_TYPE_PARSE_FORMULA_CONTEXT_VARIABLE SERIALISABLE_NAME = 'Context Variable Formula' SERIALISABLE_VERSION = 1 def __init__( self, variable_name = None, string_match = None, string_converter = None ): ParseFormula.__init__( self, string_match, string_converter ) if variable_name is None: variable_name = 'url' self._variable_name = variable_name def _GetSerialisableInfo( self ): serialisable_string_match = self._string_match.GetSerialisableTuple() serialisable_string_converter = self._string_converter.GetSerialisableTuple() return ( self._variable_name, serialisable_string_match, serialisable_string_converter ) def _InitialiseFromSerialisableInfo( self, serialisable_info ): ( self._variable_name, serialisable_string_match, serialisable_string_converter ) = serialisable_info self._string_match = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_string_match ) self._string_converter = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_string_converter ) def _ParseRawContents( self, parsing_context, data ): raw_contents = [] if self._variable_name in parsing_context: raw_contents.append( parsing_context[ self._variable_name ] ) return raw_contents def ToPrettyString( self ): return 'CONTEXT VARIABLE: ' + self._variable_name def ToPrettyMultilineString( self ): s = [] s.append( 'fetch the "' + self._variable_name + '" variable from the parsing context' ) separator = os.linesep * 2 text = '--CONTEXT VARIABLE--' + os.linesep * 2 + separator.join( s ) return text def ToTuple( self ): return ( self._variable_name, self._string_match, self._string_converter ) HydrusSerialisable.SERIALISABLE_TYPES_TO_OBJECT_TYPES[ HydrusSerialisable.SERIALISABLE_TYPE_PARSE_FORMULA_CONTEXT_VARIABLE ] = ParseFormulaContextVariable HTML_CONTENT_ATTRIBUTE = 0 HTML_CONTENT_STRING = 1 HTML_CONTENT_HTML = 2 class ParseFormulaHTML( ParseFormula ): SERIALISABLE_TYPE = HydrusSerialisable.SERIALISABLE_TYPE_PARSE_FORMULA_HTML SERIALISABLE_NAME = 'HTML Parsing Formula' SERIALISABLE_VERSION = 6 def __init__( self, tag_rules = None, content_to_fetch = None, attribute_to_fetch = None, string_match = None, string_converter = None ): ParseFormula.__init__( self, string_match, string_converter ) if tag_rules is None: tag_rules = HydrusSerialisable.SerialisableList() tag_rules.append( ParseRuleHTML() ) if content_to_fetch is None: content_to_fetch = HTML_CONTENT_ATTRIBUTE if attribute_to_fetch is None: attribute_to_fetch = 'href' self._tag_rules = HydrusSerialisable.SerialisableList( tag_rules ) self._content_to_fetch = content_to_fetch self._attribute_to_fetch = attribute_to_fetch def _FindHTMLTags( self, root ): tags = ( root, ) for tag_rule in self._tag_rules: tags = tag_rule.GetNodes( tags ) return tags def _GetParsePrettySeparator( self ): if self._content_to_fetch == HTML_CONTENT_HTML: return os.linesep * 2 else: return os.linesep def _GetRawContentFromTag( self, tag ): if self._content_to_fetch == HTML_CONTENT_ATTRIBUTE: if tag.has_attr( self._attribute_to_fetch ): unknown_attr_result = tag[ self._attribute_to_fetch ] # 'class' attr returns a list because it has multiple values under html spec, wew if isinstance( unknown_attr_result, list ): if len( unknown_attr_result ) == 0: raise HydrusExceptions.ParseException( 'Attribute ' + self._attribute_to_fetch + ' not found!' ) else: result = ' '.join( unknown_attr_result ) else: result = unknown_attr_result else: raise HydrusExceptions.ParseException( 'Attribute ' + self._attribute_to_fetch + ' not found!' ) elif self._content_to_fetch == HTML_CONTENT_STRING: result = GetHTMLTagString( tag ) elif self._content_to_fetch == HTML_CONTENT_HTML: result = unicode( tag ) if result is None or result == '': raise HydrusExceptions.ParseException( 'Empty/No results found!' ) return result def _GetRawContentsFromTags( self, tags ): raw_contents = [] for tag in tags: try: raw_content = self._GetRawContentFromTag( tag ) raw_contents.append( raw_content ) except HydrusExceptions.ParseException: continue return raw_contents def _GetSerialisableInfo( self ): serialisable_tag_rules = self._tag_rules.GetSerialisableTuple() serialisable_string_match = self._string_match.GetSerialisableTuple() serialisable_string_converter = self._string_converter.GetSerialisableTuple() return ( serialisable_tag_rules, self._content_to_fetch, self._attribute_to_fetch, serialisable_string_match, serialisable_string_converter ) def _InitialiseFromSerialisableInfo( self, serialisable_info ): ( serialisable_tag_rules, self._content_to_fetch, self._attribute_to_fetch, serialisable_string_match, serialisable_string_converter ) = serialisable_info self._tag_rules = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_tag_rules ) self._string_match = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_string_match ) self._string_converter = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_string_converter ) def _ParseRawContents( self, parsing_context, data ): try: root = HG.client_controller.parsing_cache.GetSoup( data ) except Exception as e: raise HydrusExceptions.ParseException( 'Unable to parse that HTML: ' + HydrusData.ToUnicode( e ) ) tags = self._FindHTMLTags( root ) raw_contents = self._GetRawContentsFromTags( tags ) return raw_contents def _UpdateSerialisableInfo( self, version, old_serialisable_info ): if version == 1: ( tag_rules, attribute_to_fetch ) = old_serialisable_info culling_and_adding = ( 0, 0, '', '' ) new_serialisable_info = ( tag_rules, attribute_to_fetch, culling_and_adding ) return ( 2, new_serialisable_info ) if version == 2: ( tag_rules, attribute_to_fetch, culling_and_adding ) = old_serialisable_info ( cull_front, cull_back, prepend, append ) = culling_and_adding transformations = [] if cull_front > 0: transformations.append( ( STRING_TRANSFORMATION_CLIP_TEXT_FROM_BEGINNING, cull_front ) ) elif cull_front < 0: transformations.append( ( STRING_TRANSFORMATION_REMOVE_TEXT_FROM_END, cull_front ) ) if cull_back > 0: transformations.append( ( STRING_TRANSFORMATION_CLIP_TEXT_FROM_END, cull_back ) ) elif cull_back < 0: transformations.append( ( STRING_TRANSFORMATION_REMOVE_TEXT_FROM_BEGINNING, cull_back ) ) if prepend != '': transformations.append( ( STRING_TRANSFORMATION_PREPEND_TEXT, prepend ) ) if append != '': transformations.append( ( STRING_TRANSFORMATION_APPEND_TEXT, append ) ) string_converter = StringConverter( transformations, 'parsed information' ) serialisable_string_converter = string_converter.GetSerialisableTuple() new_serialisable_info = ( tag_rules, attribute_to_fetch, serialisable_string_converter ) return ( 3, new_serialisable_info ) if version == 3: ( tag_rules, attribute_to_fetch, serialisable_string_converter ) = old_serialisable_info string_match = StringMatch() serialisable_string_match = string_match.GetSerialisableTuple() new_serialisable_info = ( tag_rules, attribute_to_fetch, serialisable_string_match, serialisable_string_converter ) return ( 4, new_serialisable_info ) if version == 4: ( tag_rules, attribute_to_fetch, serialisable_string_match, serialisable_string_converter ) = old_serialisable_info if attribute_to_fetch is None: content_to_fetch = HTML_CONTENT_STRING attribute_to_fetch = '' else: content_to_fetch = HTML_CONTENT_ATTRIBUTE new_serialisable_info = ( tag_rules, content_to_fetch, attribute_to_fetch, serialisable_string_match, serialisable_string_converter ) return ( 5, new_serialisable_info ) if version == 5: ( tag_rules, content_to_fetch, attribute_to_fetch, serialisable_string_match, serialisable_string_converter ) = old_serialisable_info new_tag_rules = HydrusSerialisable.SerialisableList() for ( name, attrs, index ) in tag_rules: tag_rule = ParseRuleHTML( rule_type = HTML_RULE_TYPE_DESCENDING, tag_name = name, tag_attributes = attrs, tag_index = index ) new_tag_rules.append( tag_rule ) serialisable_new_tag_rules = new_tag_rules.GetSerialisableTuple() new_serialisable_info = ( serialisable_new_tag_rules, content_to_fetch, attribute_to_fetch, serialisable_string_match, serialisable_string_converter ) return ( 6, new_serialisable_info ) def ParsesSeparatedContent( self ): return self._content_to_fetch == HTML_CONTENT_HTML def ToPrettyString( self ): return 'HTML with ' + HydrusData.ConvertIntToPrettyString( len( self._tag_rules ) ) + ' tag rules.' def ToPrettyMultilineString( self ): pretty_strings = [ t_r.ToString() for t_r in self._tag_rules ] if self._content_to_fetch == HTML_CONTENT_ATTRIBUTE: pretty_strings.append( 'get the ' + self._attribute_to_fetch + ' attribute of those tags' ) elif self._content_to_fetch == HTML_CONTENT_STRING: pretty_strings.append( 'get the text content of those tags' ) elif self._content_to_fetch == HTML_CONTENT_HTML: pretty_strings.append( 'get the html of those tags' ) pretty_strings.extend( self._string_converter.GetTransformationStrings() ) separator = os.linesep + 'and then ' pretty_multiline_string = '--HTML--' + os.linesep + separator.join( pretty_strings ) return pretty_multiline_string def ToTuple( self ): return ( self._tag_rules, self._content_to_fetch, self._attribute_to_fetch, self._string_match, self._string_converter ) HydrusSerialisable.SERIALISABLE_TYPES_TO_OBJECT_TYPES[ HydrusSerialisable.SERIALISABLE_TYPE_PARSE_FORMULA_HTML ] = ParseFormulaHTML HTML_RULE_TYPE_DESCENDING = 0 HTML_RULE_TYPE_ASCENDING = 1 class ParseRuleHTML( HydrusSerialisable.SerialisableBase ): SERIALISABLE_TYPE = HydrusSerialisable.SERIALISABLE_TYPE_PARSE_RULE_HTML SERIALISABLE_NAME = 'HTML Parsing Rule' SERIALISABLE_VERSION = 2 def __init__( self, rule_type = None, tag_name = None, tag_attributes = None, tag_index = None, tag_depth = None, should_test_tag_string = False, tag_string_string_match = None ): HydrusSerialisable.SerialisableBase.__init__( self ) if rule_type is None: rule_type = HTML_RULE_TYPE_DESCENDING if tag_name is None: tag_name = 'a' if rule_type == HTML_RULE_TYPE_DESCENDING: if tag_attributes is None: tag_attributes = {} elif rule_type == HTML_RULE_TYPE_ASCENDING: if tag_depth is None: tag_depth = 1 if tag_string_string_match is None: tag_string_string_match = StringMatch() self._rule_type = rule_type self._tag_name = tag_name self._tag_attributes = tag_attributes self._tag_index = tag_index self._tag_depth = tag_depth self._should_test_tag_string = should_test_tag_string self._tag_string_string_match = tag_string_string_match def _GetSerialisableInfo( self ): serialisable_tag_string_string_match = self._tag_string_string_match.GetSerialisableTuple() return ( self._rule_type, self._tag_name, self._tag_attributes, self._tag_index, self._tag_depth, self._should_test_tag_string, serialisable_tag_string_string_match ) def _InitialiseFromSerialisableInfo( self, serialisable_info ): ( self._rule_type, self._tag_name, self._tag_attributes, self._tag_index, self._tag_depth, self._should_test_tag_string, serialisable_tag_string_string_match ) = serialisable_info self._tag_string_string_match = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_tag_string_string_match ) def _UpdateSerialisableInfo( self, version, old_serialisable_info ): if version == 1: ( rule_type, tag_name, tag_attributes, tag_index, tag_depth ) = old_serialisable_info should_test_tag_string = False tag_string_string_match = StringMatch() serialisable_tag_string_string_match = tag_string_string_match.GetSerialisableTuple() new_serialisable_info = ( rule_type, tag_name, tag_attributes, tag_index, tag_depth, should_test_tag_string, serialisable_tag_string_string_match ) return ( 2, new_serialisable_info ) def GetNodes( self, nodes ): new_nodes = [] for node in nodes: if self._rule_type == HTML_RULE_TYPE_DESCENDING: kwargs = { 'attrs' : self._tag_attributes } if self._tag_name is not None: kwargs[ 'name' ] = self._tag_name found_nodes = node.find_all( **kwargs ) if self._tag_index is not None: if len( found_nodes ) < self._tag_index + 1: found_nodes = [] else: found_nodes = [ found_nodes[ self._tag_index ] ] elif self._rule_type == HTML_RULE_TYPE_ASCENDING: found_nodes = [] still_in_tree = lambda node: isinstance( node, bs4.element.Tag ) # if we go one above html, we get the BS document itself num_found = 0 potential_parent = node.parent while still_in_tree( potential_parent ): if self._tag_name is None: num_found += 1 else: if potential_parent.name == self._tag_name: num_found += 1 if num_found == self._tag_depth: found_nodes = [ potential_parent ] break potential_parent = potential_parent.parent new_nodes.extend( found_nodes ) if self._should_test_tag_string: potential_nodes = new_nodes new_nodes = [] for node in potential_nodes: s = GetHTMLTagString( node ) if self._tag_string_string_match.Matches( s ): new_nodes.append( node ) return new_nodes def ToString( self ): if self._rule_type == HTML_RULE_TYPE_DESCENDING: s = 'search descendents for' if self._tag_index is None: s += ' every' else: num = self._tag_index + 1 s += ' the ' + HydrusData.ConvertIntToPrettyOrdinalString( num ) if self._tag_name is not None: s += ' <' + self._tag_name + '>' s += ' tag' if len( self._tag_attributes ) > 0: s += ' with attributes ' + ', '.join( key + '=' + value for ( key, value ) in self._tag_attributes.items() ) elif self._rule_type == HTML_RULE_TYPE_ASCENDING: s = 'walk back up ancestors' if self._tag_name is None: s += ' ' + HydrusData.ConvertIntToPrettyString( self._tag_depth ) + ' tag levels' else: s += ' to the ' + HydrusData.ConvertIntToPrettyOrdinalString( self._tag_depth ) + ' <' + self._tag_name + '> tag' if self._should_test_tag_string: s += ' with strings that match ' + self._tag_string_string_match.ToUnicode() return s def ToTuple( self ): return ( self._rule_type, self._tag_name, self._tag_attributes, self._tag_index, self._tag_depth, self._should_test_tag_string, self._tag_string_string_match ) HydrusSerialisable.SERIALISABLE_TYPES_TO_OBJECT_TYPES[ HydrusSerialisable.SERIALISABLE_TYPE_PARSE_RULE_HTML ] = ParseRuleHTML JSON_CONTENT_STRING = 0 JSON_CONTENT_JSON = 1 class ParseFormulaJSON( ParseFormula ): SERIALISABLE_TYPE = HydrusSerialisable.SERIALISABLE_TYPE_PARSE_FORMULA_JSON SERIALISABLE_NAME = 'JSON Parsing Formula' SERIALISABLE_VERSION = 1 def __init__( self, parse_rules = None, content_to_fetch = None, string_match = None, string_converter = None ): ParseFormula.__init__( self, string_match, string_converter ) if parse_rules is None: parse_rules = [ 'posts' ] if content_to_fetch is None: content_to_fetch = JSON_CONTENT_STRING self._parse_rules = parse_rules self._content_to_fetch = content_to_fetch def _GetParsePrettySeparator( self ): if self._content_to_fetch == JSON_CONTENT_JSON: return os.linesep * 2 else: return os.linesep def _GetRawContentsFromJSON( self, j ): roots = ( j, ) for parse_rule in self._parse_rules: next_roots = [] for root in roots: if parse_rule is None: if not isinstance( root, list ): continue next_roots.extend( root ) elif isinstance( parse_rule, int ): if not isinstance( root, list ): continue index = parse_rule if len( root ) < index + 1: continue next_roots.append( root[ index ] ) else: if not isinstance( root, dict ): continue key = parse_rule if key not in root: continue next_roots.append( root[ key ] ) roots = next_roots raw_contents = [] for root in roots: if self._content_to_fetch == JSON_CONTENT_STRING: if isinstance( root, ( list, dict ) ): continue raw_content = HydrusData.ToUnicode( root ) elif self._content_to_fetch == JSON_CONTENT_JSON: raw_content = json.dumps( root ) raw_contents.append( raw_content ) return raw_contents def _GetSerialisableInfo( self ): serialisable_string_match = self._string_match.GetSerialisableTuple() serialisable_string_converter = self._string_converter.GetSerialisableTuple() return ( self._parse_rules, self._content_to_fetch, serialisable_string_match, serialisable_string_converter ) def _InitialiseFromSerialisableInfo( self, serialisable_info ): ( self._parse_rules, self._content_to_fetch, serialisable_string_match, serialisable_string_converter ) = serialisable_info self._string_match = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_string_match ) self._string_converter = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_string_converter ) def _ParseRawContents( self, parsing_context, data ): try: j = HG.client_controller.parsing_cache.GetJSON( data ) except Exception as e: raise HydrusExceptions.ParseException( 'Unable to parse that JSON: ' + HydrusData.ToUnicode( e ) ) raw_contents = self._GetRawContentsFromJSON( j ) return raw_contents def ParsesSeparatedContent( self ): return self._content_to_fetch == JSON_CONTENT_JSON def ToPrettyString( self ): return 'JSON with ' + HydrusData.ConvertIntToPrettyString( len( self._parse_rules ) ) + ' parse rules.' def ToPrettyMultilineString( self ): pretty_strings = [ RenderJSONParseRule( p_r ) for p_r in self._parse_rules ] if self._content_to_fetch == JSON_CONTENT_STRING: pretty_strings.append( 'get final data content, converting to strings as needed' ) elif self._content_to_fetch == JSON_CONTENT_JSON: pretty_strings.append( 'get the json beneath' ) pretty_strings.extend( self._string_converter.GetTransformationStrings() ) separator = os.linesep + 'and then ' pretty_multiline_string = '--JSON--' + os.linesep + separator.join( pretty_strings ) return pretty_multiline_string def ToTuple( self ): return ( self._parse_rules, self._content_to_fetch, self._string_match, self._string_converter ) HydrusSerialisable.SERIALISABLE_TYPES_TO_OBJECT_TYPES[ HydrusSerialisable.SERIALISABLE_TYPE_PARSE_FORMULA_JSON ] = ParseFormulaJSON class SimpleDownloaderParsingFormula( HydrusSerialisable.SerialisableBaseNamed ): SERIALISABLE_TYPE = HydrusSerialisable.SERIALISABLE_TYPE_SIMPLE_DOWNLOADER_PARSE_FORMULA SERIALISABLE_NAME = 'Simple Downloader Parsing Formula' SERIALISABLE_VERSION = 1 def __init__( self, name = None, formula = None ): if name is None: name = 'new parsing formula' if formula is None: formula = ParseFormulaHTML() HydrusSerialisable.SerialisableBaseNamed.__init__( self, name ) self._formula = formula def _GetSerialisableInfo( self ): serialisable_formula = self._formula.GetSerialisableTuple() return serialisable_formula def _InitialiseFromSerialisableInfo( self, serialisable_info ): serialisable_formula = serialisable_info self._formula = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_formula ) def GetFormula( self ): return self._formula HydrusSerialisable.SERIALISABLE_TYPES_TO_OBJECT_TYPES[ HydrusSerialisable.SERIALISABLE_TYPE_SIMPLE_DOWNLOADER_PARSE_FORMULA ] = SimpleDownloaderParsingFormula class ContentParser( HydrusSerialisable.SerialisableBase ): SERIALISABLE_TYPE = HydrusSerialisable.SERIALISABLE_TYPE_CONTENT_PARSER SERIALISABLE_NAME = 'Content Parser' SERIALISABLE_VERSION = 3 def __init__( self, name = None, content_type = None, formula = None, additional_info = None ): if name is None: name = '' if content_type is None: content_type = HC.CONTENT_TYPE_MAPPINGS if formula is None: formula = ParseFormulaHTML() if additional_info is None: if content_type == HC.CONTENT_TYPE_MAPPINGS: additional_info = '' self._name = name self._content_type = content_type self._formula = formula self._additional_info = additional_info def _GetSerialisableInfo( self ): serialisable_formula = self._formula.GetSerialisableTuple() if self._content_type == HC.CONTENT_TYPE_VETO: ( veto_if_matches_found, string_match ) = self._additional_info serialisable_additional_info = ( veto_if_matches_found, string_match.GetSerialisableTuple() ) else: serialisable_additional_info = self._additional_info return ( self._name, self._content_type, serialisable_formula, serialisable_additional_info ) def _InitialiseFromSerialisableInfo( self, serialisable_info ): ( self._name, self._content_type, serialisable_formula, serialisable_additional_info ) = serialisable_info if self._content_type == HC.CONTENT_TYPE_VETO: ( veto_if_matches_found, serialisable_string_match ) = serialisable_additional_info string_match = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_string_match ) self._additional_info = ( veto_if_matches_found, string_match ) else: self._additional_info = serialisable_additional_info if isinstance( self._additional_info, list ): self._additional_info = tuple( self._additional_info ) self._formula = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_formula ) def _UpdateSerialisableInfo( self, version, old_serialisable_info ): if version == 1: ( name, content_type, serialisable_formula, additional_info ) = old_serialisable_info if content_type == HC.CONTENT_TYPE_VETO: ( veto_if_matches_found, match_if_text_present, search_text ) = additional_info if match_if_text_present: string_match = StringMatch( match_type = STRING_MATCH_REGEX, match_value = search_text, example_string = search_text ) else: string_match = StringMatch() serialisable_string_match = string_match.GetSerialisableTuple() additional_info = ( veto_if_matches_found, serialisable_string_match ) new_serialisable_info = ( name, content_type, serialisable_formula, additional_info ) return ( 2, new_serialisable_info ) if version == 2: ( name, content_type, serialisable_formula, additional_info ) = old_serialisable_info if content_type == HC.CONTENT_TYPE_URLS: ( url_type, priority ) = additional_info if url_type == HC.URL_TYPE_FILE: url_type = HC.URL_TYPE_DESIRED elif url_type == HC.URL_TYPE_POST: url_type = HC.URL_TYPE_SOURCE else: url_type = HC.URL_TYPE_NEXT additional_info = ( url_type, priority ) new_serialisable_info = ( name, content_type, serialisable_formula, additional_info ) return ( 3, new_serialisable_info ) def GetName( self ): return self._name def GetParsableContent( self ): return { ( self._name, self._content_type, self._additional_info ) } def Parse( self, parsing_context, data ): parsed_texts = self._formula.Parse( parsing_context, data ) if self._content_type == HC.CONTENT_TYPE_URLS: if 'url' in parsing_context: base_url = parsing_context[ 'url' ] parsed_texts = [ urlparse.urljoin( base_url, parsed_text ) for parsed_text in parsed_texts ] if self._content_type == HC.CONTENT_TYPE_VETO: ( veto_if_matches_found, string_match ) = self._additional_info match_found = True in ( string_match.Matches( parsed_text ) for parsed_text in parsed_texts ) veto_if_missing = not veto_if_matches_found do_veto = ( veto_if_matches_found and match_found ) or ( veto_if_missing and not match_found ) if do_veto: raise HydrusExceptions.VetoException( self._name ) else: return [] else: content_description = ( self._name, self._content_type, self._additional_info ) return [ ( content_description, parsed_text ) for parsed_text in parsed_texts ] def ParsePretty( self, parsing_context, data ): try: parse_results = self.Parse( parsing_context, data ) results = [ ConvertParseResultToPrettyString( parse_result ) for parse_result in parse_results ] except HydrusExceptions.VetoException as e: results = [ 'veto: ' + HydrusData.ToUnicode( e ) ] result_lines = [ '*** ' + HydrusData.ConvertIntToPrettyString( len( results ) ) + ' RESULTS BEGIN ***' ] result_lines.extend( results ) result_lines.append( '*** RESULTS END ***' ) results_text = os.linesep.join( result_lines ) return results_text def SetName( self, name ): self._name = name def ToPrettyStrings( self ): return ( self._name, 'content', ConvertParsableContentToPrettyString( self.GetParsableContent(), include_veto = True ) ) def ToTuple( self ): return ( self._name, self._content_type, self._formula, self._additional_info ) HydrusSerialisable.SERIALISABLE_TYPES_TO_OBJECT_TYPES[ HydrusSerialisable.SERIALISABLE_TYPE_CONTENT_PARSER ] = ContentParser class PageParser( HydrusSerialisable.SerialisableBaseNamed ): SERIALISABLE_TYPE = HydrusSerialisable.SERIALISABLE_TYPE_PAGE_PARSER SERIALISABLE_NAME = 'Page Parser' SERIALISABLE_VERSION = 2 def __init__( self, name, parser_key = None, string_converter = None, sub_page_parsers = None, content_parsers = None, example_urls = None, example_parsing_context = None ): if parser_key is None: parser_key = HydrusData.GenerateKey() if string_converter is None: string_converter = StringConverter() if sub_page_parsers is None: sub_page_parsers = [] if content_parsers is None: content_parsers = [] if example_urls is None: example_urls = [] if example_parsing_context is None: example_parsing_context = {} example_parsing_context[ 'url' ] = 'http://example.com/posts/index.php?id=123456' HydrusSerialisable.SerialisableBaseNamed.__init__( self, name ) self._parser_key = parser_key self._string_converter = string_converter self._sub_page_parsers = sub_page_parsers self._content_parsers = content_parsers self._example_urls = example_urls self._example_parsing_context = example_parsing_context def _GetSerialisableInfo( self ): serialisable_parser_key = self._parser_key.encode( 'hex' ) serialisable_string_converter = self._string_converter.GetSerialisableTuple() serialisable_sub_page_parsers = [ ( formula.GetSerialisableTuple(), page_parser.GetSerialisableTuple() ) for ( formula, page_parser ) in self._sub_page_parsers ] serialisable_content_parsers = HydrusSerialisable.SerialisableList( self._content_parsers ).GetSerialisableTuple() return ( self._name, serialisable_parser_key, serialisable_string_converter, serialisable_sub_page_parsers, serialisable_content_parsers, self._example_urls, self._example_parsing_context ) def _InitialiseFromSerialisableInfo( self, serialisable_info ): ( self._name, serialisable_parser_key, serialisable_string_converter, serialisable_sub_page_parsers, serialisable_content_parsers, self._example_urls, self._example_parsing_context ) = serialisable_info self._parser_key = serialisable_parser_key.decode( 'hex' ) self._string_converter = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_string_converter ) self._sub_page_parsers = [ ( HydrusSerialisable.CreateFromSerialisableTuple( serialisable_formula ), HydrusSerialisable.CreateFromSerialisableTuple( serialisable_page_parser ) ) for ( serialisable_formula, serialisable_page_parser ) in serialisable_sub_page_parsers ] self._content_parsers = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_content_parsers ) def _UpdateSerialisableInfo( self, version, old_serialisable_info ): if version == 1: ( name, serialisable_parser_key, serialisable_string_converter, serialisable_sub_page_parsers, serialisable_content_parsers, example_urls ) = old_serialisable_info example_parsing_context = {} example_parsing_context[ 'url' ] = 'http://example.com/posts/index.php?id=123456' new_serialisable_info = ( name, serialisable_parser_key, serialisable_string_converter, serialisable_sub_page_parsers, serialisable_content_parsers, example_urls, example_parsing_context ) return ( 2, new_serialisable_info ) def GetContentParsers( self ): return ( self._sub_page_parsers, self._content_parsers ) def GetExampleParsingContext( self ): return self._example_parsing_context def GetExampleURLs( self ): return self._example_urls def GetNamespaces( self ): # this in future could expand to be more granular like: # 'I want the artist tags, but not the user-submitted.' # 'I want the title here, but not the title there.' # 'I want the original filename, but not the UNIX timestamp filename.' # which the parser could present with its sub-parsing element names return GetNamespacesFromParsableContent( self.GetParsableContent() ) def GetParsableContent( self ): parsable_content = set() for ( formula, page_parser ) in self._sub_page_parsers: parsable_content.update( page_parser.GetParsableContent() ) for content_parser in self._content_parsers: parsable_content.update( content_parser.GetParsableContent() ) return parsable_content def GetParserKey( self ): return self._parser_key def GetStringConverter( self ): return self._string_converter def Parse( self, parsing_context, page_data ): try: converted_page_data = self._string_converter.Convert( page_data ) except HydrusExceptions.StringConvertException as e: raise HydrusExceptions.ParseException( HydrusData.ToUnicode( e ) ) # whole_page_parse_results = [] for content_parser in self._content_parsers: whole_page_parse_results.extend( content_parser.Parse( parsing_context, converted_page_data ) ) # all_parse_results = [] if len( self._sub_page_parsers ) == 0: if len( whole_page_parse_results ) > 0: all_parse_results = [ whole_page_parse_results ] else: def sort_key( sub_page_parser ): ( formula, page_parser ) = sub_page_parser return page_parser.GetName() sub_page_parsers = list( self._sub_page_parsers ) sub_page_parsers.sort( key = sort_key ) for ( formula, page_parser ) in self._sub_page_parsers: posts = formula.Parse( parsing_context, converted_page_data ) for post in posts: try: page_parser_all_parse_results = page_parser.Parse( parsing_context, post ) except HydrusExceptions.VetoException: continue for page_parser_parse_results in page_parser_all_parse_results: page_parser_parse_results.extend( whole_page_parse_results ) all_parse_results.append( page_parser_parse_results ) return all_parse_results def ParsePretty( self, parsing_context, page_data ): try: all_parse_results = self.Parse( parsing_context, page_data ) pretty_groups_of_parse_results = [ os.linesep.join( [ ConvertParseResultToPrettyString( parse_result ) for parse_result in parse_results ] ) for parse_results in all_parse_results ] group_separator = os.linesep * 2 + '*** SEPARATE FILE RESULTS BREAK ***' + os.linesep * 2 pretty_parse_result_text = group_separator.join( pretty_groups_of_parse_results ) except HydrusExceptions.VetoException as e: all_parse_results = [ 1 ] pretty_parse_result_text = 'veto: ' + HydrusData.ToUnicode( e ) result_lines = [] result_lines.append( '*** ' + HydrusData.ConvertIntToPrettyString( len( all_parse_results ) ) + ' RESULTS BEGIN ***' + os.linesep ) result_lines.append( pretty_parse_result_text ) result_lines.append( os.linesep + '*** RESULTS END ***' ) results_text = os.linesep.join( result_lines ) return results_text def RegenerateParserKey( self ): self._parser_key = HydrusData.GenerateKey() HydrusSerialisable.SERIALISABLE_TYPES_TO_OBJECT_TYPES[ HydrusSerialisable.SERIALISABLE_TYPE_PAGE_PARSER ] = PageParser class ParseNodeContentLink( HydrusSerialisable.SerialisableBase ): SERIALISABLE_TYPE = HydrusSerialisable.SERIALISABLE_TYPE_PARSE_NODE_CONTENT_LINK SERIALISABLE_NAME = 'Content Parsing Link' SERIALISABLE_VERSION = 1 def __init__( self, name = None, formula = None, children = None ): if name is None: name = '' if formula is None: formula = ParseFormulaHTML() if children is None: children = [] self._name = name self._formula = formula self._children = children def _GetSerialisableInfo( self ): serialisable_formula = self._formula.GetSerialisableTuple() serialisable_children = [ child.GetSerialisableTuple() for child in self._children ] return ( self._name, serialisable_formula, serialisable_children ) def _InitialiseFromSerialisableInfo( self, serialisable_info ): ( self._name, serialisable_formula, serialisable_children ) = serialisable_info self._formula = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_formula ) self._children = [ HydrusSerialisable.CreateFromSerialisableTuple( serialisable_child ) for serialisable_child in serialisable_children ] def GetParsableContent( self ): children_parsable_content = set() for child in self._children: children_parsable_content.update( child.GetParsableContent() ) return children_parsable_content def Parse( self, job_key, data, referral_url ): search_urls = self.ParseURLs( job_key, data, referral_url ) content = [] for search_url in search_urls: job_key.SetVariable( 'script_status', 'fetching ' + search_url ) network_job = ClientNetworkingJobs.NetworkJob( 'GET', search_url, referral_url = referral_url ) network_job.OverrideBandwidth() HG.client_controller.network_engine.AddJob( network_job ) try: network_job.WaitUntilDone() except HydrusExceptions.CancelledException: break except HydrusExceptions.NetworkException as e: if isinstance( e, HydrusExceptions.NotFoundException ): job_key.SetVariable( 'script_status', '404 - nothing found' ) time.sleep( 2 ) continue elif isinstance( e, HydrusExceptions.NetworkException ): job_key.SetVariable( 'script_status', 'Network error! Details written to log.' ) HydrusData.Print( 'Problem fetching ' + search_url + ':' ) HydrusData.PrintException( e ) time.sleep( 2 ) continue else: raise linked_data = network_job.GetContent() children_content = GetChildrenContent( job_key, self._children, linked_data, search_url ) content.extend( children_content ) if job_key.IsCancelled(): raise HydrusExceptions.CancelledException() return content def ParseURLs( self, job_key, data, referral_url ): basic_urls = self._formula.Parse( {}, data ) absolute_urls = [ urlparse.urljoin( referral_url, basic_url ) for basic_url in basic_urls ] for url in absolute_urls: job_key.AddURL( url ) return absolute_urls def ToPrettyStrings( self ): return ( self._name, 'link', ConvertParsableContentToPrettyString( self.GetParsableContent() ) ) def ToTuple( self ): return ( self._name, self._formula, self._children ) HydrusSerialisable.SERIALISABLE_TYPES_TO_OBJECT_TYPES[ HydrusSerialisable.SERIALISABLE_TYPE_PARSE_NODE_CONTENT_LINK ] = ParseNodeContentLink FILE_IDENTIFIER_TYPE_FILE = 0 FILE_IDENTIFIER_TYPE_MD5 = 1 FILE_IDENTIFIER_TYPE_SHA1 = 2 FILE_IDENTIFIER_TYPE_SHA256 = 3 FILE_IDENTIFIER_TYPE_SHA512 = 4 FILE_IDENTIFIER_TYPE_USER_INPUT = 5 file_identifier_string_lookup = {} file_identifier_string_lookup[ FILE_IDENTIFIER_TYPE_FILE ] = 'the actual file (POST only)' file_identifier_string_lookup[ FILE_IDENTIFIER_TYPE_MD5 ] = 'md5 hash' file_identifier_string_lookup[ FILE_IDENTIFIER_TYPE_SHA1 ] = 'sha1 hash' file_identifier_string_lookup[ FILE_IDENTIFIER_TYPE_SHA256 ] = 'sha256 hash' file_identifier_string_lookup[ FILE_IDENTIFIER_TYPE_SHA512 ] = 'sha512 hash' file_identifier_string_lookup[ FILE_IDENTIFIER_TYPE_USER_INPUT ] = 'custom user input' # eventually transition this to be a flat 'generate page/gallery urls' # the rest of the parsing system can pick those up automatically # this nullifies the need for contentlink stuff, at least in its current borked form class ParseRootFileLookup( HydrusSerialisable.SerialisableBaseNamed ): SERIALISABLE_TYPE = HydrusSerialisable.SERIALISABLE_TYPE_PARSE_ROOT_FILE_LOOKUP SERIALISABLE_NAME = 'File Lookup Script' SERIALISABLE_VERSION = 2 def __init__( self, name, url = None, query_type = None, file_identifier_type = None, file_identifier_string_converter = None, file_identifier_arg_name = None, static_args = None, children = None ): HydrusSerialisable.SerialisableBaseNamed.__init__( self, name ) self._url = url self._query_type = query_type self._file_identifier_type = file_identifier_type self._file_identifier_string_converter = file_identifier_string_converter self._file_identifier_arg_name = file_identifier_arg_name self._static_args = static_args self._children = children def _GetSerialisableInfo( self ): serialisable_children = [ child.GetSerialisableTuple() for child in self._children ] serialisable_file_identifier_string_converter = self._file_identifier_string_converter.GetSerialisableTuple() return ( self._url, self._query_type, self._file_identifier_type, serialisable_file_identifier_string_converter, self._file_identifier_arg_name, self._static_args, serialisable_children ) def _InitialiseFromSerialisableInfo( self, serialisable_info ): ( self._url, self._query_type, self._file_identifier_type, serialisable_file_identifier_string_converter, self._file_identifier_arg_name, self._static_args, serialisable_children ) = serialisable_info self._children = [ HydrusSerialisable.CreateFromSerialisableTuple( serialisable_child ) for serialisable_child in serialisable_children ] self._file_identifier_string_converter = HydrusSerialisable.CreateFromSerialisableTuple( serialisable_file_identifier_string_converter ) def _UpdateSerialisableInfo( self, version, old_serialisable_info ): if version == 1: ( url, query_type, file_identifier_type, file_identifier_encoding, file_identifier_arg_name, static_args, serialisable_children ) = old_serialisable_info transformations = [] if file_identifier_encoding == HC.ENCODING_RAW: pass elif file_identifier_encoding == HC.ENCODING_HEX: transformations.append( ( STRING_TRANSFORMATION_ENCODE, 'hex' ) ) elif file_identifier_encoding == HC.ENCODING_BASE64: transformations.append( ( STRING_TRANSFORMATION_ENCODE, 'base64' ) ) file_identifier_string_converter = StringConverter( transformations, 'some hash bytes' ) serialisable_file_identifier_string_converter = file_identifier_string_converter.GetSerialisableTuple() new_serialisable_info = ( url, query_type, file_identifier_type, serialisable_file_identifier_string_converter, file_identifier_arg_name, static_args, serialisable_children ) return ( 2, new_serialisable_info ) def ConvertMediaToFileIdentifier( self, media ): if self._file_identifier_type == FILE_IDENTIFIER_TYPE_USER_INPUT: raise Exception( 'Cannot convert media to file identifier--this script takes user input!' ) elif self._file_identifier_type == FILE_IDENTIFIER_TYPE_SHA256: return media.GetHash() elif self._file_identifier_type in ( FILE_IDENTIFIER_TYPE_MD5, FILE_IDENTIFIER_TYPE_SHA1, FILE_IDENTIFIER_TYPE_SHA512 ): sha256_hash = media.GetHash() if self._file_identifier_type == FILE_IDENTIFIER_TYPE_MD5: hash_type = 'md5' elif self._file_identifier_type == FILE_IDENTIFIER_TYPE_SHA1: hash_type = 'sha1' elif self._file_identifier_type == FILE_IDENTIFIER_TYPE_SHA512: hash_type = 'sha512' try: ( other_hash, ) = HG.client_controller.Read( 'file_hashes', ( sha256_hash, ), 'sha256', hash_type ) return other_hash except: raise Exception( 'I do not know that file\'s ' + hash_type + ' hash, so I cannot look it up!' ) elif self._file_identifier_type == FILE_IDENTIFIER_TYPE_FILE: hash = media.GetHash() mime = media.GetMime() client_files_manager = HG.client_controller.client_files_manager try: path = client_files_manager.GetFilePath( hash, mime ) return path except HydrusExceptions.FileMissingException as e: raise Exception( 'That file is not in the database\'s local files, so I cannot look it up!' ) def FetchData( self, job_key, file_identifier ): # add gauge report hook and in-stream cancel support to the get/post calls request_args = dict( self._static_args ) if self._file_identifier_type != FILE_IDENTIFIER_TYPE_FILE: request_args[ self._file_identifier_arg_name ] = self._file_identifier_string_converter.Convert( file_identifier ) if self._query_type == HC.GET: if self._file_identifier_type == FILE_IDENTIFIER_TYPE_FILE: raise Exception( 'Cannot have a file as an argument on a GET query!' ) full_request_url = ClientNetworkingDomain.CombineGETURLWithParameters( self._url, request_args ) job_key.SetVariable( 'script_status', 'fetching ' + full_request_url ) job_key.AddURL( full_request_url ) network_job = ClientNetworkingJobs.NetworkJob( 'GET', full_request_url ) elif self._query_type == HC.POST: if self._file_identifier_type == FILE_IDENTIFIER_TYPE_FILE: job_key.SetVariable( 'script_status', 'uploading file' ) path = file_identifier files = { self._file_identifier_arg_name : open( path, 'rb' ) } else: job_key.SetVariable( 'script_status', 'uploading identifier' ) files = None network_job = ClientNetworkingJobs.NetworkJob( 'POST', self._url, body = request_args ) network_job.SetFiles( files ) # send nj to nj control on this panel here network_job.OverrideBandwidth() HG.client_controller.network_engine.AddJob( network_job ) try: network_job.WaitUntilDone() except HydrusExceptions.NotFoundException: job_key.SetVariable( 'script_status', '404 - nothing found' ) raise except HydrusExceptions.NetworkException as e: job_key.SetVariable( 'script_status', 'Network error!' ) HydrusData.ShowException( e ) raise if job_key.IsCancelled(): raise HydrusExceptions.CancelledException() data = network_job.GetContent() return data def GetParsableContent( self ): children_parsable_content = set() for child in self._children: children_parsable_content.update( child.GetParsableContent() ) return children_parsable_content def DoQuery( self, job_key, file_identifier ): try: try: data = self.FetchData( job_key, file_identifier ) except HydrusExceptions.NetworkException as e: return [] parse_results = self.Parse( job_key, data ) return parse_results except HydrusExceptions.CancelledException: job_key.SetVariable( 'script_status', 'Cancelled!' ) return [] finally: job_key.Finish() def UsesUserInput( self ): return self._file_identifier_type == FILE_IDENTIFIER_TYPE_USER_INPUT def Parse( self, job_key, data ): parse_results = GetChildrenContent( job_key, self._children, data, self._url ) if len( parse_results ) == 0: job_key.SetVariable( 'script_status', 'Did not find anything.' ) else: job_key.SetVariable( 'script_status', 'Found ' + HydrusData.ConvertIntToPrettyString( len( parse_results ) ) + ' rows.' ) return parse_results def SetChildren( self, children ): self._children = children def ToPrettyStrings( self ): return ( self._name, HC.query_type_string_lookup[ self._query_type ], 'File Lookup', ConvertParsableContentToPrettyString( self.GetParsableContent() ) ) def ToTuple( self ): return ( self._name, self._url, self._query_type, self._file_identifier_type, self._file_identifier_string_converter, self._file_identifier_arg_name, self._static_args, self._children ) HydrusSerialisable.SERIALISABLE_TYPES_TO_OBJECT_TYPES[ HydrusSerialisable.SERIALISABLE_TYPE_PARSE_ROOT_FILE_LOOKUP ] = ParseRootFileLookup STRING_TRANSFORMATION_REMOVE_TEXT_FROM_BEGINNING = 0 STRING_TRANSFORMATION_REMOVE_TEXT_FROM_END = 1 STRING_TRANSFORMATION_PREPEND_TEXT = 2 STRING_TRANSFORMATION_APPEND_TEXT = 3 STRING_TRANSFORMATION_ENCODE = 4 STRING_TRANSFORMATION_DECODE = 5 STRING_TRANSFORMATION_CLIP_TEXT_FROM_BEGINNING = 6 STRING_TRANSFORMATION_CLIP_TEXT_FROM_END = 7 STRING_TRANSFORMATION_REVERSE = 8 STRING_TRANSFORMATION_REGEX_SUB = 9 STRING_TRANSFORMATION_DATE_DECODE = 10 STRING_TRANSFORMATION_INTEGER_ADDITION = 11 transformation_type_str_lookup = {} transformation_type_str_lookup[ STRING_TRANSFORMATION_REMOVE_TEXT_FROM_BEGINNING ] = 'remove text from beginning of string' transformation_type_str_lookup[ STRING_TRANSFORMATION_REMOVE_TEXT_FROM_END ] = 'remove text from end of string' transformation_type_str_lookup[ STRING_TRANSFORMATION_PREPEND_TEXT ] = 'prepend text' transformation_type_str_lookup[ STRING_TRANSFORMATION_APPEND_TEXT ] = 'append text' transformation_type_str_lookup[ STRING_TRANSFORMATION_ENCODE ] = 'encode' transformation_type_str_lookup[ STRING_TRANSFORMATION_DECODE ] = 'decode' transformation_type_str_lookup[ STRING_TRANSFORMATION_CLIP_TEXT_FROM_BEGINNING ] = 'take the start of the string' transformation_type_str_lookup[ STRING_TRANSFORMATION_CLIP_TEXT_FROM_END ] = 'take the end of the string' transformation_type_str_lookup[ STRING_TRANSFORMATION_REVERSE ] = 'reverse text' transformation_type_str_lookup[ STRING_TRANSFORMATION_REGEX_SUB ] = 'regex substitution' transformation_type_str_lookup[ STRING_TRANSFORMATION_DATE_DECODE ] = 'date decode' transformation_type_str_lookup[ STRING_TRANSFORMATION_INTEGER_ADDITION ] = 'integer addition' class StringConverter( HydrusSerialisable.SerialisableBase ): SERIALISABLE_TYPE = HydrusSerialisable.SERIALISABLE_TYPE_STRING_CONVERTER SERIALISABLE_NAME = 'String Converter' SERIALISABLE_VERSION = 1 def __init__( self, transformations = None, example_string = None ): if transformations is None: transformations = [] if example_string is None: example_string = 'example string' HydrusSerialisable.SerialisableBase.__init__( self ) self.transformations = transformations self.example_string = example_string def _GetSerialisableInfo( self ): return ( self.transformations, self.example_string ) def _InitialiseFromSerialisableInfo( self, serialisable_info ): ( serialisable_transformations, self.example_string ) = serialisable_info self.transformations = [] try: # I initialised this bad one time and broke a dialog on subsequent loads, fugg for ( transformation_type, data ) in serialisable_transformations: if isinstance( data, list ): data = tuple( data ) # convert from list to tuple thing self.transformations.append( ( transformation_type, data ) ) except: pass def Convert( self, s, max_steps_allowed = None ): for ( i, transformation ) in enumerate( self.transformations ): try: ( transformation_type, data ) = transformation if transformation_type == STRING_TRANSFORMATION_REMOVE_TEXT_FROM_BEGINNING: num_chars = data s = s[ num_chars : ] elif transformation_type == STRING_TRANSFORMATION_REMOVE_TEXT_FROM_END: num_chars = data s = s[ : - num_chars ] elif transformation_type == STRING_TRANSFORMATION_CLIP_TEXT_FROM_BEGINNING: num_chars = data s = s[ : num_chars ] elif transformation_type == STRING_TRANSFORMATION_CLIP_TEXT_FROM_END: num_chars = data s = s[ - num_chars : ] elif transformation_type == STRING_TRANSFORMATION_PREPEND_TEXT: text = data s = text + s elif transformation_type == STRING_TRANSFORMATION_APPEND_TEXT: text = data s = s + text elif transformation_type == STRING_TRANSFORMATION_ENCODE: encode_type = data s = s.encode( encode_type ) elif transformation_type == STRING_TRANSFORMATION_DECODE: encode_type = data s = s.decode( encode_type ) elif transformation_type == STRING_TRANSFORMATION_REVERSE: s = s[::-1] elif transformation_type == STRING_TRANSFORMATION_REGEX_SUB: ( pattern, repl ) = data s = re.sub( pattern, repl, s, flags = re.UNICODE ) elif transformation_type == STRING_TRANSFORMATION_DATE_DECODE: ( phrase, timezone, timezone_offset ) = data struct_time = time.strptime( s, phrase ) if timezone == HC.TIMEZONE_GMT: # the given struct is in GMT, so calendar.timegm is appropriate here timestamp = int( calendar.timegm( struct_time ) ) elif timezone == HC.TIMEZONE_LOCAL: # the given struct is in local time, so time.mktime is correct timestamp = int( time.mktime( struct_time ) ) elif timezone == HC.TIMEZONE_OFFSET: # the given struct is in server time, which is the same as GMT minus an offset # if we are 7200 seconds ahead, the correct GMT timestamp needs to be 7200 smaller timestamp = int( calendar.timegm( struct_time ) ) - timezone_offset s = str( timestamp ) elif transformation_type == STRING_TRANSFORMATION_INTEGER_ADDITION: delta = data s = str( int( s ) + int( delta ) ) except Exception as e: raise HydrusExceptions.StringConvertException( 'ERROR: Could not apply "' + self.TransformationToUnicode( transformation ) + '" to string "' + repr( s ) + '":' + HydrusData.ToUnicode( e ) ) if max_steps_allowed is not None and i + 1 >= max_steps_allowed: return s return s def GetTransformationStrings( self ): return [ self.TransformationToUnicode( transformation ) for transformation in self.transformations ] def MakesChanges( self ): return len( self.transformations ) > 0 @staticmethod def TransformationToUnicode( transformation ): ( transformation_type, data ) = transformation if transformation_type == STRING_TRANSFORMATION_REMOVE_TEXT_FROM_BEGINNING: return 'remove the first ' + HydrusData.ConvertIntToPrettyString( data ) + ' characters' elif transformation_type == STRING_TRANSFORMATION_REMOVE_TEXT_FROM_END: return 'remove the last ' + HydrusData.ConvertIntToPrettyString( data ) + ' characters' elif transformation_type == STRING_TRANSFORMATION_CLIP_TEXT_FROM_BEGINNING: return 'take the first ' + HydrusData.ConvertIntToPrettyString( data ) + ' characters' elif transformation_type == STRING_TRANSFORMATION_CLIP_TEXT_FROM_END: return 'take the last ' + HydrusData.ConvertIntToPrettyString( data ) + ' characters' elif transformation_type == STRING_TRANSFORMATION_PREPEND_TEXT: return 'prepend with "' + data + '"' elif transformation_type == STRING_TRANSFORMATION_APPEND_TEXT: return 'append with "' + data + '"' elif transformation_type == STRING_TRANSFORMATION_ENCODE: return 'encode to ' + data elif transformation_type == STRING_TRANSFORMATION_DECODE: return 'decode from ' + data elif transformation_type == STRING_TRANSFORMATION_REVERSE: return transformation_type_str_lookup[ STRING_TRANSFORMATION_REVERSE ] elif transformation_type == STRING_TRANSFORMATION_REGEX_SUB: return 'regex substitution: ' + HydrusData.ToUnicode( data ) elif transformation_type == STRING_TRANSFORMATION_DATE_DECODE: return 'date decode: ' + repr( data ) elif transformation_type == STRING_TRANSFORMATION_INTEGER_ADDITION: return 'integer addition: add ' + HydrusData.ToUnicode( data ) else: return 'unknown transformation' HydrusSerialisable.SERIALISABLE_TYPES_TO_OBJECT_TYPES[ HydrusSerialisable.SERIALISABLE_TYPE_STRING_CONVERTER ] = StringConverter STRING_MATCH_FIXED = 0 STRING_MATCH_FLEXIBLE = 1 STRING_MATCH_REGEX = 2 STRING_MATCH_ANY = 3 ALPHA = 0 ALPHANUMERIC = 1 NUMERIC = 2 class StringMatch( HydrusSerialisable.SerialisableBase ): SERIALISABLE_TYPE = HydrusSerialisable.SERIALISABLE_TYPE_STRING_MATCH SERIALISABLE_NAME = 'String Match' SERIALISABLE_VERSION = 1 def __init__( self, match_type = STRING_MATCH_ANY, match_value = '', min_chars = None, max_chars = None, example_string = 'example string' ): HydrusSerialisable.SerialisableBase.__init__( self ) # make a gui control that accepts one of these. displays expected input on the right and colours red/green (and does isvalid) based on current input # think about replacing the veto stuff above with this. self._match_type = match_type self._match_value = match_value self._min_chars = min_chars self._max_chars = max_chars self._example_string = example_string def _GetSerialisableInfo( self ): return ( self._match_type, self._match_value, self._min_chars, self._max_chars, self._example_string ) def _InitialiseFromSerialisableInfo( self, serialisable_info ): ( self._match_type, self._match_value, self._min_chars, self._max_chars, self._example_string ) = serialisable_info def SetMaxChars( self, max_chars ): self._max_chars = max_chars def SetMinChars( self, min_chars ): self._min_chars = min_chars def Matches( self, text ): try: self.Test( text ) return True except HydrusExceptions.StringMatchException: return False def Test( self, text ): text_len = len( text ) presentation_text = '"' + text + '"' if self._min_chars is not None and text_len < self._min_chars: raise HydrusExceptions.StringMatchException( presentation_text + ' had fewer than ' + HydrusData.ConvertIntToPrettyString( self._min_chars ) + ' characters' ) if self._max_chars is not None and text_len > self._max_chars: raise HydrusExceptions.StringMatchException( presentation_text + ' had more than ' + HydrusData.ConvertIntToPrettyString( self._max_chars ) + ' characters' ) if self._match_type == STRING_MATCH_FIXED: if text != self._match_value: raise HydrusExceptions.StringMatchException( presentation_text + ' did not exactly match "' + self._match_value + '"' ) elif self._match_type in ( STRING_MATCH_FLEXIBLE, STRING_MATCH_REGEX ): if self._match_type == STRING_MATCH_FLEXIBLE: if self._match_value == ALPHA: r = '^[a-zA-Z]+$' fail_reason = ' had non-alpha characters' elif self._match_value == ALPHANUMERIC: r = '^[a-zA-Z\d]+$' fail_reason = ' had non-alphanumeric characters' elif self._match_value == NUMERIC: r = '^\d+$' fail_reason = ' had non-numeric characters' elif self._match_type == STRING_MATCH_REGEX: r = self._match_value fail_reason = ' did not match "' + r + '"' try: result = re.search( r, text, flags = re.UNICODE ) except Exception as e: raise HydrusExceptions.StringMatchException( 'That regex did not work! ' + HydrusData.ToUnicode( e ) ) if result is None: raise HydrusExceptions.StringMatchException( presentation_text + fail_reason ) elif self._match_type == STRING_MATCH_ANY: pass def ToTuple( self ): return ( self._match_type, self._match_value, self._min_chars, self._max_chars, self._example_string ) def ToUnicode( self ): result = '' if self._min_chars is None: if self._max_chars is None: result += 'any number of ' else: result += 'at most ' + HydrusData.ToUnicode( self._max_chars ) + ' ' else: if self._max_chars is None: result += 'at least ' + HydrusData.ToUnicode( self._min_chars ) + ' ' else: result += 'between ' + HydrusData.ToUnicode( self._min_chars ) + ' and ' + HydrusData.ToUnicode( self._max_chars ) + ' ' show_example = True if self._match_type == STRING_MATCH_ANY: result += 'characters' show_example = False elif self._match_type == STRING_MATCH_FIXED: result = self._match_value show_example = False elif self._match_type == STRING_MATCH_FLEXIBLE: if self._match_value == ALPHA: result += 'alphabetical characters' elif self._match_value == ALPHANUMERIC: result += 'alphanumeric characters' elif self._match_value == NUMERIC: result += 'numeric characters' elif self._match_type == STRING_MATCH_REGEX: result += 'characters, matching regex "' + self._match_value + '"' if show_example: result += ', such as "' + self._example_string + '"' return result HydrusSerialisable.SERIALISABLE_TYPES_TO_OBJECT_TYPES[ HydrusSerialisable.SERIALISABLE_TYPE_STRING_MATCH ] = StringMatch