CkoSpider Swift Reference Documentation

CkoSpider

Chilkat Spider web crawler component.

Properties

AbortCurrent: Bool

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.)

AvoidHttps: Bool

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

CacheDir: String

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

ChopAtQuery: Bool

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).

ConnectTimeout: Int

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

DebugLogFilePath: String

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.

Domain: String (read-only)

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

FetchFromCache: Bool

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

HeartbeatMs: Int

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.

LastErrorHtml: String (read-only)

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.

LastErrorText: String (read-only)

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.

LastErrorXml: String (read-only)

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.

LastFromCache: Bool (read-only)

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

LastHtml: String (read-only)

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

LastHtmlDescription: String (read-only)

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

Extract HTML Title, Description, Keywords

LastHtmlKeywords: String (read-only)

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

Extract HTML Title, Description, Keywords

LastHtmlTitle: String (read-only)

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

Extract HTML Title, Description, Keywords

LastMethodSuccess: Bool

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.

LastModDate: date (read-only)

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

The last-modification date of the last URL spidered.

LastModDateStr: String (read-only)

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

LastUrl: String (read-only)

The URL of the last page spidered.

MaxResponseSize: Int

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

MaxUrlLen: Int

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

NumAvoidPatterns: Int (read-only)

The number of avoid patterns previously set by calling AddAvoidPattern.

NumFailed: Int (read-only)

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

NumOutboundLinks: Int (read-only)

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

NumSpidered: Int (read-only)

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

NumUnspidered: Int (read-only)

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

Getting Started Example

PreferIpv6: Bool

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.

ProxyDomain: String

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

ProxyLogin: String

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

ProxyPassword: String

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

ProxyPort: Int

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

ReadTimeout: Int

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

UpdateCache: Bool

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

UserAgent: String

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)"

VerboseLogging: Bool

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.

Version: String (read-only)

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

WindDownCount: Int

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

AddAvoidOutboundLinkPattern(pattern: String)

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

AddAvoidPattern(pattern: String)

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

AddMustMatchPattern(pattern: String)

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

AddUnspidered(url: String)

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

CanonicalizeUrl(url: String) -> String

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

ClearFailedUrls()

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

ClearOutboundLinks()

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

ClearSpideredUrls()

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

CrawlNext() -> Bool

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

CrawlNextAsync() -> CkoTask

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.

How to Run an Asynchronous Task

FetchRobotsText() -> String

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

FetchRobotsTextAsync() -> CkoTask

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.

How to Run an Asynchronous Task

GetAvoidPattern(index: Int) -> String

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

Returns true for success, false for failure.

GetBaseDomain(domain: String) -> String

To be documented soon.

Returns true for success, false for failure.

Convert a Domain Name into a "domain base"

GetFailedUrl(index: Int) -> String

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

Returns true for success, false for failure.

GetOutboundLink(index: Int) -> String

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

Returns true for success, false for failure.

GetSpideredUrl(index: Int) -> String

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

Returns true for success, false for failure.

GetUnspideredUrl(index: Int) -> String

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

Returns true for success, false for failure.

GetUrlDomain(url: String) -> String

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.

Initialize(domain: String)

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

RecrawlLast() -> Bool

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.

RecrawlLastAsync() -> CkoTask

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.

How to Run an Asynchronous Task

SaveLastError(path: String) -> Bool

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

Returns true for success, false for failure.

SkipUnspidered(index: Int)

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

SleepMs(numMilliseconds: Int)

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

Events

To implement an event callback, your application would define and implement a class that inherits from CkoBaseProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkoBaseProgress base class.

For example:

class MySpiderProgress : CkoBaseProgress {

    override func ProgressInfo(name: String!, value: String!) {
        // application code goes here...
        print(name + ": " + value)
    }

    override func AbortCheck(abort: UnsafeMutablePointer) {
        // application code goes here...
        // To abort the operation, set this equal to true instead of false.
        abort.memory = false
    }

    override func PercentDone(pctDone: NSNumber!, abort: UnsafeMutablePointer) {
        // application code goes here...
        print(pctDone)
        // To abort the operation, set this equal to true instead of false.
        abort.memory = false
    }

    // For asynchronous method calls.
    override func TaskCompleted(task: CkoTask!) {
        // application code goes here...
    }
}

func someAppFunction() {

    // Demonstrate how to set the event callback object...
    let spider = CkoSpider()
    let mySpiderProgress = MySpiderProgress()
    
    spider.setEventCallbackObject(mySpiderProgress)

    // ...
    // ...
    // ...
}

AbortCheck(abort: Bool)

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.

ProgressInfo(name: String, value: String)

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.

TaskCompleted(task: CkoTask)

Called in the background thread when an asynchronous task completes.