Spider Objective-C Reference Documentation
CkoSpider
Current Version: 11.1.0
Chilkat Spider web crawler object.
Object Creation
CkoSpider *obj = [[CkoSpider alloc] init];
Properties
AbortCurrent
When set to YES, 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 NO when the next method is called. When the abort occurs, this property is reset to NO. 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
If set the 1 (true) the spider will avoid all HTTPS URLs. The default is 0 (false).
topCacheDir
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.
ChopAtQuery
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).
topConnectTimeout
The maximum number of seconds to wait while connecting to an HTTP server.
topDebugLogFilePath
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
Domain
The domain name that is being spidered. This is the domain previously set in the Initialize method.
topFetchFromCache
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.
FinalRedirectUrl
If the last URL crawled was redirected (as indicated by the WasRedirected property), this property will contain the final redirect URL.
topHeartbeatMs
The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete. By default, HeartbeatMs is set to 0, meaning no AbortCheck event callbacks will trigger.
LastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastFromCache
Equal to 1 if the last page spidered was fetched from the cache. Otherwise equal to 0.
topLastHtml
The HTML text of the last paged fetched by the spider.
topLastHtmlDescription
The HTML META description from the last page fetched by the spider.
LastHtmlKeywords
LastHtmlTitle
LastMethodSuccess
Indicates the success or failure of the most recent method call: YES means success, NO means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.
LastModDateStr
The last modification date/time (RFC822 format) from the last page fetched by the spider.
topLastUrl
The URL of the last page spidered.
topMaxResponseSize
The maximum HTTP response size allowed. The spider will automatically fail any pages larger than this size. The default value is 250,000 bytes.
MaxUrlLen
The maximum URL length allowed. URLs longer than this are not added to the unspidered list. The default value is 200.
NumAvoidPatterns
The number of avoid patterns previously set by calling AddAvoidPattern.
topNumFailed
The number of URLs in the object's failed URL list.
topNumOutboundLinks
The number of URLs in the object's outbound links URL list.
topNumSpidered
The number of URLs in the object's already-spidered URL list.
topNumUnspidered
PreferIpv6
If YES, then use IPv6 over IPv4 when both are supported for a particular domain. The default value of this property is NO, which will choose IPv4 over IPv6.
ProxyDomain
The domain name of a proxy host if an HTTP proxy is used.
topProxyLogin
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.
topProxyPassword
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.
topProxyPort
The port number of a proxy server if an HTTP proxy is used.
topReadTimeout
The maximum number of seconds to wait when reading from an HTTP server.
topUpdateCache
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.
UserAgent
The value of the HTTP user-agent header field to be sent with HTTP requests. This can be set to any desired value, but be aware that some websites may reject requests from unknown user agents.
topVerboseLogging
If set to YES, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is NO. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
WasRedirected
Indicates whether the last URL crawled was redirected. (YES = yes, NO = no)
WindDownCount
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
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.
AddAvoidPattern
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.
AddMustMatchPattern
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.
AddUnspidered
To begin spidering you must call this method one or more times to provide starting points. It adds a single URL to the object's internal queue of URLs to be spidered.
CanonicalizeUrl
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 nil on failure
ClearFailedUrls
Clears the object's internal list of URLs that could not be downloaded.
topClearOutboundLinks
Clears the object's internal list of outbound URLs that will automatically accumulate while spidering.
topClearSpideredUrls
Clears the object's internal list of already-spidered URLs that will automatically accumulate while spidering.
topCrawlNext
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 NO. Information about the URL crawled is available in the properties LastUrl, LastFromCache, and LastModDate.
CrawlNextAsync (1)
Creates an asynchronous task to call the CrawlNext method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
FetchRobotsText
Returns the contents of the robots.txt file from the domain being crawled. This spider object 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 nil on failure
FetchRobotsTextAsync (1)
Creates an asynchronous task to call the FetchRobotsText method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
GetAvoidPattern
Returns the Nth avoid pattern previously added by calling AddAvoidPattern. Indexing begins at 0.
Returns nil on failure
GetBaseDomain
Returns the second-level + top-level domain of the domain. For example, if domain is xyz.example.com, this returns example.com. For some domains, such as xyz.example.co.uk, the top 3 levels are returned, such as example.co.uk.
Returns nil on failure
GetFailedUrl
GetOutboundLink
GetSpideredUrl
Returns the Nth URL in the already-spidered URL list. Indexing begins at 0.
Returns nil on failure
GetUnspideredUrl
GetUrlDomain
Returns the domain name part of a URL. For example, if the URL is https://www.chilkatsoft.com/test.asp, then www.chilkatsoft.com is returned.
Returns nil on failure
Initialize
Initializes the object 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.
LoadTaskCaller
RecrawlLast
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.
topRecrawlLastAsync (1)
Creates an asynchronous task to call the RecrawlLast method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
SkipUnspidered
Moves a URL from the unspidered list to the spidered list. This allows an application to skip a specific URL.
topSleepMs
Suspends the execution of the current thread until the time-out interval elapses.
topEvents
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:
CkoSpider *spider = [[CkoSpider alloc] init]; MySpiderProgress *callbackObj = [[MySpiderProgress alloc] init]; [spider setEventCallbackObject:callbackObj];
MySpiderProgress interface example:
#import "CkoSpiderProgress.h"
@interface MySpiderProgress : CkoBaseProgress {
}
- (id)init;
- (void)dealloc;
- (void)dispose;
- (void)AbortCheck:(BOOL *)abort;
- (void)PercentDone:(NSNumber *)pctDone
abort:(BOOL *)abort;
- (void)ProgressInfo:(NSString *)name
value:(NSString *)value;
- (void)TaskCompleted:(CkoTask *)task;
@endAbortCheck
Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.
PercentDone
abort:(BOOL *)abort;
This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).
The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.
To abort the operation, set the abort output argument to YES. This will cause the method to terminate and return a failure status or corresponding failure value.
ProgressInfo
value:(NSString *)value;
This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.
TaskCompleted
Called from the background thread when an asynchronous task completes.