Section 1
Introduction & New Features
Section 2
Community Directory
Section 3
Getting Started
Section 4
Sending Email, Files and Memos
Section 5
Entering a Different Room
Section 6
What to do if Someone is Bothering You
Section 7
Room Moderators
Section 8
Own Your Own Room
Section 9
Operators and Administrators
Section 10
Room Transcripts
Section 11
Connecting Servers
Section 12
Letting Users Connect to Your System
Section 13
Auditing Server Activity
Section 14
Web Page Builders
Section 15
Customizing Your Java Client
Appendix 1
IRC Commands
Appendix 2
The ChatSpace Database Layout

Appendix 2

The ChatSpace Database Layout

Database Layout

This section documents the layout of the ChatSpace database.

The database is organized into 3 groups of tables: Configuration Tables, Audit Tables and Transcript tables.

Configuration Tables

Configuration tables contain information about the rooms and members.  The following tables are used for configuration purposes:

Members

Rooms

Room Members

Memos

Each table is described in the sections that follow. Primary keys are shown in blue. Indexed fields are shown in green.  Unique keys are italicized.

Members Table

The members table contains a row for each registered member of the chat site.  Depending on the configuration of the site, these may be approved members who are able to access the site, or unapproved members who are not yet able to access the chat site.

Columns

Name	Type	Description
Id	Long Integer	Record ID
Nick	Text	Nickname of member
Pass	Text	Password of member
Name	Text	Name of member
Info	Text	Info for member
Email	Text	Email address of member
URL	Text	URL of member
Admin	Yes/No	Administrator status
Operator	Yes/No	Operator status
Creator	Text	Identification of creator
Created	Date/Time	Date and time record was written
ValidUntil	Date/Time	Date and time this member is valid until
TimeUsed	Long Integer	Time (in minutes) this member has used
TimeAllowed	Long Integer	Time (in minutes) this member is allowed to use (-1 indicates no limit)
LastAccessed	Date/Time	Date/Time last accessed
Approved	Yes/No	Member approved for access (if required)
Private	Yes/No	Keep this profile information private from all except Administrators
Online	Yes/No	Indicator as to whether the user is online or not

Rooms Table

The Rooms Table contains information for each registered room on the chat site.

Columns

Name	Type	Description
Id	Long Integer	Record ID
Name	Text	Name of Room
ServerName	Text	Name of Server
Topic	Text	Topic of room
PreviousTopic	Text	Previous topic
Greeting	Text	Greeting message
Mode	Text	Mode string (coded storage of options)
AopPass	Text	AOP-level access password
SopPass	Text	SOP-level access password
Creator	Text	Identification of creator
Created	Date/Time	Date/time created
LastModeratorAccessed	Date/Time	Date/time last accessed by a moderator
Transcripts	Yes/No	Record room transcripts
TranscriptsPublic	Yes/No	Public room transcripts
Replay	Yes/No	Room Replay
ReplayType	Long Integer	Type of replay.  Lines = 0, Minutes=1
ReplayAmt	Long Integer	Amount of lines or minutes to replay
PublishingToken	Text	Token used to publish this room
CurrentMembers	Long Integer	Current number of users in the room
Dirty	Yes/No	Record updated by external source

RoomMembers Table

The RoomMembers Table contains information about the members of each room, and the level of authority that is granted.  Not all rooms require membership.

Columns

Name	Type	Description
Id	Long Integer	Record ID
Nick	Text	Nickname of member
Room	Text	Roomname
Authority	Long Integer	3 = Member, 2 = Voiced Member, 1 = Moderator, 0 = Owner

Memos Table

The Memos Table contains all the memos that are currently assigned to members.  Once a memo is deleted, it is permanently removed from the database.

Columns

Name	Type	Description
Id	Long Integer	Record ID
ToNick	Text	Nickname of user who is recipient of this memo
FromNick	Text	Nickname of user who sent this memo
Status	Text	Status of this memo (New/Old)
Time	Date/Time	Date and time record was written
MemoText	Text	Text of memo

Audit Tables

Audit tables contain information that describes the functioning of the server with respect to “interesting events”.  Some of these events relate to access, others deal configuration changes, and still others record exceptional security information. The following tables are used for audit purposes:

EntryExitEvents

BanEvents

SecurityEvents

ServerEvents

 Each table is described in the sections that follow. Primary keys are shown in blue. Indexed fields are shown in green.  Unique keys are italicized

EntryExitEvents

The EntryExitEvents table contains a record for each signon and signoff to the chat site, as well as every room entry and exit.  These records are only produced when the site’s Security configuration specifies “Auditing”.

Columns

Name	Type	Description
Id	Long Integer	Record ID
Date	Date/Time	Date and time record was written
RecordType	Long Integer	301  = SIGNON, 302  = SIGNOFF, 303 = JOIN, 304 = PART, 305 = CHANGENICK
OriginatorNick	Text	Nickname of Originator
OriginatorHostname	Text	Hostname or IP Address of Originator
Detail	Text	Detail information

BanEvents

The BanEvents table contains a record for each room ban and unban.  It also contains records pertaining to server bans and unbans.  These records are only produced when the site’s Security configuration specifies “Auditing”.

Columns

Name	Type	Description
Id	Long Integer	Record ID
Date	Date/Time	Date and time record was written
RecordType	Long Integer	401 = KICK, 402 = BAN, 403 = UNBAN, 404 = KILL, 405 = SERVERBAN
OriginatorNick	Text	Nickname of Originator
OriginatorHostname	Text	Hostname or IP Address of Originator
Target	Text	Target
Detail	Text	Detail information

SecurityEvents

The SecurityEvents table records information pertaining to a variety of “exceptional” events including password violations, new member registration and granting of Administrator and moderator authority.  These records are only produced when the site’s Security configuration specifies “Auditing”.

Columns

Name	Type	Description
Id	Long Integer	Record ID
Date	Date/Time	Date and time record was written
RecordType	Long Integer	501 = OPER, 502 =  MODERATOR, 503 =  BADNICKPASS, 504 = BADOPERPASS, 505 = IMPERSONATESVCAGENT, 506 = MASSINVITES, 507 = SIGNOFFERROR, 508 =  NICKADD, 509  = NICKDROP, 510 =  NICKEXPIRE,  511 = GLOBALROOMLIMIT, 512  =  DIE, 513  = RESTART
OriginatorNick	Text	Nickname of Originator
OriginatorHostname	Text	Hostname or IP Address of Originator
Detail	Text	Detail information

ServerEvents

The ServerEvents table contains a record for each startup and shutdown of the chat site.  It also contains event information pertaining to server clustering.  These records are only produced when the site’s Security configuration specifies “Auditing”.

Columns

Name	Type	Description
Id	Long Integer	Record ID
Date	Date/Time	Date and time record was written
RecordType	Long Integer	601 = START, 602 = STOP, 603 = CONNECT, 604 = DISCONN, 605 = CONNBUSY, 606 = BADKEY, 607 = INVALCONFIG, 608 = ALREADY, 609 = UNKNOWN, 610 = INCOMP, 611 = INPROG, 612 = INPROG, 613 = NICKFOCAL, 614 = SERIALDUP, 615 = BADFOCAL
ServerName	Text	Name of clustered server
ServerHostname	Text	Hostname or IP Address of server
Detail	Text	Detail information

Transcript Tables

Transcript tables contain information about messages sent in rooms. The following tables are used for transcripts:

  Transcripts

 Each table is described in the sections that follow. Primary keys are shown in blue. Indexed fields are shown in green.  Unique keys are italicized.

Transcripts Table

The Transcripts Table contains information about messages sent into rooms that are configured to record transcripts.

Columns

Name	Type	Description
Id	Long Integer	Record ID
Date	Date/Time	Date and time record was written
RecordType	Long Integer	101 = Room Transcript
OriginatorNick	Text	Nickname of Originator
OriginatorHostname	Text	Hostname or IP Address of Originator
Verb	Text	Internal protocol command verb of message, either PRIVMSG or NOTICE
Room	Text	Name of room
MsgText	Text	Text of message