CkSpiderW Unicode C++ Reference Documentation

CkSpiderW

Chilkat Spider web crawler component.

Properties

bool get_AbortCurrent(void);
void put_AbortCurrent(bool newVal);

Introduced in version 9.5.0.58

When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

bool get_AvoidHttps(void);
void put_AvoidHttps(bool newVal);

If set the 1 (true) the spider will avoid all HTTPS URLs. The default is 0 (false).

void get_CacheDir(CkString &str);
const wchar_t *cacheDir(void);
void put_CacheDir(const wchar_t *str);

Specifies a cache directory to use for spidering. If either of the FetchFromCache or UpdateCache properties are true, this is the location of the cache to be used. Note: the Internet Explorer, Netscape, and FireFox caches are completely separate from the Chilkat Spider cache directory. You should specify a new and empty directory.

Caching Web Pages to the Filesystem

bool get_ChopAtQuery(void);
void put_ChopAtQuery(bool newVal);

If equal to 1 (true), then the query portion of all URLs are automatically removed when adding to the unspidered list. The default value is 0 (false).

int get_ConnectTimeout(void);
void put_ConnectTimeout(int newVal);

The maximum number of seconds to wait while connecting to an HTTP server.

void get_DebugLogFilePath(CkString &str);
const wchar_t *debugLogFilePath(void);
void put_DebugLogFilePath(const wchar_t *str);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

void get_Domain(CkString &str);
const wchar_t *domain(void);

The domain name that is being spidered. This is the domain previously set in the Initialize method.

bool get_FetchFromCache(void);
void put_FetchFromCache(bool newVal);

If equal to 1 (true) then pages are fetched from cache when possible. If 0, the cache is ignored. The default value is 1. Regardless, if no CacheDir is set then the cache is not used.

Caching Web Pages to the Filesystem

int get_HeartbeatMs(void);
void put_HeartbeatMs(int newVal);

The number of milliseconds between each AbortCheck event callback. The AbortCheck callback allows an application to abort any method call prior to completion. If HeartbeatMs is 0 (the default), no AbortCheck event callbacks will fire.

void get_LastErrorHtml(CkString &str);
const wchar_t *lastErrorHtml(void);

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

void get_LastErrorText(CkString &str);
const wchar_t *lastErrorText(void);

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

void get_LastErrorXml(CkString &str);
const wchar_t *lastErrorXml(void);

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

bool get_LastFromCache(void);

Equal to 1 if the last page spidered was fetched from the cache. Otherwise equal to 0.

void get_LastHtml(CkString &str);
const wchar_t *lastHtml(void);

The HTML text of the last paged fetched by the spider.

void get_LastHtmlDescription(CkString &str);
const wchar_t *lastHtmlDescription(void);

The HTML META description from the last page fetched by the spider.

Extract HTML Title, Description, Keywords

void get_LastHtmlKeywords(CkString &str);
const wchar_t *lastHtmlKeywords(void);

The HTML META keywords from the last page fetched by the spider.

Extract HTML Title, Description, Keywords

void get_LastHtmlTitle(CkString &str);
const wchar_t *lastHtmlTitle(void);

The HTML title from the last page fetched by the spider.

Extract HTML Title, Description, Keywords

bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

SYSTEMTIME & get_LastModDate(void);

This property is deprecated. It will be removed in a future version.

The last-modification date of the last URL spidered.

void get_LastModDateStr(CkString &str);
const wchar_t *lastModDateStr(void);

The last modification date/time from the last page fetched by the spider.

void get_LastUrl(CkString &str);
const wchar_t *lastUrl(void);

The URL of the last page spidered.

int get_MaxResponseSize(void);
void put_MaxResponseSize(int newVal);

The maximum HTTP response size allowed. The spider will automatically fail any pages larger than this size. The default value is 250,000 bytes.

Setting a Maximum Response Size

int get_MaxUrlLen(void);
void put_MaxUrlLen(int newVal);

The maximum URL length allowed. URLs longer than this are not added to the unspidered list. The default value is 200.

Setting a Maximum URL Length

int get_NumAvoidPatterns(void);

The number of avoid patterns previously set by calling AddAvoidPattern.

int get_NumFailed(void);

The number of URLs in the component's failed URL list.

int get_NumOutboundLinks(void);

The number of URLs in the component's outbound links URL list.

int get_NumSpidered(void);

The number of URLs in the component's already-spidered URL list.

int get_NumUnspidered(void);

The number of URLs in the component's unspidered URL list.

Getting Started Example

bool get_PreferIpv6(void);
void put_PreferIpv6(bool newVal);

If true, then use IPv6 over IPv4 when both are supported for a particular domain. The default value of this property is false, which will choose IPv4 over IPv6.

void get_ProxyDomain(CkString &str);
const wchar_t *proxyDomain(void);
void put_ProxyDomain(const wchar_t *str);

The domain name of a proxy host if an HTTP proxy is used.

void get_ProxyLogin(CkString &str);
const wchar_t *proxyLogin(void);
void put_ProxyLogin(const wchar_t *str);

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.

void get_ProxyPassword(CkString &str);
const wchar_t *proxyPassword(void);
void put_ProxyPassword(const wchar_t *str);

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.

int get_ProxyPort(void);
void put_ProxyPort(int newVal);

The port number of a proxy server if an HTTP proxy is used.

int get_ReadTimeout(void);
void put_ReadTimeout(int newVal);

The maximum number of seconds to wait when reading from an HTTP server.

bool get_UpdateCache(void);
void put_UpdateCache(bool newVal);

If equal to 1 (true) then pages saved to the cache. If 0, the cache is ignored. The default value is 1. Regardless, if no CacheDir is set then the cache is not used.

Caching Web Pages to the Filesystem

void get_UserAgent(CkString &str);
const wchar_t *userAgent(void);
void put_UserAgent(const wchar_t *str);

The value of the HTTP user-agent header field to be sent with HTTP requests. The default value is "Chilkat/1.0.0 (+http://www.chilkatsoft.com/ChilkatHttpUA.asp)"

bool get_VerboseLogging(void);
void put_VerboseLogging(bool newVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

void get_Version(CkString &str);
const wchar_t *version(void);

Version of the component/library, such as "9.4.1.42"

int get_WindDownCount(void);
void put_WindDownCount(int newVal);

The "wind-down" phase begins when this number of URLs has been spidered. When in the wind-down phase, no new URLs are added to the unspidered list. The default value is 0 which means that there is NO wind-down phase.

Methods

void AddAvoidOutboundLinkPattern(const wchar_t *pattern);

Adds a wildcarded pattern to prevent collecting matching outbound link URLs. For example, if "*google*" is added, then any outbound links containing the word "google" will be ignored. The "*" character matches zero or more of any character.

Avoiding Outbound Links Matching Patterns

void AddAvoidPattern(const wchar_t *pattern);

Adds a wildcarded pattern to prevent spidering matching URLs. For example, if "*register*" is added, then any url containing the word "register" is not spidered. The "*" character matches zero or more of any character.

Avoid URLs Matching Any of a Set of Patterns

void AddMustMatchPattern(const wchar_t *pattern);

Adds a wildcarded pattern to limit spidering to only URLs that match the pattern. For example, if "*/products/*" is added, then only URLs containing "/products/" are spidered. This is helpful for only spidering a portion of a website. The "*" character matches zero or more of any character.

Must-Match Patterns

void AddUnspidered(const wchar_t *url);

To begin spidering you must call this method one or more times to provide starting points. It adds a single URL to the component's internal queue of URLs to be spidered.

Crawling the Web

bool CanonicalizeUrl(const wchar_t *url, CkString &outStr);
const wchar_t *canonicalizeUrl(const wchar_t *url);

Canonicalizes a URL by doing the following:

  • Drops username/password if present.
  • Drops fragment if present.
  • Converts domain to lowercase.
  • Removes port 80 or 443
  • Remove default.asp, index.html, index.htm, default.html, index.htm, default.htm, index.php, index.asp, default.php, .cfm, .aspx, ,php3, .pl, .cgi, .txt, .shtml, .phtml
  • Remove www. from the domain if present.

Returns true for success, false for failure.

Canonicalize a URL

void ClearFailedUrls(void);

Clears the component's internal list of URLs that could not be downloaded.

void ClearOutboundLinks(void);

Clears the component's internal list of outbound URLs that will automatically accumulate while spidering.

void ClearSpideredUrls(void);

Clears the component's internal list of already-spidered URLs that will automatically accumulate while spidering.

bool CrawlNext(void);

Crawls the next URL in the internal list of unspidered URLs. The URL is moved from the unspidered list to the spidered list. Any new links within the same domain and not yet spidered are added to the unspidered list. (providing that they do not match "avoid" patterns, etc.) Any new outbound links are added to the outbound URL list. If successful, the HTML of the downloaded page is available in the LastHtml property. If there are no more URLs left unspidered, the method returns false. Information about the URL crawled is available in the properties LastUrl, LastFromCache, and LastModDate.

Crawling the Web

Getting Started Example

CkTaskW *CrawlNextAsync(void);

Creates an asynchronous task to call the CrawlNext method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

How to Run an Asynchronous Task

bool FetchRobotsText(CkString &outStr);
const wchar_t *fetchRobotsText(void);

Returns the contents of the robots.txt file from the domain being crawled. This spider component will not crawl URLs excluded by robots.txt. If you believe the spider is not behaving correctly, please notify us at support@chilkatsoft.com and provide information detailing a case that allows us to reproduce the problem.

Returns true for success, false for failure.

Fetch robots.txt for a Site

CkTaskW *FetchRobotsTextAsync(void);

Creates an asynchronous task to call the FetchRobotsText method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

How to Run an Asynchronous Task

bool GetAvoidPattern(int index, CkString &outStr);
const wchar_t *getAvoidPattern(int index);

Returns the Nth avoid pattern previously added by calling AddAvoidPattern. Indexing begins at 0.

Returns true for success, false for failure.

bool GetBaseDomain(const wchar_t *domain, CkString &outStr);
const wchar_t *getBaseDomain(const wchar_t *domain);

To be documented soon.

Returns true for success, false for failure.

Convert a Domain Name into a "domain base"

bool GetFailedUrl(int index, CkString &outStr);
const wchar_t *getFailedUrl(int index);

Returns the Nth URL in the failed URL list. Indexing begins at 0.

Returns true for success, false for failure.

bool GetOutboundLink(int index, CkString &outStr);
const wchar_t *getOutboundLink(int index);

Returns the Nth URL in the outbound link URL list. Indexing begins at 0.

Returns true for success, false for failure.

bool GetSpideredUrl(int index, CkString &outStr);
const wchar_t *getSpideredUrl(int index);

Returns the Nth URL in the already-spidered URL list. Indexing begins at 0.

Returns true for success, false for failure.

bool GetUnspideredUrl(int index, CkString &outStr);
const wchar_t *getUnspideredUrl(int index);

Returns the Nth URL in the unspidered URL list. Indexing begins at 0.

Returns true for success, false for failure.

bool GetUrlDomain(const wchar_t *url, CkString &outStr);
const wchar_t *getUrlDomain(const wchar_t *url);

Returns the domain name part of a URL. For example, if the URL is "http://www.chilkatsoft.com/test.asp", then "www.chilkatsoft.com" is returned.

Returns true for success, false for failure.

void Initialize(const wchar_t *domain);

Initializes the component to begin spidering a domain. Calling Initialize clears any patterns added via the AddAvoidOutboundLinkPattern, AddAvoidPattern, and AddMustMatchPattern methods. The domain name passed to this method is what is returned by the Domain property. The spider only crawls URLs within the same domain.

Crawling the Web

Getting Started Example

bool RecrawlLast(void);

Re-crawls the last URL spidered. This helpful when cookies set in a previous page load cause the page to be loaded differently the next time.

CkTaskW *RecrawlLastAsync(void);

Creates an asynchronous task to call the RecrawlLast method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

How to Run an Asynchronous Task

bool SaveLastError(const wchar_t *path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

void SkipUnspidered(int index);

Moves a URL from the unspidered list to the spidered list. This allows an application to skip a specific URL.

void SleepMs(int numMilliseconds);

Suspends the execution of the current thread until the time-out interval elapses.

Events

void AbortCheck(bool *abort);

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

void ProgressInfo(const wchar_t *name, const wchar_t *value);

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

void TaskCompleted(CkTaskW &task);

Called in the background thread when an asynchronous task completes.