changes

A Java package (library/API) to connect and use the Yahoo Instant Messager and Chat protocols (YMSG)

Unix port of Yahoo Messenger (the legit version!) so hopefully he might pass
it on.  Although I am told this is a long standing bug, so don't hold your
breath.  In the meantime, jYMSG will replicate Yahoo's buggy functionality,
so there is no way to send notifications from specific identities.  (Note: 
it's not just notifications that don't work - see my posting below...)

http://groups.yahoo.com/group/ymessenger/message/2155


6) IOExceptions from YMSG9InputStream.readPacket() handled
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[823559] Finally (!) IOExceptions from within readPacket() will bubble up 
correctly to cause SessionExceptionEvent's on input streams.  This happens 
even with the HTTPConnectionHandler, which doesn't have independent input 
and output streams.  Exceptions are captured and queued along with other 
incoming packets, and then re-thrown to give the appearence they are occuring 
on the (virtual) input stream.


7) June 2004 Yahoo auth changes implemented
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
On or around June 24th 2004 Yahoo yet again changed its login protocol, 
this time to exploit a bug in the Trillian/Gaim implementation used as
a reference by many third party Yahoo libraries, including libyahoo2
and this one.  The fix was trivial for C-based libraries, as it involved
tinkering with internal values of the SHA1 hash while it was being updated.
Unfortunately the standard SHA1 implementation shipped with Java does not 
allow access to the necessary internal variables.  Thanks to some quick 
coding by a jYMSG user though a custom SHA1 class was quickly at hand to
solve the problem.


8) HTTPConnectionHandler fixed wrt. proxyHost and proxyPort
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The constructors didn't appeared to work at advertised, ie. check the old 
pre-Java-1.3 property names for the HTTP proxy if the modern names were not 
set.  It appears they may never have worked as documented - although Java 1.2
is so old that nobody realised.  Anyway, the code has been radically cleaned
up and fixed.


9) ChatLogin now handles multiple packet logins
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Yahoo chat started (?) sending login packets, type 0x98, in multiple 
sections.  After a quick demo session I managed to deduce that the status 
header is the secret to knowing when single or multiple parts are being 
used.  I've adjusted the chat login code to cache and merge packets until 
the final 0x98 packet arrives - hopefully this should solve the problem.


10) List split across multiple packets
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[969977] The code for receivedList has been modified to allow for
multiple packets, caused by long user lists on fields suchs groups.

This has been a tricky one for me to fix, as I don't have access to an
account with hundreds of friends in the groups field.

I used the same method of detecting incomplete packets as libyahoo2:
look for the cookie field and if it ain't there, assume an incomplete
packet.  However, studying a similar problem with chat login (see above)
I noticed that the status field changed to indicate an incomplete 
message.  I'm wondering if the same thing happens for split List packets,
and if so, if this will be a better way of detecting incomplete packets.
IF ANYONE HAS AN EXAMPLE OUTPUT DUMP, PLEASE MAIL IT TO ME!!

11) Status set correctly when new conact added
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[1001334] Previously the YahooUser object was created as being on-line.
This has now been changed to be off-line, until the server delivers a
status packet for this user.



************************************************************************
*                                                                      *
* Version 0.5                                                          *
*                                                                      *
************************************************************************

The release of this package was brought forward by the sudden change in the
Yahoo AUTH scheme (see below).  A number of features I wanted to include for
this release were dropped: notably the addition of some code to support 
fancy colour-ised texts in chatrooms which someone had kindly supplied, and
a fresh look at the chat login/logout code when jumping from one room to the
next.

Changes this release include:


1) EmoteManager
   ~~~~~~~~~~~~
Loads and manages Emote text from data in the standard Yahoo 'custom Emote'
format.  Also has the standard Yahoo Chat Emotes built-in, which can be
optionally added to your bespoke Emotes.


2) sendChatEmote() added to Session
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Supports the sending of room and user Emote text.


3) isEmote() added to SessionChatEvent
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Returns whether the incoming message is an Emote or not.


4) YahooChatUser has new accessors
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
isMale(), isFemale() and hasWebcam() all added.


5) login() and chatLogin() both support timeouts
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Both these methods will now timeout with an IOException if the login process
takes too long to complete.  The default is 60 seconds.  This can be adjusted
using the "ymsg.network.loginTimeout" property, which accepts the timeout 
period in seconds.  (Set this *before* you first reference a ymsg.network 
class, as the value is cached.)  A value of zero or below (negative) disables 
the timeout.


6) Bug fixed in YahooChatCategory
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The nextTag() method failed to handle blank lines in the XML appropriately.
Now fixed.


7) Cookies sent by YahooChatCategory
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Yahoo apparently will not send back all group entries without the cookies
it uses to identify users (and thereby their age!)  A new overloaded version
of "loadCategories" has been added which accepts a Session object (which
must have been logged in first, naturally, otherwise the cookies won't be
available!)


8) January 2004 AUTH now working
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In mid-January 2004 Yahoo switched on a part of their login protocol used
to authenticate users which had previously been silent.  You''l be glad to
hear this code now logs into Yahoo under the 'new' protocol arragement 
successfully...!

The implementation used by this library is not just a carbon copy of other
libraries.  I took time to study the workings of other libraries to write an 
efficient, better structured, better documented, and mpre compact solution.  
For example, I managed to reduce the size of the 'operation lookup' table by 
nearly 25%.



************************************************************************
*                                                                      *
* Version 0.4                                                          *
*                                                                      *
************************************************************************

Support
~~~~~~~

1) MessageDecoderSettings and EmoticonLoader classes
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The decoder classes are an important part of the support API, enabling Yahoo
messages to be translated into other formats, while retaining their style
information.  These two new classes - one an actual class and the other
an interface - allow extensive control over this decoding process.

MessageDecoderSettings holds within it a list of requirements for the decoder 
engine.  Such things as whether emoticons (smiley's) should be translated to 
images, or left as text.  It is also possible to set default font and colour 
settings, as well as override styles contained within message bodies.  For 
example, using MessageDecoderSettings it is possible to specify that all 
fonts be kept within a given point size range - so they cannot become too 
small nor too big (useful for chatrooms!)

EmoticonLoader is an interface with a single method, used by the decoder
to find emoticon icons.  This allows you to provide your own smiley icons,
which the decoder will include when necessary (subject to emoticon decoding
being switched on, naturally!).  The API will cleverly substitute any missing
icons with its own default ones - meaning you do not have to provide graphics
for all 35 current smiley images.

By separating these configuration structures out from the body of the
MessageDecoder itself, it is possible not only to re-use settings across a
host of decoders, but also to alter the settings for multiple decoders in an
instant.


2) AntiSpam class
   ~~~~~~~~~~~~~~~
Again, another class which resulted as a consequence of the recent intro-
duction of chatroom support!  This class analyses messages and looks for
suspect behaviour.  Currently the only things detected are repeat messages
("Help me Obi-wan, you're my only hope", "Help me Obi-wan, you're my only 
hope", etc.) and heavy user of caps ("I AM SHOUTING!").


3) SwingModelFactory class
   ~~~~~~~~~~~~~~~~~~~~~~~
An ambitious (and minimally tested) class which takes the sting out of
creating Swing models for the Session.  It registers itself with a session 
as a listener, and acts upon the session events to update any models it
controls.

Creating models is tricky, and this class has had only basic testings.
It appears to work okay, but without a good solid test it must be assumed
to leak the occassional exception, or get mis-sync'd with the real data.
(Take a look at the source if you want to see what a nightmare it is!)


4) New chat elements supported
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~
Chatroom elements such as <red> and </red>, <#990099> and <b> </b> are now 
supported by the message decoder.



Network
~~~~~~~
  
1) chatConnectionLost(SessionEvent ev)
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A new event has been added to the SessionListener (and adapter).  This will
be fired when the user is booted from a chatroom without formally asking to 
leave - typically an auto-logout after a long period of inactivity.

2) chatUserUpdate(SessionChatEvent ev)
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For when chat user details get updated.


3) SERVICE_CHATPM supported
   ~~~~~~~~~~~~~~~~~~~~~~~~
But only on the input stream.  Packets of type 0x20 are treated as regular
messages, and delivered to messageReceived().  So far attempts to output
these packets (created by the web-based chat system when you use the 'IM'
feature) has been unsuccessful.

(I have no idea why Yahoo has this alternative PM packet - given that the
payload seems to be identical to regular 0x06 SERVICE_MESSAGE packets.
Perhaps they are hangover from some previous implementation?  Or maybe they
are used to send messages to those users only on Chat, not Pager?  Ideas
welcome...!)