view src/protocols/oscar/README @ 7011:4375bf2d9020

[gaim-migrate @ 7574] The user-visible changes? Gaim now shows peep's away messages in their tooltip for AIM over oscar. Things to do: -Make sure this doesn't screw up with huge buddy lists -Replace %n with your screen name, etc. in the tooltip -Leave in b, i, u tags in the tooltip -Fix the 2 8 byte memleaks in locate.c Client authors that aren't me will want to read the following pretty closely... I made some internal libfaim changes. I desire to make libfaim cleaner. I don't know if this really helps or not. Here's what I've done: Changed all the SNAC-sending functions in info.c to NOT take a conn argument. The connection is looked up from the session. I'm trying to make oscar.c less-aware of connections. Added aim_locate_finduserinfo() - Use for getting the aim_userinfo_t for the given screenname. Added aim_locate_getinfoshort() - Use this to request that the servers send you profile info, away message, caps, or a combination of the above. It's like aim_locate_getinfo() but less rate limited. Renamed aim_bos_reqlocaterights() to aim_locate_reqrights() Renamed aim_getinfo() to aim_locate_getinfo() Renamed aim_setdirectoryinfo() to aim_locate_setdirinfo() Renamed aim_0002_000b() to aim_locate_000b() Renamed aim_setuserinterests() to aim_locate_setinterests() Removed aim_userinfo_sn() Removed aim_userinfo_flags() Removed aim_userinfo_idle() Removed aim_userinfo_warnlevel() Removed aim_userinfo_createtime() Removed aim_userinfo_membersince() Removed aim_userinfo_onlinesince() Removed aim_userinfo_sessionlen() Removed aim_userinfo_hascap() Renamed info.c to locate.c Made locate.c keep a static, linked list of nodes of sn, away message, available message, user info. This list is maintained by libfaim automatically. Now clients don't have to keep track of all this stuff themselves, and users won't have to wait for away message/info retrieval if the person is in your buddy list. libfaim uses the iChat way of retrieving stuff, which is not nearly as rate limited as the old way. I actually have a feeling WinAIM uses the same SNAC now (although I didn't check), but I like pluggin iChat because it's innovative. Moved sess->emailinfo to a static variable inside email.c. Removed evilhack from oscar.c I think that's about everything... committer: Tailor Script <[e-mail]>

libfaim pre-0.90 or so
----------------------

This is libfaim, the purpose of which is to implement as much as the
AOL AIM/OSCAR protocol as possible (which should be all of it).  After
over two years of development, its still nowhere close.  

This is not a full client and never will be.  libfaim only implements
the routines to implement a client (ie, there's no user interface).  

Status
------

I would not recommend using this version of libfaim in any form yet.  It's
beta-quality and I know it leaks memory quite badly.  It seems fairly
stable, however.  YMMV, YAYOR, etc.  I suppose I should say regardless of
that warning, that several clients use it and people use those clients
on a daily basis (in particular, me).  Also, you're probably reading this 
from a CVS version, since I haven't made a release in a very long time.  
The CVS version changes fairly rapidly when I'm in the mood, so a version
you checked out an hour ago may be better or worse than a version you 
check out now.  


Building
--------

Everything in this libfaim dist should build cleanly on any UNIX(-like)
operating system.  Originally developed on Linux+glibc.  Past versions 
known to work on Linux+libc5, FreeBSD, HP/UX, Solaris, Mac OS X Server, 
Win32 using VC++ 98/6 and others.

libfaim builds as both libfaim.a and libfaim.so.  If your platform for
some reason does not support dynamic libraries (eg, you get errors when
building libfaim.so), you'll have to tweak the makefiles a bit to get
the utils/ directory to build.  

Otherwise, just do a 'make'.  I don't believe I use any specific features
GNU make, but if something fails, make sure you have it.  And bash too.


Accessories
-----------

In utils/, you'll find a few things extra:

  faimtest:   very rudimentary front-end.  no user interface, but does
              illustrate the basics of logging in and sending/recieving
              messages and buddy list notifications.  Potential front-
              end authors start here.

  aimpasswd:  utility to change an AIM password without using a full
              client.  Note that at the time of this writing, this
              didn't work quite right yet.  See the top of the code for
              latest status.

License
-------

libfaim is covered under my copyright under the terms of the Lesser GNU
Public License, as documented in the file COPYING in the top level directory.


Documentation
-------------

Unfortunatly, there is not currently any documentation on the libfaim API.
Use the source and utils/faimtest/faimtest.c as a reference when coding
front-ends.  

Mailing Lists
-------------

Thanks to Sourceforge, we have our mailing lists back. See:
http://www.sourceforge.org/mail/?group_id=920  for instructions
on subscribing to the lists:

  libfaim-devel: Discussion of libfaim and its developement.
  libfaim-aim-protocol: Discussion of the finer points of OSCAR hacking
 

Contact Info
------------

The author (Adam Fritzler), can be reached at [e-mail].

Front-end information:
  http://www.auk.cx/faim/
Protocol information:
  http://www.auk.cx/faim/protocol/