Class WebEngine
- java.lang.Object
-
- com.biglybt.core.metasearch.impl.EngineImpl
-
- com.biglybt.core.metasearch.impl.web.WebEngine
-
- All Implemented Interfaces:
Engine
- Direct Known Subclasses:
JSONEngine
,RegexEngine
,RSSEngine
public abstract class WebEngine extends EngineImpl
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
WebEngine.pageDetails
static interface
WebEngine.pageDetailsVerifier
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
AM_PROXY
static java.lang.String
AM_TRANSPARENT
private java.lang.String
authMethod
private static boolean
AUTOMATIC_DATE_PARSER_DEFAULT
private boolean
automaticDateParser
private java.lang.String
basePage
private static java.util.regex.Pattern
baseTagPattern
private static java.util.regex.Pattern
baseURLPattern
private DateParser
dateParser
private java.lang.String
downloadLinkCSS
private java.lang.String
fullCookies
private java.lang.String
iconUrl
private java.lang.String
local_cookies
private java.lang.String
loginPageUrl
private FieldMapping[]
mappings
private static boolean
NEEDS_AUTH_DEFAULT
private boolean
needsAuth
private java.lang.String[]
requiredCookies
private java.lang.String
rootPage
private static java.util.regex.Pattern
rootURLPattern
private static int
search_timeout_secs
private java.lang.String
searchURLFormat
private java.lang.String
timeZone
private java.lang.String
userDateFormat
-
Fields inherited from class com.biglybt.core.metasearch.impl.EngineImpl
LD_AUTO_DL_SUPPORTED, LD_COOKIES, LD_CREATED_BY_ME, LD_ETAG, LD_LAST_MODIFIED, LD_LAST_UPDATE_CHECK, LD_LINK_IS_TORRENT, LD_UPDATE_CHECK_SECS
-
Fields inherited from interface com.biglybt.core.metasearch.Engine
AUTO_DL_SUPPORTED_NO, AUTO_DL_SUPPORTED_UNKNOWN, AUTO_DL_SUPPORTED_YES, AZ_VERSION, CT_AUDIO, CT_GAME, CT_VIDEO, ENGINE_SOURCE_LOCAL, ENGINE_SOURCE_RSS, ENGINE_SOURCE_STRS, ENGINE_SOURCE_UNKNOWN, ENGINE_SOURCE_VUZE, ENGINE_TYPE_JSON, ENGINE_TYPE_PLUGIN, ENGINE_TYPE_REGEX, ENGINE_TYPE_RSS, ENGINE_TYPE_STRS, FIELD_ASSET_DATE, FIELD_CATEGORY, FIELD_CDPLINK, FIELD_COMMENTS, FIELD_CONTENT_TYPE, FIELD_DATE, FIELD_DISCARD, FIELD_DOWNLOADBTNLINK, FIELD_DRMKEY, FIELD_HASH, FIELD_IDS, FIELD_NAME, FIELD_NAMES, FIELD_PEERS, FIELD_PLAYLINK, FIELD_PRIVATE, FIELD_RANK, FIELD_SEEDS, FIELD_SIZE, FIELD_SUPERSEEDS, FIELD_TORRENTLINK, FIELD_VOTES, FIELD_VOTES_DOWN, SC_BATCH_PERIOD, SC_FORCE_FULL, SC_REMOVE_DUP_HASH, SC_SOURCE, SEL_STATE_AUTO_SELECTED, SEL_STATE_DESELECTED, SEL_STATE_FORCE_DESELECTED, SEL_STATE_MANUAL_SELECTED, SEL_STATE_STRINGS, VUZE_FILE_COMPONENT_ENGINE_KEY
-
-
Constructor Summary
Constructors Modifier Constructor Description WebEngine(MetaSearchImpl meta_search, int type, long id, long last_updated, float rank_bias, java.lang.String name, java.lang.String searchURLFormat, java.lang.String timeZone, boolean automaticDateParser, java.lang.String userDateFormat, FieldMapping[] mappings, boolean needs_auth, java.lang.String auth_method, java.lang.String login_url, java.lang.String[] required_cookies)
protected
WebEngine(MetaSearchImpl meta_search, int type, long id, long last_updated, float rank_bias, java.lang.String name, JSONObject map)
protected
WebEngine(MetaSearchImpl meta_search, java.util.Map map)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
exportToBencodedMap(java.util.Map map, boolean generic)
protected void
exportToJSONObject(JSONObject res)
protected java.lang.String
extractProperty(java.lang.Object o)
java.lang.String
getAuthMethod()
protected java.lang.String
getBasePage()
java.lang.String
getCookies()
protected DateParser
getDateParser()
java.lang.String
getDownloadLinkCSS()
java.lang.String
getIcon()
java.lang.String
getLoginPageUrl()
protected FieldMapping[]
getMappings()
java.lang.String
getNameEx()
java.lang.String
getReferer()
java.lang.String[]
getRequiredCookies()
protected java.lang.String
getRootPage()
java.lang.String
getSearchUrl()
java.lang.String
getSearchUrl(boolean raw)
java.lang.String
getString()
java.lang.String
getString(boolean full)
protected WebEngine.pageDetails
getWebPageContent(SearchParameter[] searchParameters, java.util.Map<java.lang.String,java.lang.String> searchContext, java.lang.String headers, boolean only_if_modified)
protected WebEngine.pageDetails
getWebPageContent(SearchParameter[] searchParameters, java.util.Map<java.lang.String,java.lang.String> searchContext, java.lang.String headers, boolean only_if_modified, WebEngine.pageDetailsVerifier verifier)
private WebEngine.pageDetails
getWebPageContentSupport(java.net.Proxy proxy, java.lang.String proxy_host, java.lang.String searchURL, SearchParameter[] searchParameters, java.util.Map<java.lang.String,java.lang.String> searchContext, java.lang.String headers, boolean only_if_modified)
protected void
init()
boolean
isAnonymous()
boolean
isAuthenticated()
boolean
isNeedsAuth()
boolean
isShareable()
boolean
requiresLogin()
void
setCookies(java.lang.String cookies)
protected void
setHeaders(ResourceDownloader rd, java.lang.String encoded_headers)
void
setLoginPageUrl(java.lang.String loginPageUrl)
protected void
setNeedsAuth(boolean b)
void
setRequiredCookies(java.lang.String[] requiredCookies)
void
setSearchUrl(java.lang.String str)
boolean
supportsContext(java.lang.String context_key)
boolean
supportsField(int field_id)
-
Methods inherited from class com.biglybt.core.metasearch.impl.EngineImpl
addPotentialAssociation, allocateUID, applyRankBias, checkSelectionStateRecorded, configDirty, debugLog, debugStart, delete, exportBEncodedMappings, exportJSONMappings, exportToJSONString, exportToVuzeFile, exportToVuzeFile, exportToVuzeFile, getAutoDownloadSupported, getAZVersion, getDebugFile, getId, getLastUpdateCheck, getLastUpdated, getLocalBoolean, getLocalLong, getLocalString, getMetaSearch, getName, getPreferredWeighting, getRankBias, getSelectionState, getSource, getSubscription, getType, getUID, getUpdateCheckSecs, getUpdateURL, getUserData, getVersion, importBEncodedMappings, importFromBEncodedMap, importFromJSONString, importJSONMappings, isActive, isMine, isPublic, log, log, mapResults, recordSelectionState, reset, sameLogicAs, search, searchAndMap, searchSupport, setDefaultUpdateCheckSecs, setId, setLastUpdateCheck, setLocalBoolean, setLocalLong, setLocalString, setLocalUpdateCheckSecs, setMine, setName, setPreferredDelta, setPublic, setRankBias, setSelectionState, setSource, setUID, setUpdateURL, setUserData, setVersion, vuzeFieldToID, vuzeIDToField
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.biglybt.core.metasearch.Engine
exportToBencodedMap, exportToBencodedMap
-
-
-
-
Field Detail
-
AM_TRANSPARENT
public static final java.lang.String AM_TRANSPARENT
- See Also:
- Constant Field Values
-
AM_PROXY
public static final java.lang.String AM_PROXY
- See Also:
- Constant Field Values
-
NEEDS_AUTH_DEFAULT
private static final boolean NEEDS_AUTH_DEFAULT
- See Also:
- Constant Field Values
-
AUTOMATIC_DATE_PARSER_DEFAULT
private static final boolean AUTOMATIC_DATE_PARSER_DEFAULT
- See Also:
- Constant Field Values
-
baseTagPattern
private static final java.util.regex.Pattern baseTagPattern
-
rootURLPattern
private static final java.util.regex.Pattern rootURLPattern
-
baseURLPattern
private static final java.util.regex.Pattern baseURLPattern
-
search_timeout_secs
private static int search_timeout_secs
-
searchURLFormat
private java.lang.String searchURLFormat
-
timeZone
private java.lang.String timeZone
-
automaticDateParser
private boolean automaticDateParser
-
userDateFormat
private java.lang.String userDateFormat
-
downloadLinkCSS
private java.lang.String downloadLinkCSS
-
mappings
private FieldMapping[] mappings
-
rootPage
private java.lang.String rootPage
-
basePage
private java.lang.String basePage
-
dateParser
private DateParser dateParser
-
needsAuth
private boolean needsAuth
-
authMethod
private java.lang.String authMethod
-
loginPageUrl
private java.lang.String loginPageUrl
-
iconUrl
private java.lang.String iconUrl
-
requiredCookies
private java.lang.String[] requiredCookies
-
fullCookies
private java.lang.String fullCookies
-
local_cookies
private java.lang.String local_cookies
-
-
Constructor Detail
-
WebEngine
public WebEngine(MetaSearchImpl meta_search, int type, long id, long last_updated, float rank_bias, java.lang.String name, java.lang.String searchURLFormat, java.lang.String timeZone, boolean automaticDateParser, java.lang.String userDateFormat, FieldMapping[] mappings, boolean needs_auth, java.lang.String auth_method, java.lang.String login_url, java.lang.String[] required_cookies)
-
WebEngine
protected WebEngine(MetaSearchImpl meta_search, java.util.Map map) throws java.io.IOException
- Throws:
java.io.IOException
-
WebEngine
protected WebEngine(MetaSearchImpl meta_search, int type, long id, long last_updated, float rank_bias, java.lang.String name, JSONObject map) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
exportToBencodedMap
protected void exportToBencodedMap(java.util.Map map, boolean generic) throws java.io.IOException
- Overrides:
exportToBencodedMap
in classEngineImpl
- Throws:
java.io.IOException
-
exportToJSONObject
protected void exportToJSONObject(JSONObject res) throws java.io.IOException
- Overrides:
exportToJSONObject
in classEngineImpl
- Throws:
java.io.IOException
-
init
protected void init()
-
getNameEx
public java.lang.String getNameEx()
-
getReferer
public java.lang.String getReferer()
-
supportsContext
public boolean supportsContext(java.lang.String context_key)
-
isShareable
public boolean isShareable()
-
isAnonymous
public boolean isAnonymous()
-
getWebPageContent
protected WebEngine.pageDetails getWebPageContent(SearchParameter[] searchParameters, java.util.Map<java.lang.String,java.lang.String> searchContext, java.lang.String headers, boolean only_if_modified) throws SearchException
- Throws:
SearchException
-
getWebPageContent
protected WebEngine.pageDetails getWebPageContent(SearchParameter[] searchParameters, java.util.Map<java.lang.String,java.lang.String> searchContext, java.lang.String headers, boolean only_if_modified, WebEngine.pageDetailsVerifier verifier) throws SearchException
- Throws:
SearchException
-
getWebPageContentSupport
private WebEngine.pageDetails getWebPageContentSupport(java.net.Proxy proxy, java.lang.String proxy_host, java.lang.String searchURL, SearchParameter[] searchParameters, java.util.Map<java.lang.String,java.lang.String> searchContext, java.lang.String headers, boolean only_if_modified) throws SearchException
- Throws:
SearchException
-
extractProperty
protected java.lang.String extractProperty(java.lang.Object o)
-
setHeaders
protected void setHeaders(ResourceDownloader rd, java.lang.String encoded_headers)
-
getIcon
public java.lang.String getIcon()
-
getMappings
protected FieldMapping[] getMappings()
-
supportsField
public boolean supportsField(int field_id)
-
getRootPage
protected java.lang.String getRootPage()
-
getBasePage
protected java.lang.String getBasePage()
-
getDateParser
protected DateParser getDateParser()
-
getDownloadLinkCSS
public java.lang.String getDownloadLinkCSS()
-
requiresLogin
public boolean requiresLogin()
-
setCookies
public void setCookies(java.lang.String cookies)
-
getSearchUrl
public java.lang.String getSearchUrl(boolean raw)
-
getSearchUrl
public java.lang.String getSearchUrl()
-
setSearchUrl
public void setSearchUrl(java.lang.String str)
-
getLoginPageUrl
public java.lang.String getLoginPageUrl()
-
setLoginPageUrl
public void setLoginPageUrl(java.lang.String loginPageUrl)
-
getRequiredCookies
public java.lang.String[] getRequiredCookies()
-
setRequiredCookies
public void setRequiredCookies(java.lang.String[] requiredCookies)
-
isNeedsAuth
public boolean isNeedsAuth()
-
isAuthenticated
public boolean isAuthenticated()
- Specified by:
isAuthenticated
in interfaceEngine
- Overrides:
isAuthenticated
in classEngineImpl
-
setNeedsAuth
protected void setNeedsAuth(boolean b)
-
getAuthMethod
public java.lang.String getAuthMethod()
-
getCookies
public java.lang.String getCookies()
-
getString
public java.lang.String getString()
- Specified by:
getString
in interfaceEngine
- Overrides:
getString
in classEngineImpl
-
getString
public java.lang.String getString(boolean full)
- Overrides:
getString
in classEngineImpl
-
-