Documentation for: webcheck.r

Usage document for the %webcheck.r

1. Using webcheck.r

1.1. Setup required

%webcheck.r requires some setup before it is useable.

Copy the library script to a local directory with the command listed below. It is listed below to keep the floating table of contents from obscuring the command.

Edit the local %webcheck.r. Change the web page you wish to check and the email address for sending results.

If you are using REBOL/View, just use the builtin editor function. For REBOL/Core, you will need to run an external editor, such as notepad.

Getting a local copy using REBOL:

 >> write %webcheck.r read http://www.rebol.org/cgi-bin/cgiwrap/rebol/download-a-script.r?script-name=webcheck.r
 

1.2. Standard REBOL network settings

There is a standard utility that holds some basic REBOL configuration information. set-net takes a block of information so that REBOL knows how to route mail and for other internet connections. The REBOL/View Viewtop main User menu allows access to these settings or you can edit the default %user.r file and change the set-net information.

 >> help set-net
 USAGE:
     SET-NET settings

 DESCRIPTION:
      Network setup.  All values after default are optional.
      Words OK for server names.
      SET-NET is a function value.

 ARGUMENTS:
      settings -- [
                        email-addr default-server pop-server
                        proxy-server proxy-port-id proxy-type
                        esmtp-user esmtp-pass
                      ] (Type: block)
 

The first two setting are for sending mail, the third is for reading mail, then there are proxy connection settings and then two settings for authenticated mail username and password.

1.3. Running %webcheck.r

After the configuration is all set up, using webcheck is simple. Just do it.

 >> do %webcheck.r
 

This will examine the web page, see if its checksum matches a previous check and, if a change is detected, mail the new page to the address specified after the send function.

This is the main reason that this script needs modification. Sending mail to luke@rebol.com is not much good to anybody.

1.4. Support file created

2. What you can learn

This script has a few learning goodies in it.

2.1. Reading web pages

First and foremost, the ease of reading a web page.
The expression page: read http://www.rebol.com places the HTML of the rebol.com home page into the variable page. You can change the site you check by changing the url!.

2.2. Checksums

REBOL comes with a builtin checksum function. Checksums are a fairly high level computer science concept that scans a piece of data and returns a single value that is (usually) the sum of all the bits squished into a smallish number.

2.3. if with any

REBOL provides a complete set of looping and control structures, common to most programming environments. REBOL extends these normal control structures with a nifty little any sequence. The native any word, evaluates a block of expressions and, working like a shortcut logical or, returns the first value that is not FALSE or NONE.

In the case of the %webcheck.r script, the following occurs:

• Test to see if %page-sum.r exists. If not, return true and exit the rest of the any block.
• If the %page-sum.r file does exist, load its value and compare it to the checksum of the scanned page.
• If the checksum values are different, any will return true.
• There are no more tests, so if the checksums are the same, any with return false

Now the if statement will test to see if any returned true or false. If it was true, (no %page-sum.r exists, or the checksums were different), the block with the print, save, and send will execute. This will save the checksum value if this is the first time that you have run %webcheck.r.

If the result of the any block was false (%page-sum.r exists and the checksums were the same), nothing else will happen. That means the page is the same and there is no sense informing anyone or saving the checksum value, since it is the same.

2.4. print with blocks

The REBOL print statement can take many different datatypes. In this case the data is in a block and all values in the block are printed after being evaluated. In REBOL for printing, this type of evaluation is termed reduce. The quoted string "page changed" evaluates to itself, a string! and now evaluates to the current date and time.

2.5. load and save

REBOL has powerful but easy to use save and load functionality. The save function produces output that REBOL knows how to load directly.
Well worth a further read at Loading scripts  and Saving scripts  as this is a very powerful feature of REBOL.

3. Some Definitions

4. Also worth a look

There is a full suite of scripts that demonstrate how easy it is to use the HTTP url! (or "the web" ) features in REBOL.

These features are one of the central design goals of the REBOL scripting environment. These sample scripts highlight the ease of using internet resources with REBOL.

5. List of tutorial scripts in the web category

6. A script you have to check out

7. More in-depth scripts

7.1. Other web related scripts

• FTP related 
• CGI related 
• Email related 
• Web related 

8. Credits

• The rebol.org Library Team
• Usage document by Brian Tiffin, Library Team Apprentice, Last updated: 20-May-2007