EXT: AJAX Chat¶

Table of Contents¶

EXT: AJAX Chat 1

Introduction 1

What does it do? 1

Screenshots 2

Users manual 3

Commands 3

Adminstration 3

Installation and Configuration 3

Reference 4

To-Do list 6

Changelog 6

Copyright¶

Extension Key: vjchat

Copyright 2006, Vincent Tietz, <vincent.tietz@vj-media.de>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.com

Introduction¶

Users manual¶

Because this chat is based on ajax the user needs a JavaScript enabled browser.

• An user needs also to login before using the chat.
• When entering a chatroom the user receives, if available, a welcome message.
• Entering /help presents an overview of possible commands.
• One click on a name from the userlist copies the name into the textbox. Pressing RETURN sends the message, by using CTRL+RETURN one can write multiline messages.

/whois #1

/whois jim

/ban jim Stop shouting!

Installation and Configuration¶

+1 hour

page.headerData.1002 = TEXT
page.headerData.1002.value = <script language="JavaScript" type="text/javascript" src="typo3/contrib/prototype/prototype.js"></script>

name,email,company

<span class="error">{message}</span>

<div class="tx-vjchat-message-style-{stylenumber}">
<div class="tx-vjchat-{moderator|expert|user|superuser}"><span class="tx-vjchat-time">{%H:%M:%S}:&nbsp;'[#id]'</span><span class="tx-vjchat-user">{username}</span>&gt;&nbsp;<span class="tx-vjchat-entry">{message}</span>'</div></div>

<div class="tx-vjchat-hidden" id="tx-vjchat-entry-{uid}">{message}</div>

<div class="tx-vjchat-private"><div class="tx-vjchat-hidden" id="tx-vjchat-entry-{uid}">...</div></div>

<div class="tx-vjchat-commit" id="tx-vjchat-entry-commitlink-{uid}"><a class="tx-vjchat-actionlink" onClick="javascript:chat_instance.commitEntry({uid});">{commit}</a> | <a class="tx-vjchat-actionlink" onClick="javascript:chat_instance.hideEntry({uid});">{hide}</a> <span id="tx-vjchat-storelink-{uid}">| <a class="tx-vjchat-actionlink" onClick="javascript:chat_instance.storeEntry({uid});">{store}</a></span></div>

<div class="tx-vjchat-expert">{message}</div>

<div class="tx-vjchat-system">{message}</div>

<div class="tx-vjchat-moderator">{message}</div>

<div class="tx-vjchat-superuser">{message}</div>

see EXT:vjchat/pi1/class.tx_vjchat_chat.php:528

<div class=”tx-vjchat-entry”>{messages}</div>

<div class=”tx-vjchat-userlist”>
<div class="tx-vjchat-userlist-item tx-vjchat-userlist-user">
<span style="color: {usercolor};" class="tx-vjchat-userlist-username tx-vjchat-userid-{userid} tx-vjchat-message-style-{userstyle}" id="user-{userid}">{username}</span>
<span class="tx-vjchat-pm-link">{pmlink}</span>
<span class="tx-vjchat-pr-link">{prlink}</span></div>
</div>

<div id=”tx-vjchat-user-detail” class=”tx-vjchat-user-detail-{moderator|expert|user|superuser}">
<div id="tx-vjchat-user-detail-caption">{username}</div>
<div id="tx-vjchat-user-detail-body">
<p>{detail1}</p>
<p>{detail2}</p>
<p>{detailn}</p>
</div>
</div>

<div class="tx-vjchat-entry">
        <div class="tx-vjchat-message-style-0">
                <div class="tx-vjchat-user">
                        <div class="tx-vjchat-private">
                <div class="tx-vjchat-hidden" id="tx-vjchat-entry-48">
                                        <span style="display: inline;" class="tx-vjchat-time">{time}:&nbsp;</span>
                                        <span style="color: rgb(76, 76, 76);" class="tx-vjchat-user tx-vjchat-userid-12">
                                        PM from tim to tom
                                        </span>&gt;&nbsp;
                                        <span class="tx-vjchat-entry">Hello</span>
                                </div>
                        </div>
                </div>
        </div>
</div>

plugin.tx_vjchat_pi1._CSS_DEFAULT_STYLE >

plugin.tx_vjchat_pi1.cObjects.room {
        10 = TEXT
        10.value = <h2>{field:name}</h2>
        10.insertData = 1
}

plugin.tx_vjchat_pi1.views.chat.stdWrap.preCObject.3 >

Known problems¶

• The chat requires the prototype JavaScript framework from Sam Stephenson >=1.4.0. Make sure that the path in the extension manager is correct. Check whether the script is included in the header of your html source. Please make sure that the library is included only once. Otherwise there could occur errors like 'Too much recursions'.
• Prototype.js is not compatible with mootools. So the chat would not work if you load mootools.
• Many users chatting can result in high server load. You can avoid this by limiting the number of chat users and by increasing the refresh time. Btw, if you add '&tx_vjchat_pi1[debug]=timer' to the url a debug window appears containing time measurements.
• 'Real names' won't work with chat commands.
• Excessive nesting of formats (bold, underlined, http or url) in a chat message can lead to problems.

To-Do list¶

• Sound signals.
• Extend user status (away or away from keyboard), add more commands
• Show the result of /help in a separate window
• Performance optimization.
• Testing, translating.
• Make structure of chat messages customizable.
• Make emoticons customizable.
• Add something like a status bar to avoid showing system responses (to commands) in the chat window. Graphical feedback when messages are loaded and sent.
• Create a HTML-Template for customizing the chat instead of using TypoScript.
• Showing more than one chat room in tabs.
• Anonymous login (may be this should be realized by another tricky extension)
• Integration into community extensions (click on username could instantly open a chat window).

Changelog¶

07-11-19 0.3.1 Vincent Tietz

* [fix] character decoding

* [fix] Scriptaculous is really optional now

07-11-13 0.3.0 Vincent Tietz

* [add] two-state chat buttons (on/off)

* [add] some scriptaculous effects

* [add] Loading message

* [add] autofocus (but seems not to work in FF)

* [add] JS Cookie support for some features

* [add] defaultChatpopupPid, pidList

* [add] optional send button

* [add] multi customizable room list views

* [add] page reference for chat room

* [add] html snippets for userlist and userlist tooltip

* [add] tooltipOffsetXY

* [add] simple tooltip behaviour (to keep it in borders)

* [add] extended flexform for rooms view and chatroom

* [add] CDATA for all javascript blocks

* [change] made /who /whois a little bit prettier

* [change] smily 8) is now 8-) because of destroying js-functions like "showChatWindow(8)" when replacing

* [change] added full urls to all javascript room links

* [add] put javascript link actions also to onClick

* [fix] chat should work with realurl now (checking urls for '?')

* [fix] utf-8 problems

* [fix] auto-delete of private rooms

* [sponsor] Herbstzeit Seniorenportal GmbH, http://www.herbstzeit.de/

07-04-27 0.2.7 Vincent Tietz

* [fix] system messages were not shown; help button did not work; thx to Karl Nabinger for bug report

* [added] auto inclusion of contrib/prototype/prototype.js only when ext prototypejs is NOT loaded

* [added] error message when user was not found when using /msg

07-04-26 0.2.6 Vincent Tietz

* [added] the prototype framework is now included automatically since it comes with TYPO3 (typo3/contrib)

* [added] in extension manager one can configure the path to the framework

* [fix] filtering double messages (clients keep list of received ids)

07-01-29 0.2.5 Vincent Tietz

* [change] make use of eID for ajax calls; removed patched tslib_fe and t3lib_div

* [change] in template for userlist: <h1 id="tx-vjchat-user-detail- caption">username<h1> to <div id="tx-vjchat-user-detail- caption"></div>

* [change] first step towards using "real" xml like response (<returnmsg>), but main content still as CDATA

* [fix] new line in textarea in firefox

* [fix] cleanUpRoom didn't delete anything if no session has been defined

* [fix] auto checking when full did not work properly

06-11-14 0.2.4 Vincent Tietz

* [change] useShippedT3Lib_Div is now disabled by default

* [added] some more functions to shipped t3lib_div

* [fix] prototype dependency: 0.0.1

06-11-11 0.2.3 Vincent Tietz

* [added] option to use shipped tslib_fe and t3lib_div

* [change] show user info ordered by form entry

* [change] order of parameter of /makesession

* [change] actions of format buttons are now within the <img> tag with onClick

* [change] actions of links in the help command are now defined by <span

class="tx-vjchat-cmd-help-link" onclick="..."

* [correction] documentation

* [fix] PATH_thisScript on windows mashines

06-11-11 0.2.2 Vincent Tietz

* [change] beta version

* [change] documentation updated

* [fix] commit message js error

* [fix] if popup page is empty in flexform the same page will be displayed

* [fix] hide kicked users

06-10-31 0.2.1 Vincent Tietz

* [add] dependency entries (prototypejs)

06-10-30 0.2.0 Vincent Tietz

* [add] nicknames are now randomly colorized

* [add] users can select message styles (configurable via TypoScript and CSS)

* [change] appearance

* [change] CSS default styles

* [change] /help will contain links now

* [add] private rooms: /newroom

* [add] private messages: /msg

* [add] auto delete messages option

* [add] superuser group

* [change] made chat a bit more object oriented

* [change] uses now the prototype JavaScript framework from Sam Stephenson

(http://prototype.conio.net/).

06-05-12 Vincent Tietz

* added commands: /smileys and /roomlist (thanks to Udo Gerhards)

* added commands: /makeexpert, /makeuser, /cleanuproom, /cleanupall, /setstatus

* major changes in the template (added emoticons and format panels) and new default css styles; removed form tag

* formating added [b], [u], [i]

* added sorting fields to sesssions and rooms

* entries are sorted by time in BE by default

* userlist updates only if changed, tooltip user information

06-06-19 0.1.5 Vincent Tietz

* [add] dutch transalation (thx to ben van 't ende)

* [change] improved character encoding and string glues (thx to Kevin Renskers for

bug report)

06-05-19 0.1.4 Vincent Tietz

* changed field 'status' to 'invisible'

* added alias in SQL command (thx to Franz Dürr)

* added <langDisable>1</langDisable>; fixed some locallang references and update

danish translation (thx to Peter Klein)

06-05-15 Vincent Tietz

* added Danisch translation (thx to Peter Klein)

* fixed SUBSTR MySQL syntax error for MySQL lower than 4.1.1.

06-05-12 Vincent Tietz

* added commands: /smileys and /roomlist (thanks to Udo Gerhards)

* added commands: /makeexpert, /makeuser, /cleanuproom, /cleanupall, /setstatus

* major changes in the template (added emoticons and format panels) and new default

css styles; removed form tag

* formating added [b], [u], [i]

* added sorting fields to sesssions and rooms

* entries are sorted by time in BE by default

* userlist updates only if changed, tooltip user information

06-04-28 Vincent Tietz

* fix: storing messages in IE

06-04-07 Vincent Tietz

* nearly all labels now refer to locallang.php

06-04-06 Vincent Tietz

* added prefix 'tx-vjchat-' to all styles and ids

* Hidden messages can be stored in an extra view during the chat

* Room extended with fields, that define the details that should be shown in the userlist and in /who /whois

* new userlist (no selectlist anymore) with popup details about the user

* better /who and /whois

* Session is now defined by first and last entry(id) (instead of timestamp)

* in backend users can now be selected with the TYPO3-ElementBrowser

06-04-03 Vincent Tietz

* Messages will now be received depending on id instead of timestamp. This is much better, but need to be tested :)

06-03-31 Vincent Tietz

* Tried to fix the problem with more than one <form> on a page

* send only new requests if previous request returned successfull

06-03-29 Vincent Tietz

* Increasing performance by using a small version of tslib_fe.

* After sending one message immediately retrieve new messages

06-03-28 Vincent Tietz

* IMPORTANT: fixed bug if entered values in flexform

* involving serverTimeOffset in all timestamps evaluated from flexform (initChatWithMessagesBefore)

06-03-14 Vincent Tietz

* minor changes in class.tx_vjchat_pi1.php (cObj->data = $this->getRoomData)

06-03-09 Vincent Tietz

* introducing charset in HTTP-Header

* IMPORTANT: this->chatScript was hard coded - sorry for that

* fixed foreach errors in /help

06-01-19 Vincent Tietz

* /makesession available

* fixed: System message on entering chat

* formatting messages with strip_tags instead of htmlentities (for apos reason)

* pids can now be declared in the extension manager for new entries and sessions

06-01-19 Vincent Tietz

* Initial release

EXT: AJAX Chat - 17