Web Utilities

Format

Directive and Description

1. Encode String

CALL "*web/base64;ENCODE_STR", instring$, outstring$

For encoding strings

2. Decode String

CALL "*web/base64;DECODE_STR", instring$, outstring$

For decoding strings

3. Encode File

This format has three variations for encoding files:

CALL "*web/base64;ENCODE_FILE", infile$, outfile$
CALL "*web/base64;ENCODE_FILE", infile$, outfile$, blocksize
CALL "*web/base64;ENCODE_FILE", infile$, outfile$, blocksize, EOL$

Block size and EOL (End of Line terminator) are optional. If you include EOL, you must also include block size.

4. Decode File

CALL "*web/base64;DECODE_FILE", infile$, outfile$

For decoding files

Note 1

For Encode or Decode: File Names or Channel Numbers

Your infile$ and outfile$ values in Formats 3 and 4 can be either file names or logical file (channel) numbers. You must use strings to pass channel numbers (i.e. "24" would perform the operation on channel 24).

If you use channel numbers instead of file names, you can have a file on disk encoded to a *memory* file for later program handling. If you assign a channel number in either infile$ or outfile$, then that channel will remain open. The only channels automatically closed are the ones that the *web/base64 program opens.

Note 2

For Encode or Decode: Append to Existing File, If Any

The base64 program READs an incoming file from its beginning (FIFO). With an output file (using either file name or channel number), the Web Server creates the file if it does not exist and appends to the file if it does exist. That is, it tacks the output onto the end of an ongoing encryption/decryption.

Note 3

For Encode Only: Block Size

You can include an optional block size parameter in your arguments when you encode files (Format 3). This will not have any effect on a disk file but does let you specify how big encoded record blocks will be when data output is written to a *memory* file. Each record your program WRITEs to the file has a separate index.

The primary use for a block size limit is in e-mail where lines must be less than or equal to 98 bytes each. If you assign block size when you encode files, then the Web Server automatically segments records for you. If you omit block size, the default is 4096 bytes per block.

Note 4

For Encode Only: EOL (End of Line Terminator)

You can assign an end of line terminator by including the eol$ parameter when you encode files. Your eol$ terminator should be either $0a$ or $0d0a$. The eol$ is only used for encoding the file. If you include an eol$, it will be appended to each block. If you omit block size, then no eol$ will be appended.