Mercurial > pidgin
changeset 16394:05e2df434077
Import msimprpl 0.4.
| author | Jeffrey Connelly <jaconnel@calpoly.edu> |
|---|---|
| date | Sat, 21 Apr 2007 03:15:48 +0000 |
| parents | a7a0f0f371b4 |
| children | 39af416cfda7 |
| files | libpurple/protocols/myspace/ChangeLog libpurple/protocols/myspace/LICENSE libpurple/protocols/myspace/Makefile.am libpurple/protocols/myspace/Makefile.mingw libpurple/protocols/myspace/README libpurple/protocols/myspace/TODO libpurple/protocols/myspace/crypt-rc4.c libpurple/protocols/myspace/crypt-rc4.h libpurple/protocols/myspace/myspace.c |
| diffstat | 9 files changed, 2324 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/libpurple/protocols/myspace/ChangeLog Sat Apr 21 03:15:48 2007 +0000 @@ -0,0 +1,30 @@ +2007-04-15 Jeff Connelly <myspaceim@xyzzy.cjb.net> - 0.4 + +* Gracefully handle a full receive buffer +* Handle fatal errors + +2007-04-14 Jeff Connelly <myspaceim@xyzzy.cjb.net> - 0.3 + +* Win32 support +* Add a large number of precondition checks and a handful of assertions +* Add documentation to each function, for doxygen. + +2007-04-10 Jeff Connelly <myspaceim@xyzzy.cjb.net> - 0.2 + +* Add ability to IM by email address. +* Show usernames on buddy list instead of userids. +* Show incoming messages as coming from username, instead of userid. +* Add status messages and tooltip text. + +2007-04-09 Jeff Connelly <myspaceim@xyzzy.cjb.net> - 0.1 + +* Parsing most of the protocol. +* Logging in using RC4/SHA1-based authentication. +* Sending messages, by numeric userid or username. +* Receiving messages, currently only by numeric userid. +* Some buddy list support (show all users on buddy list as online, by uid). + +2007-04-07 Jeff Connelly <myspaceim@xyzzy.cjb.net> - 0.0 + +* Initial version. Login only. Not publicly released. +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/libpurple/protocols/myspace/LICENSE Sat Apr 21 03:15:48 2007 +0000 @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/libpurple/protocols/myspace/Makefile.am Sat Apr 21 03:15:48 2007 +0000 @@ -0,0 +1,31 @@ +EXTRA_DIST = \ + PROTOCOL \ + Makefile.mingw + +pkgdir = $(libdir)/gaim + +MSIMSOURCES = myspace.c + +AM_CFLAGS = $(st) + +libmyspace_la_LDFLAGS = -module -avoid-version + +if STATIC_MYSPACE + +st = -DGAIM_STATIC_PRPL +noinst_LIBRARIES = libmyspace.a +libmyspace_a_SOURCES = $(MSIMSOURCES) +libmyspace_a_CFLAGS = $(AM_CFLAGS) + +else + +st = +pkg_LTLIBRARIES = libmyspace.la +libmyspace_la_SOURCES = $(MSIMSOURCES) + +endif + +AM_CPPFLAGS = \ + -I$(top_srcdir)/libgaim \ + $(GLIB_CFLAGS) \ + $(DEBUG_CFLAGS)
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/libpurple/protocols/myspace/Makefile.mingw Sat Apr 21 03:15:48 2007 +0000 @@ -0,0 +1,164 @@ +## +# +# Makefile.mingw - Win32 mingw Makefile for MySpaceIM prpl +# +# based on: +# +# mockprpl +# (formerly nullprpl) +# http://snarfed.org/space/gaim+mock+protocol+plugin +# Copyright 2004-2007, Ryan Barrett <mockprpl@ryanb.org> +# +# Makefile.mingw was contributed by Andrew Hart. +# http://sourceforge.net/users/arhart/ +# +# If the gaim source is not installed in the same directory as mockprpl, change +# GAIM_TOP to point to it. +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# + +# +# PATHS +# + +INCLUDE_DIR := . +GTK_TOP := ../win32-dev/gtk_2_0 +GAIM_TOP := ../gaim-2.0.0beta6 +MSIM_ROOT := . +GAIM_INSTALL_DIR := $(GAIM_TOP)/win32-install-dir + +## +## VARIABLE DEFINITIONS +## + +TARGET = libmsim + +# Compiler Options + +CFLAGS = + +DEFINES = + +# If anyone cares to play with PLUGIN vs STATIC, feel free to change this +DLL_INSTALL_DIR = $(GAIM_INSTALL_DIR)/plugins + +## Static or Plugin... +#ifeq ($(TYPE),STATIC) +# DEFINES += -DSTATIC +# DLL_INSTALL_DIR = $(GAIM_INSTALL_DIR) +#else +#ifeq ($(TYPE),PLUGIN) +# DLL_INSTALL_DIR = $(GAIM_INSTALL_DIR)/plugins +#endif +#endif + + +## +## INCLUDE MAKEFILES +## + +include $(GAIM_TOP)/libgaim/win32/global.mak + +## +## INCLUDE PATHS +## + +INCLUDE_PATHS += -I$(MSIM_ROOT) \ + -I$(GTK_TOP)/include \ + -I$(GTK_TOP)/include/gtk-2.0 \ + -I$(GTK_TOP)/include/glib-2.0 \ + -I$(GTK_TOP)/include/pango-1.0 \ + -I$(GTK_TOP)/include/atk-1.0 \ + -I$(GTK_TOP)/lib/glib-2.0/include \ + -I$(GTK_TOP)/lib/gtk-2.0/include \ + -I$(GAIM_TOP)/libgaim \ + -I$(GAIM_TOP)/libgaim/win32 \ + -I$(GAIM_TOP) + + +LIB_PATHS = -L$(GTK_TOP)/lib \ + -L$(GAIM_TOP)/libgaim + + +## +## SOURCES, OBJECTS +## + +C_SRC = myspace.c + + +OBJECTS = $(C_SRC:%.c=%.o) + + +## +## LIBRARIES +## + +LIBS = -lgtk-win32-2.0 \ + -lglib-2.0 \ + -lgdk-win32-2.0 \ + -lgmodule-2.0 \ + -lgobject-2.0 \ + -lws2_32 \ + -lintl \ + -lgaim + + +## +## RULES +## + +# How to make a C file + +%.o: %.c + $(CC) $(CFLAGS) $(DEFINES) $(INCLUDE_PATHS) -o $@ -c $< + +## +## TARGET DEFINITIONS +## + +.PHONY: all clean + +all: $(TARGET).dll + +install: $(TARGET).dll + cp $(MSIM_ROOT)/$(TARGET).dll $(DLL_INSTALL_DIR) + + +## +## BUILD Dependencies +## + +$(GAIM_TOP)/libgaim/gaim.lib: + $(MAKE) -C $(GAIM_TOP)/libgaim -f Makefile.mingw gaim.lib + +## +## BUILD DLL +## + +$(TARGET).dll: $(GAIM_LIBGAIM_DLL).a $(OBJECTS) + $(CC) -shared $(OBJECTS) $(LIB_PATHS) $(LIBS) $(DLL_LD_FLAGS) -Wl,--out-implib,$(TARGET).lib -o $(TARGET).dll + + +## +## CLEAN RULES +## + +clean: + rm -rf *.o + rm -rf $(TARGET).dll + rm -rf $(TARGET).lib
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/libpurple/protocols/myspace/README Sat Apr 21 03:15:48 2007 +0000 @@ -0,0 +1,41 @@ +MySpaceIM Protocol Plugin 0.3 by Jeff Connelly 20070414 + +** Note: this code is being developed under Google Summer of Code. + +Greetings. This package contains a plugin for Gaim (now named Pidgin, but +the plugin does not yet take this into consideration) to connect to the new +MySpaceIM instant messaging network and send/receive messages. Functionality +is only basic as of yet, and this code should be considered beta quality. + +Currently implemented: + +- Parsing most of the protocol +- Logging in using RC4/SHA1-based authentication +- Sending messages, by numeric userid, username, or email +- Receiving messages (displays username) +- Some buddy list support (show all users on buddy list as username); not stable +- Tooltip text (shows, among other things, currently playing song) +- Win32 support + +To try it out, login to your account and send a message to yourself +(by your username or numeric uid (email not yet supported)) or tom (6221). +In either case you should get a reply. You should also be able to talk to +other MySpaceIM users if you desire. Replies will always be shown as coming +from a user's username, even if you IM by email or userid. + +There is a lot of work still to be done: +- Better buddy list support, signing on/off +- Status (online/offline/invisible, w/ message) +- Typing notifications +- Use Nathan Peterson's RC4 in cipher.c +- General clean up of code +- All the TODOs and XXX's mentioned in myspace.c +- Every other MySpaceIM feature not yet implemented + +Feedback welcome. + +Enjoy, +-Jeff Connelly +California Polytechnic State University at San Luis Obispo +myspaceim@xyzzy.cjb.net +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/libpurple/protocols/myspace/TODO Sat Apr 21 03:15:48 2007 +0000 @@ -0,0 +1,24 @@ +MySpaceIM Protocol Plugin TODO + +Listed roughly in descending order of priority. + +- Setup a site for documenting my progress. A blog for updates possibly; + definitely a wiki for the documentation. Find out best places for hosting. +[developer.pidgin.im? created a skeletal wiki page there, ok?] + +- Review 0.2 code. General clean up, refactor if necessary, find out if the + way things are done currently is the best way. Doxygen docs for each + function, and better organization of functions. +- Win32 support. Update Makefile.mingw to match Makefile, and try compiling it. + Email JS once complete to let know. +- Verify Nathan Peterson's documentation. Incorporate what he has that I don't + into mine, with credit. +- Typing notifications. +- Better buddy list support, signing on/off. +- Use Nathan Peterson's RC4 in cipher.c. Any ciphers should probably go there. +- All the TODOs and XXX's mentioned in myspace.c. +- Cosmetic: msim prpl icon. +- LEARN MONOTONE! +- Catalog all the error messages. +- Every other MySpaceIM feature not yet implemented. +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/libpurple/protocols/myspace/crypt-rc4.c Sat Apr 21 03:15:48 2007 +0000 @@ -0,0 +1,103 @@ +/* + Unix SMB/CIFS implementation. + + a partial implementation of RC4 designed for use in the + SMB authentication protocol + + Copyright (C) Andrew Tridgell 1998 + + $Id: crypt-rc4.c 12116 2004-09-27 23:29:22Z guy $ + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + + + Modified by Jeff Connelly for MySpaceIM Gaim plugin. +*/ + +#include <glib.h> +#include <string.h> + +#include "crypt-rc4.h" + +/* Perform RC4 on a block of data using specified key. "data" is a pointer + to the block to be processed. Output is written to same memory as input, + so caller may need to make a copy before calling this function, since + the input will be overwritten. + + Taken from Samba source code. Modified to allow us to maintain state + between calls to crypt_rc4. +*/ + +void crypt_rc4_init(rc4_state_struct *rc4_state, + const unsigned char *key, int key_len) +{ + int ind; + unsigned char j = 0; + unsigned char *s_box; + + memset(rc4_state, 0, sizeof(rc4_state_struct)); + s_box = rc4_state->s_box; + + for (ind = 0; ind < 256; ind++) + { + s_box[ind] = (unsigned char)ind; + } + + for( ind = 0; ind < 256; ind++) + { + unsigned char tc; + + j += (s_box[ind] + key[ind%key_len]); + + tc = s_box[ind]; + s_box[ind] = s_box[j]; + s_box[j] = tc; + } + +} + +void crypt_rc4(rc4_state_struct *rc4_state, unsigned char *data, int data_len) +{ + unsigned char *s_box; + unsigned char index_i; + unsigned char index_j; + int ind; + + /* retrieve current state from the state struct (so we can resume where + we left off) */ + index_i = rc4_state->index_i; + index_j = rc4_state->index_j; + s_box = rc4_state->s_box; + + for( ind = 0; ind < data_len; ind++) + { + unsigned char tc; + unsigned char t; + + index_i++; + index_j += s_box[index_i]; + + tc = s_box[index_i]; + s_box[index_i] = s_box[index_j]; + s_box[index_j] = tc; + + t = s_box[index_i] + s_box[index_j]; + data[ind] = data[ind] ^ s_box[t]; + } + + /* Store the updated state */ + rc4_state->index_i = index_i; + rc4_state->index_j = index_j; +}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/libpurple/protocols/myspace/crypt-rc4.h Sat Apr 21 03:15:48 2007 +0000 @@ -0,0 +1,36 @@ +/* + Unix SMB/CIFS implementation. + + a partial implementation of RC4 designed for use in the + SMB authentication protocol + + Copyright (C) Andrew Tridgell 1998 + + $Id: crypt-rc4.h 12116 2004-09-27 23:29:22Z guy $ + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +*/ + +typedef struct _rc4_state_struct { + unsigned char s_box[256]; + unsigned char index_i; + unsigned char index_j; +} rc4_state_struct; + +void crypt_rc4_init(rc4_state_struct *rc4_state, + const unsigned char *key, int key_len); + +void crypt_rc4(rc4_state_struct *rc4_state, unsigned char *data, int data_len); +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/libpurple/protocols/myspace/myspace.c Sat Apr 21 03:15:48 2007 +0000 @@ -0,0 +1,1556 @@ +/* MySpaceIM Protocol Plugin + * + * \author Jeff Connelly + * + * Copyright (C) 2007, Jeff Connelly <myspaceim@xyzzy.cjb.net> + * + * Based on Gaim's "C Plugin HOWTO" hello world example. + * + * Code also drawn from myspace: + * http://snarfed.org/space/gaim+mock+protocol+plugin + * Copyright (C) 2004-2007, Ryan Barrett <mockprpl@ryanb.org> + * + * and some constructs also based on existing Gaim plugins, which are: + * Copyright (C) 2003, Robbert Haarman <gaim@inglorion.net> + * Copyright (C) 2003, Ethan Blanton <eblanton@cs.purdue.edu> + * Copyright (C) 2000-2003, Rob Flynn <rob@tgflinux.com> + * Copyright (C) 1998-1999, Mark Spencer <markster@marko.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#define GAIM_PLUGINS + +#include <string.h> +#include <errno.h> /* for EAGAIN */ + +#include <glib.h> + +#ifdef _WIN32 +#include "win32dep.h" +#else +/* For recv() and send(); needed to match Win32 */ +#include <sys/types.h> +#include <sys/socket.h> +#endif + +#include "notify.h" +#include "plugin.h" +#include "version.h" +#include "cipher.h" /* for SHA-1 */ +#include "util.h" /* for base64 */ +#include "debug.h" /* for gaim_debug_info */ + +#define MSIM_STATUS_ONLINE "online" +#define MSIM_STATUS_AWAY "away" +#define MSIM_STATUS_OFFLINE "offline" +#define MSIM_STATUS_INVISIBLE "invisible" + +/* Build version of MySpaceIM to report to servers */ +#define MSIM_CLIENT_VERSION 673 + +#define MSIM_SERVER "im.myspace.akadns.net" +//#define MSIM_SERVER "localhost" +#define MSIM_PORT 1863 /* TODO: alternate ports and automatic */ + +/* Constants */ +#define HASH_SIZE 0x14 /**< Size of SHA-1 hash for login */ +#define NONCE_HALF_SIZE 0x20 /**< Half of decoded 'nc' field */ +#define MSIM_READ_BUF_SIZE 5*1024 /**< Receive buffer size */ +#define MSIM_FINAL_STRING "\\final\\" /**< Message end marker */ + +/* Messages */ +#define MSIM_BM_INSTANT 1 +#define MSIM_BM_STATUS 100 +#define MSIM_BM_ACTION 121 +/*#define MSIM_BM_UNKNOWN1 122*/ + +/* Random number in every MsimSession, to ensure it is valid. */ +#define MSIM_SESSION_STRUCT_MAGIC 0xe4a6752b + +/* Everything needed to keep track of a session. */ +typedef struct _MsimSession +{ + guint magic; /**< MSIM_SESSION_STRUCT_MAGIC */ + GaimAccount *account; + GaimConnection *gc; + gchar *sesskey; /**< Session key text string from server */ + gchar *userid; /**< This user's numeric user ID */ + gint fd; /**< File descriptor to/from server */ + + GHashTable *user_lookup_cb; /**< Username -> userid lookup callback */ + GHashTable *user_lookup_cb_data; /**< Username -> userid lookup callback data */ + GHashTable *user_lookup_cache; /**< Cached information on users */ + + gchar *rxbuf; /**< Receive buffer */ + guint rxoff; /**< Receive buffer offset */ +} MsimSession; + +#define MSIM_SESSION_VALID(s) (session != NULL && session->magic == MSIM_SESSION_STRUCT_MAGIC) + +/* Callback for when a user's information is received, initiated from a user lookup. */ +typedef void (*MSIM_USER_LOOKUP_CB)(MsimSession *session, GHashTable *userinfo, gpointer data); + +/* Passed to MSIM_USER_LOOKUP_CB for msim_send_im_cb - called when + * user information is available, ready to send a message. */ +typedef struct _send_im_cb_struct +{ + gchar *who; + gchar *message; + GaimMessageFlags flags; +} send_im_cb_struct; + + +/* TODO: .h file */ +static void msim_lookup_user(MsimSession *session, const gchar *user, MSIM_USER_LOOKUP_CB cb, gpointer data); +static inline gboolean msim_is_userid(const gchar *user); +static void msim_session_destroy(MsimSession *session); + +static void init_plugin(GaimPlugin *plugin) +{ + gaim_notify_message(plugin, GAIM_NOTIFY_MSG_INFO, "Hello World!", + "This is the Hello World! plugin :)", NULL, NULL, NULL); +} + +/** + * Get possible user status types. Based on mockprpl. + * + * @return GList of status types. + */ +static GList *msim_status_types(GaimAccount *acct) +{ + GList *types; + GaimStatusType *type; + + gaim_debug_info("myspace", "returning status types for %s: %s, %s, %s\n", + acct->username, + MSIM_STATUS_ONLINE, MSIM_STATUS_AWAY, MSIM_STATUS_OFFLINE, MSIM_STATUS_INVISIBLE); + + + types = NULL; + + type = gaim_status_type_new(GAIM_STATUS_AVAILABLE, MSIM_STATUS_ONLINE, + MSIM_STATUS_ONLINE, TRUE); + gaim_status_type_add_attr(type, "message", "Online", + gaim_value_new(GAIM_TYPE_STRING)); + types = g_list_append(types, type); + + type = gaim_status_type_new(GAIM_STATUS_AWAY, MSIM_STATUS_AWAY, + MSIM_STATUS_AWAY, TRUE); + gaim_status_type_add_attr(type, "message", "Away", + gaim_value_new(GAIM_TYPE_STRING)); + types = g_list_append(types, type); + + type = gaim_status_type_new(GAIM_STATUS_OFFLINE, MSIM_STATUS_OFFLINE, + MSIM_STATUS_OFFLINE, TRUE); + gaim_status_type_add_attr(type, "message", "Offline", + gaim_value_new(GAIM_TYPE_STRING)); + types = g_list_append(types, type); + + type = gaim_status_type_new(GAIM_STATUS_INVISIBLE, MSIM_STATUS_INVISIBLE, + MSIM_STATUS_INVISIBLE, TRUE); + gaim_status_type_add_attr(type, "message", "Invisible", + gaim_value_new(GAIM_TYPE_STRING)); + types = g_list_append(types, type); + + return types; +} + +/** + * Parse a MySpaceIM protocol message into a hash table. + * + * @param msg The message string to parse, will be g_free()'d. + * + * @return Hash table of message. Caller should destroy with + * g_hash_table_destroy() when done. + */ +static GHashTable* msim_parse(gchar* msg) +{ + GHashTable *table; + gchar *token; + gchar **tokens; + gchar *key; + gchar *value; + int i; + + g_return_val_if_fail(msg != NULL, NULL); + + gaim_debug_info("msim", "msim_parse: got <%s>\n", msg); + + key = NULL; + + /* All messages begin with a \ */ + if (msg[0] != '\\' || msg[1] == 0) + { + gaim_debug_info("msim", "msim_parse: incomplete/bad msg, " + "missing initial backslash: <%s>", msg); + /* XXX: Should we try to recover, and read to first backslash? */ + + g_free(msg); + return NULL; + } + + /* Create table of strings, set to call g_free on destroy. */ + table = g_hash_table_new_full((GHashFunc)g_str_hash, + (GEqualFunc)g_str_equal, g_free, g_free); + + for (tokens = g_strsplit(msg + 1, "\\", 0), i = 0; + (token = tokens[i]); + i++) + { + //printf("tok=<%s>, i%2=%d\n", token, i % 2); + if (i % 2) + { + value = token; + + /* Check if key already exists */ + if (g_hash_table_lookup(table, key) == NULL) + { + //printf("insert: |%s|=|%s|\n", key, value); + g_hash_table_insert(table, g_strdup(key), g_strdup(value)); + } else { + /* TODO: Some dictionaries have multiple values for the same + * key. Should append to a GList to handle this case. */ + gaim_debug_info("msim", "msim_parse: key %s already exists, " + "not overwriting or replacing; ignoring new value %s", key, + value); + } + } else { + key = token; + } + } + g_strfreev(tokens); + + /* Can free now since all data was copied to hash key/values */ + g_free(msg); + + return table; +} + +#include "crypt-rc4.c" + +/** + * Compute the base64'd login challenge response based on username, password, nonce, and IPs. + * + * @param nonce The base64 encoded nonce ('nc') field from the server. + * @param email User's email address (used as login name). + * @param password User's cleartext password. + * + * @return Encoded login challenge response, ready to send to the server. Must be g_free()'d + * when finished. + */ +static gchar* msim_compute_login_response(guchar nonce[2*NONCE_HALF_SIZE], gchar* email, gchar* password) +{ + GaimCipherContext *key_context; + GaimCipher *sha1; + rc4_state_struct rc4; + guchar hash_pw[HASH_SIZE]; + guchar key[HASH_SIZE]; + gchar* password_utf16le; + guchar* data; + gchar* response; + int i, data_len; + + //memset(nonce, 0, NONCE_HALF_SIZE); + //memset(nonce + NONCE_HALF_SIZE, 1, NONCE_HALF_SIZE); + + /* Convert ASCII password to UTF16 little endian */ + /* TODO: use the built-in facility to do this, like Nathan Peterson does. */ + gaim_debug_info("msim", "converting password to utf16le\n"); + //printf("pw=<%s>\n",password); + password_utf16le = g_new0(gchar, strlen(password) * 2); + for (i = 0; i < strlen(password) * 2; i += 2) + { + password_utf16le[i] = password[i / 2]; + password_utf16le[i + 1] = 0; + } + + /* Compute password hash */ + gaim_cipher_digest_region("sha1", (guchar*)password_utf16le, strlen(password) * 2, + sizeof(hash_pw), hash_pw, NULL); + +#ifdef MSIM_DEBUG_LOGIN_CHALLENGE + printf("pwhash = "); + for (i = 0; i < sizeof(hash_pw); i++) + printf("%.2x ", hash_pw[i]); + printf("\n"); +#endif + + /* key = sha1(sha1(pw) + nonce2) */ + sha1 = gaim_ciphers_find_cipher("sha1"); + key_context = gaim_cipher_context_new(sha1, NULL); + gaim_cipher_context_append(key_context, hash_pw, HASH_SIZE); + gaim_cipher_context_append(key_context, nonce + NONCE_HALF_SIZE, NONCE_HALF_SIZE); + gaim_cipher_context_digest(key_context, sizeof(key), key, NULL); + +#ifdef MSIM_DEBUG_LOGIN_CHALLENGE + printf("key = "); + for (i = 0; i < sizeof(key); i++) + { + printf("%.2x ", key[i]); + } + printf("\n"); +#endif + + /* Note: 'key' variable is 0x14 bytes (from SHA-1 hash), + * but only first 0x10 used for the RC4 key. */ + crypt_rc4_init(&rc4, key, 0x10); + + /* TODO: obtain IPs of network interfaces. This is not immediately + * important because you can still connect and perform basic + * functions of the protocol. There is also a high chance that the addreses + * are RFC1918 private, so the servers couldn't do anything with them + * anyways except make note of that fact. Probably important for any + * kind of direct connection, or file transfer functionality. + */ + /* rc4 encrypt: + * nonce1+email+IP list */ + data_len = NONCE_HALF_SIZE + strlen(email) + 25; + data = g_new0(guchar, data_len); + memcpy(data, nonce, NONCE_HALF_SIZE); + memcpy(data + NONCE_HALF_SIZE, email, strlen(email)); + memcpy(data + NONCE_HALF_SIZE + strlen(email), + /* IP addresses of network interfaces */ + "\x00\x00\x00\x00\x05\x7f\x00\x00\x01\x00\x00\x00\x00\x0a\x00\x00\x40\xc0\xa8\x58\x01\xc0\xa8\x3c\x01", 25); + crypt_rc4(&rc4, data, data_len); + + response = gaim_base64_encode(data, data_len); +#ifdef MSIM_DEBUG_LOGIN_CHALLENGE + printf("response=<%s>\n", response); +#endif + + return response; +} + +static void print_hash_item(gpointer key, gpointer value, gpointer user_data) +{ + printf("%s=%s\n", (char*)key, (char*)value); +} + +/** + * Send an arbitrary protocol message. + * + * @param session + * @param msg The textual, encoded message to send. + * + * Note: this does not send instant messages. For that, see msim_send_im. + */ +static void msim_send(MsimSession *session, const gchar *msg) +{ + int ret; + + g_return_if_fail(MSIM_SESSION_VALID(session)); + g_return_if_fail(msg != NULL); + + gaim_debug_info("msim", "msim_send: writing <%s>\n", msg); + + ret = send(session->fd, msg, strlen(msg), 0); + + if (ret != strlen(msg)) + { + gaim_debug_info("msim", "msim_send(%s): strlen=%d, but only wrote %s\n", + msg, strlen(msg), ret); + /* TODO: better error */ + } +} + +/** + * Process a login challenge, sending a response. + * + * @param session + * @param table Hash table of login challenge message. + * + * @return 0, since the 'table' parameter is no longer needed. + */ +static int msim_login_challenge(MsimSession *session, GHashTable *table) +{ + GaimAccount *account; + gchar *nc_str; + guchar *nc; + gchar *response_str; + gsize nc_len; + gchar *buf; + + g_return_val_if_fail(MSIM_SESSION_VALID(session), 0); + g_return_val_if_fail(table != NULL, 0); + + nc_str = g_hash_table_lookup(table, "nc"); + + account = session->account; + //assert(account); + + gaim_connection_update_progress(session->gc, "Reading challenge", 1, 4); + + gaim_debug_info("msim", "nc=<%s>\n", nc_str); + + nc = (guchar*)gaim_base64_decode(nc_str, &nc_len); + gaim_debug_info("msim", "base64 decoded to %d bytes\n", nc_len); + if (nc_len != 0x40) + { + gaim_debug_info("msim", "bad nc length: %x != 0x40\n", nc_len); + gaim_connection_error(session->gc, "Unexpected challenge length from server"); + return 0; + } + + gaim_connection_update_progress(session->gc, "Logging in", 2, 4); + + printf("going to compute login response\n"); + //response_str = msim_compute_login_response(nc_str, "testuser", "testpw"); //session->gc->account->username, session->gc->account->password); + response_str = msim_compute_login_response(nc, account->username, account->password); + printf("got back login response\n"); + + g_free(nc); + + /* Reply */ + buf = g_strdup_printf("\\login2\\%d\\username\\%s\\response\\%s\\clientver\\%d\\reconn\\%d\\status\\%d\\id\\1\\final\\", + 196610, account->username, response_str, MSIM_CLIENT_VERSION, 0, 100); + + g_free(response_str); + + gaim_debug_info("msim", "response=<%s>\n", buf); + + msim_send(session, buf); + + g_free(buf); + + return 0; +} + +/** + * Parse a \x1c-separated "dictionary" of key=value pairs into a hash table. + * + * @param body_str The text of the dictionary to parse. Often the + * value for the 'body' field. + * + * @return Hash table of the keys and values. Must g_hash_table_destroy() when done. + */ +static GHashTable *msim_parse_body(const gchar *body_str) +{ + GHashTable *table; + gchar *item; + gchar **items; + gchar **elements; + guint i; + + g_return_val_if_fail(body_str != NULL, NULL); + + table = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, g_free); + + for (items = g_strsplit(body_str, "\x1c", 0), i = 0; + (item = items[i]); + i++) + { + gchar *key, *value; + + //printf("TOK=<%s>\n", token); + elements = g_strsplit(item, "=", 2); + + key = elements[0]; + if (!key) + { + gaim_debug_info("msim", "msim_parse_body(%s): null key", body_str); + g_strfreev(elements); + break; + } + + value = elements[1]; + if (!value) + { + gaim_debug_info("msim", "msim_parse_body(%s): null value", body_str); + g_strfreev(elements); + break; + } + + //printf("-- %s: %s\n", key, value); + + /* XXX: This overwrites duplicates. */ + /* TODO: make the GHashTable values be GList's, and append to the list if + * there is already a value of the same key name. This is important for + * the WebChallenge message. */ + g_hash_table_insert(table, g_strdup(key), g_strdup(value)); + + g_strfreev(elements); + } + + g_strfreev(items); + + return table; +} + +/** + * Immediately send an IM to a user, by their numeric user ID. + * + * @param session + * @param userid ASCII numeric userid. + * @param message Text of message to send. + * @param flags Gaim instant message flags. + * + * @return 0, since the 'table' parameter is no longer needed. + * + */ +static int msim_send_im_by_userid(MsimSession *session, const gchar *userid, const gchar *message, GaimMessageFlags flags) +{ + gchar *msg_string; + + g_return_val_if_fail(MSIM_SESSION_VALID(session), 0); + g_return_val_if_fail(userid != NULL, 0); + g_return_val_if_fail(msim_is_userid(userid) == TRUE, 0); + g_return_val_if_fail(message != NULL, 0); + + /* TODO: constants for bm types */ + msg_string = g_strdup_printf("\\bm\\121\\sesskey\\%s\\t\\%s\\cv\\%d\\msg\\%s\\final\\", + session->sesskey, userid, MSIM_CLIENT_VERSION, message); + + gaim_debug_info("msim", "going to write: %s\n", msg_string); + + msim_send(session, msg_string); + + /* TODO: notify Gaim that we sent the IM. */ + + /* Not needed since sending messages to yourself is allowed by MSIM! */ + /*if (strcmp(from_username, who) == 0) + serv_got_im(gc, from_username, message, GAIM_MESSAGE_RECV, time(NULL)); + */ + + return 0; +} + + +/** + * Callback called when ready to send an IM by userid (the userid has been looked up). + * Calls msim_send_im_by_userid. + * + * @param session + * @param userinfo User info message from server containing a 'body' field + * with a 'UserID' key. This is where the user ID is taken from. + * @param data A send_im_cb_struct* of information on the IM to send. + * + */ +static void msim_send_im_by_userid_cb(MsimSession *session, GHashTable *userinfo, gpointer data) +{ + send_im_cb_struct *s; + gchar *userid; + GHashTable *body; + + g_return_if_fail(MSIM_SESSION_VALID(session)); + g_return_if_fail(userinfo != NULL); + + body = msim_parse_body(g_hash_table_lookup(userinfo, "body")); + g_assert(body); + + userid = g_hash_table_lookup(body, "UserID"); + + s = (send_im_cb_struct*)data; + msim_send_im_by_userid(session, userid, s->message, s->flags); + + g_hash_table_destroy(body); + g_hash_table_destroy(userinfo); + g_free(s->message); + g_free(s->who); +} + +/** + * Process a message reply from the server. + * + * @param session + * @param table Message reply from server. + * + * @return 0, since the 'table' field is no longer needed. + */ +static int msim_process_reply(MsimSession *session, GHashTable *table) +{ + gchar *rid_str; + + g_return_val_if_fail(MSIM_SESSION_VALID(session), 0); + g_return_val_if_fail(table != NULL, 0); + + rid_str = g_hash_table_lookup(table, "rid"); + + if (rid_str) /* msim_lookup_user sets callback for here */ + { + MSIM_USER_LOOKUP_CB cb; + gpointer data; + guint rid; + + GHashTable *body; + gchar *username; + + rid = atol(rid_str); + + /* Cache the user info. Currently, the GHashTable of user info in + * this cache never expires so is never freed. TODO: expire and destroy + * + * Some information never changes (username->userid map), some does. + * TODO: Cache what doesn't change only + */ + body = msim_parse_body(g_hash_table_lookup(table, "body")); + username = g_hash_table_lookup(body, "UserName"); + if (username) + { + g_hash_table_insert(session->user_lookup_cache, g_strdup(username), body); + } else { + gaim_debug_info("msim", "msim_process_reply: not caching <%s>, no UserName", + g_hash_table_lookup(table, "body")); + } + + /* If a callback is registered for this userid lookup, call it. */ + + cb = g_hash_table_lookup(session->user_lookup_cb, GUINT_TO_POINTER(rid)); + data = g_hash_table_lookup(session->user_lookup_cb_data, GUINT_TO_POINTER(rid)); + + if (cb) + { + gaim_debug_info("msim", "msim_process_body: calling callback now\n"); + cb(session, table, data); + g_hash_table_remove(session->user_lookup_cb, GUINT_TO_POINTER(rid)); + g_hash_table_remove(session->user_lookup_cb_data, GUINT_TO_POINTER(rid)); + + /* Return 1 to tell caller of msim_process (msim_input_cb) to + * not destroy 'table'; allow 'cb' to hang on to it and destroy + * it when it wants. */ + return 1; + } else { + gaim_debug_info("msim", "msim_process_body: no callback for rid %d\n", rid); + } + } + return 0; +} + +/** + * Handle an error from the server. + * + * @param session + * @param table The message. + * + * @return 0, since 'table' can be freed. + */ +static int msim_error(MsimSession *session, GHashTable *table) +{ + gchar *err, *errmsg, *full_errmsg; + + g_return_val_if_fail(MSIM_SESSION_VALID(session), 0); + g_return_val_if_fail(table != NULL, 0); + + err = g_hash_table_lookup(table, "err"); + errmsg = g_hash_table_lookup(table, "errmsg"); + + full_errmsg = g_strdup_printf("Protocol error, code %s: %s", err, errmsg); + + gaim_debug_info("msim", "msim_error: %s\n", full_errmsg); + + /* TODO: check 'fatal' and die if asked to. + * TODO: do something with the error # (localization of errmsg?) */ + gaim_notify_error(session->account, g_strdup("MySpaceIM Error"), + full_errmsg, NULL); + + if (g_hash_table_lookup(table, "fatal")) + { + gaim_debug_info("msim", "fatal error, destroy session\n"); + gaim_connection_error(session->gc, full_errmsg); + close(session->fd); + //msim_session_destroy(session); + } + + return 0; +} + +/** + * Callback to handle incoming messages, after resolving userid. + * + * @param session + * @param userinfo Message from server on user's info, containing UserName. + * @param data A gchar* of the incoming instant message's text. + */ +static void msim_incoming_im_cb(MsimSession *session, GHashTable *userinfo, gpointer data) +{ + gchar *msg; + gchar *username; + GHashTable *body; + + g_return_if_fail(MSIM_SESSION_VALID(session)); + g_return_if_fail(userinfo != NULL); + + body = msim_parse_body(g_hash_table_lookup(userinfo, "body")); + g_assert(body != NULL); + + username = g_hash_table_lookup(body, "UserName"); + + msg = (gchar*)data; + serv_got_im(session->gc, username, msg, GAIM_MESSAGE_RECV, time(NULL)); + + g_hash_table_destroy(body); + g_hash_table_destroy(userinfo); +} + +/** + * Handle an incoming message. + * + * @param session The session + * @param table Message from the server, containing 'f' (userid from) and 'msg'. + * + * @return 0, since table can be freed. + */ +static int msim_incoming_im(MsimSession *session, GHashTable *table) +{ + gchar *userid; + gchar *msg; + + g_return_val_if_fail(MSIM_SESSION_VALID(session), 0); + g_return_val_if_fail(table != NULL, 0); + + + userid = g_hash_table_lookup(table, "f"); + msg = g_hash_table_lookup(table, "msg"); + + gaim_debug_info("msim", "msim_incoming_im: got msg <%s> from <%s>, resolving username\n", + msg, userid); + + msim_lookup_user(session, userid, msim_incoming_im_cb, g_strdup(msg)); + + return 0; +} + +#if 0 +/* Not sure about this */ +static void msim_status_now(gchar *who, gpointer data) +{ + printf("msim_status_now: %s\n", who); +} +#endif + +/** + * Callback to update incoming status messages, after looked up username. + * + * @param session + * @param userinfo Looked up user information from server. + * @param data gchar* status string. + * + */ +static void msim_status_cb(MsimSession *session, GHashTable *userinfo, gpointer data) +{ + GaimBuddyList *blist; + GaimBuddy *buddy; + GaimPresence *presence; + GHashTable *body; + //GaimStatus *status; + gchar **status_array; + GList *list; + gchar *status_text, *status_code; + gchar *status_str; + gint i; + gchar *username; + + g_return_if_fail(MSIM_SESSION_VALID(session)); + g_return_if_fail(userinfo != NULL); + + status_str = (gchar*)data; + + body = msim_parse_body(g_hash_table_lookup(userinfo, "body")); + g_assert(body); + + username = g_hash_table_lookup(body, "UserName"); + /* Note: DisplayName doesn't seem to be resolvable. It could be displayed on + * the buddy list, if the UserID was stored along with it. */ + + if (!username) + { + gaim_debug_info("msim", "msim_status_cb: no username?!\n"); + return; + } + + gaim_debug_info("msim", "msim_status_cb: updating status for <%s> to <%s>\n", username, status_str); + + /* TODO: generic functions to split into a GList */ + status_array = g_strsplit(status_str, "|", 0); + for (list = NULL, i = 0; + status_array[i]; + i++) + { + list = g_list_append(list, status_array[i]); + } + + /* Example fields: |s|0|ss|Offline */ + status_code = g_list_nth_data(list, 2); + status_text = g_list_nth_data(list, 4); + + blist = gaim_get_blist(); + + /* Add buddy if not found */ + buddy = gaim_find_buddy(session->account, username); + if (!buddy) + { + /* TODO: gaim aliases, userids and usernames */ + gaim_debug_info("msim", "msim_status: making new buddy for %s\n", username); + buddy = gaim_buddy_new(session->account, username, NULL); + + /* TODO: sometimes (when click on it), buddy list disappears. Fix. */ + gaim_blist_add_buddy(buddy, NULL, NULL, NULL); + } else { + gaim_debug_info("msim", "msim_status: found buddy %s\n", username); + } + + /* For now, always set status to online. + * TODO: make status reflect reality + * TODO: show headline */ + presence = gaim_presence_new_for_buddy(buddy); + gaim_presence_set_status_active(presence, MSIM_STATUS_ONLINE, TRUE); + + g_strfreev(status_array); + g_list_free(list); + g_hash_table_destroy(body); + g_hash_table_destroy(userinfo); + /* Do not free status_str - it will be freed by g_hash_table_destroy on session->userid_lookup_cb_data */ +} + +/** + * Process incoming status messages. + * + * @param session + * @param table Status update message. + * + * @return 0, since 'table' can be freed. + */ +static int msim_status(MsimSession *session, GHashTable *table) +{ + gchar *status_str; + gchar *userid; + + g_return_val_if_fail(MSIM_SESSION_VALID(session), 0); + g_return_val_if_fail(table != NULL, 0); + + status_str = g_hash_table_lookup(table, "msg"); + if (!status_str) + { + gaim_debug_info("msim", "msim_status: bm=100 but no status msg\n"); + return 0; + } + + userid = g_hash_table_lookup(table, "f"); + if (!userid) + { + gaim_debug_info("msim", "msim_status: bm=100 but no f field\n"); + return 0; + } + + /* TODO: if buddies were identified on buddy list by uid, wouldn't have to lookup + * before updating the status! Much more efficient. */ + gaim_debug_info("msim", "msim_status: got status msg <%s> for <%s>, scheduling lookup\n", + status_str, userid); + + /* Actually update status once obtain username */ + msim_lookup_user(session, userid, msim_status_cb, g_strdup(status_str)); + + return 0; +} + + +/** + * Process a message. + * + * @param gc Connection. + * @param table Any message from the server. + * + * @return The return value of the function used to process the message, or -1 if + * called with invalid parameters. + */ +static int msim_process(GaimConnection *gc, GHashTable *table) +{ + MsimSession *session; + + g_return_val_if_fail(gc != NULL, -1); + g_return_val_if_fail(table != NULL, -1); + + session = (MsimSession*)gc->proto_data; + + printf("-------- message -------------\n"); + g_hash_table_foreach(table, print_hash_item, NULL); + printf("------------------------------\n"); + + if (g_hash_table_lookup(table, "nc")) + { + return msim_login_challenge(session, table); + } else if (g_hash_table_lookup(table, "sesskey")) { + printf("SESSKEY=<%s>\n", (gchar*)g_hash_table_lookup(table, "sesskey")); + + gaim_connection_update_progress(gc, "Connected", 3, 4); + + session->sesskey = g_strdup(g_hash_table_lookup(table, "sesskey")); + + /* Comes with: proof,profileid,userid,uniquenick -- all same values + * (at least for me). */ + session->userid = g_strdup(g_hash_table_lookup(table, "userid")); + + gaim_connection_set_state(gc, GAIM_CONNECTED); + + return 0; + } else if (g_hash_table_lookup(table, "bm")) { + guint bm; + + bm = atoi(g_hash_table_lookup(table, "bm")); + switch (bm) + { + case MSIM_BM_STATUS: + return msim_status(session, table); + case MSIM_BM_INSTANT: + return msim_incoming_im(session, table); + default: + /* Not really an IM, but show it for informational + * purposes during development. */ + return msim_incoming_im(session, table); + } + + if (bm == MSIM_BM_STATUS) + { + return msim_status(session, table); + } else { /* else if strcmp(bm, "1") == 0) */ + return msim_incoming_im(session, table); + } + } else if (g_hash_table_lookup(table, "rid")) { + return msim_process_reply(session, table); + } else if (g_hash_table_lookup(table, "error")) { + return msim_error(session, table); + } else if (g_hash_table_lookup(table, "ka")) { + gaim_debug_info("msim", "msim_process: got keep alive\n"); + return 0; + } else { + printf("<<unhandled>>\n"); + return 0; + } +} + +/** + * Callback when input available. + * + * @param gc_uncasted A GaimConnection pointer. + * @param source File descriptor. + * @param cond GAIM_INPUT_READ + * + * Reads the input, and dispatches calls msim_process to handle it. + */ +static void msim_input_cb(gpointer gc_uncasted, gint source, GaimInputCondition cond) +{ + GaimConnection *gc; + GaimAccount *account; + MsimSession *session; + gchar *end; + int n; + + g_return_if_fail(gc_uncasted != NULL); + g_return_if_fail(source >= 0); /* Note: 0 is a valid fd */ + + gc = (GaimConnection*)(gc_uncasted); + account = gaim_connection_get_account(gc); + session = gc->proto_data; + + g_return_if_fail(MSIM_SESSION_VALID(session)); + + g_assert(cond == GAIM_INPUT_READ); + + /* Only can handle so much data at once... + * If this happens, try recompiling with a higher MSIM_READ_BUF_SIZE. + * Should be large enough to hold the largest protocol message. + */ + if (session->rxoff == MSIM_READ_BUF_SIZE) + { + gaim_debug_error("msim", "msim_input_cb: %d-byte read buffer full!\n", + MSIM_READ_BUF_SIZE); + gaim_connection_error(gc, "Read buffer full"); + /* TODO: fix 100% CPU after closing */ + close(source); + return; + } + + gaim_debug_info("msim", "buffer at %d (max %d), reading up to %d\n", + session->rxoff, MSIM_READ_BUF_SIZE, MSIM_READ_BUF_SIZE - session->rxoff); + + /* Read into buffer. On Win32, need recv() not read(). session->fd also holds + * the file descriptor, but it sometimes differs from the 'source' parameter. + */ + n = recv(session->fd, session->rxbuf + session->rxoff, MSIM_READ_BUF_SIZE - session->rxoff, 0); + + if (n < 0 && errno == EAGAIN) + { + return; + } + else if (n < 0) + { + gaim_connection_error(gc, "Read error"); + gaim_debug_error("msim", "msim_input_cb: read error, ret=%d, " + "error=%s, source=%d, fd=%d (%X))\n", + n, strerror(errno), source, session->fd, session->fd); + close(source); + return; + } + else if (n == 0) + { + gaim_debug_info("msim", "msim_input_cb: server disconnected\n"); + gaim_connection_error(gc, "Server has disconnected"); + return; + } + + /* Null terminate */ + session->rxbuf[session->rxoff + n] = 0; + + /* Check for embedded NULs. I don't handle them, and they shouldn't occur. */ + if (strlen(session->rxbuf + session->rxoff) != n) + { + /* Occurs after login, but it is not a null byte. */ + gaim_debug_info("msim", "msim_input_cb: strlen=%d, but read %d bytes" + "--null byte encountered?\n", strlen(session->rxbuf + session->rxoff), n); + //gaim_connection_error(gc, "Invalid message - null byte on input"); + return; + } + + session->rxoff += n; + gaim_debug_info("msim", "msim_input_cb: read=%d\n", n); + + //printf("buf=<%s>\n", session->rxbuf); + + /* Look for \\final\\ end markers. If found, process message. */ + while((end = strstr(session->rxbuf, MSIM_FINAL_STRING))) + { + GHashTable *table; + + //printf("in loop: buf=<%s>\n", session->rxbuf); + *end = 0; + table = msim_parse(g_strdup(session->rxbuf)); + if (!table) + { + gaim_debug_info("msim", "msim_input_cb: couldn't parse <%s>\n", session->rxbuf); + gaim_connection_error(gc, "Unparseable message"); + } + else + { + /* Process message. Returns 0 to free */ + if (msim_process(gc, table) == 0) + g_hash_table_destroy(table); + } + + /* Move remaining part of buffer to beginning. */ + session->rxoff -= strlen(session->rxbuf) + strlen(MSIM_FINAL_STRING); + memmove(session->rxbuf, end + strlen(MSIM_FINAL_STRING), + MSIM_READ_BUF_SIZE - (end + strlen(MSIM_FINAL_STRING) - session->rxbuf)); + + /* Clear end of buffer */ + //memset(end, 0, MSIM_READ_BUF_SIZE - (end - session->rxbuf)); + } +} + +/** + * Callback when connected. Sets up input handlers. + * + * @param data A GaimConnection pointer. + * @param source File descriptor. + * @param error_message + */ +static void msim_connect_cb(gpointer data, gint source, const gchar *error_message) +{ + GaimConnection *gc; + MsimSession *session; + + g_return_if_fail(data != NULL); + + gc = (GaimConnection*)data; + session = gc->proto_data; + + if (source < 0) + { + gaim_connection_error(gc, "Couldn't connect to host"); + gaim_connection_error(gc, g_strdup_printf("Couldn't connect to host: %s (%d)", + error_message, source)); + return; + } + + session->fd = source; + + gc->inpa = gaim_input_add(source, GAIM_INPUT_READ, msim_input_cb, gc); +} + +/* Session methods */ + +/** + * Create a new MSIM session. + * + * @param acct The account to create the session from. + * + * @return Pointer to a new session. Free with msim_session_destroy. + */ +static MsimSession *msim_session_new(GaimAccount *acct) +{ + MsimSession *session; + + g_return_val_if_fail(acct != NULL, NULL); + + session = g_new0(MsimSession, 1); + + session->magic = MSIM_SESSION_STRUCT_MAGIC; + session->account = acct; + session->gc = gaim_account_get_connection(acct); + session->fd = -1; + session->user_lookup_cb = g_hash_table_new_full(g_direct_hash, g_direct_equal, NULL, NULL); /* do NOT free function pointers! */ + session->user_lookup_cb_data = g_hash_table_new_full(g_direct_hash, g_direct_equal, NULL, g_free); + session->user_lookup_cache = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, (GDestroyNotify)g_hash_table_destroy); + session->rxoff = 0; + session->rxbuf = g_new0(gchar, MSIM_READ_BUF_SIZE); + + return session; +} + +/** + * Free a session. + * + * @param session The session to destroy. + */ +static void msim_session_destroy(MsimSession *session) +{ + g_return_if_fail(MSIM_SESSION_VALID(session)); + + session->magic = -1; + + g_free(session->rxbuf); + g_free(session->userid); + g_free(session->sesskey); + + g_free(session); +} + +/** + * Start logging in to the MSIM servers. + * + * @param acct Account information to use to login. + */ +static void msim_login(GaimAccount *acct) +{ + GaimConnection *gc; + const char *host; + int port; + + g_return_if_fail(acct != NULL); + + gaim_debug_info("myspace", "logging in %s\n", acct->username); + + gc = gaim_account_get_connection(acct); + gc->proto_data = msim_session_new(acct); + + /* 1. connect to server */ + gaim_connection_update_progress(gc, "Connecting", + 0, /* which connection step this is */ + 4); /* total number of steps */ + + /* TODO: GUI option to be user-modifiable. */ + host = gaim_account_get_string(acct, "server", MSIM_SERVER); + port = gaim_account_get_int(acct, "port", MSIM_PORT); + /* TODO: connect */ + /* From gaim.sf.net/api: + * """Note that this function name can be misleading--although it is called + * "proxy connect," it is used for establishing any outgoing TCP connection, + * whether through a proxy or not.""" */ + + /* Calls msim_connect_cb when connected. */ + if (gaim_proxy_connect(gc, acct, host, port, msim_connect_cb, gc) == NULL) + { + /* TODO: try other ports if in auto mode, then save + * working port and try that first next time. */ + gaim_connection_error(gc, "Couldn't create socket"); + return; + } + +} + + +/** + * Close the connection. + * + * @param gc The connection. + */ +static void msim_close(GaimConnection *gc) +{ + g_return_if_fail(gc != NULL); + + msim_session_destroy(gc->proto_data); +} + +/** + * Return the icon name for a buddy and account. + * + * @param acct The account to find the icon for. + * @param buddy The buddy to find the icon for, or NULL for the accoun icon. + * + * @return The base icon name string. + */ +static const gchar *msim_list_icon(GaimAccount *acct, GaimBuddy *buddy) +{ + /* TODO: use a MySpace icon. hbons submitted one to + * http://developer.pidgin.im/wiki/MySpaceIM - tried placing in + * C:\cygwin\home\Jeff\gaim-2.0.0beta6\gtk\pixmaps\status\default + * and returning "myspace" but icon shows up blank. + */ + if (acct == NULL) + { + gaim_debug_info("msim", "msim_list_icon: acct == NULL!\n"); + //exit(-2); + } + return "meanwhile"; +} + +/** + * Check if a string is a userid (all numeric). + * + * @param user The user id, email, or name. + * + * @return TRUE if is userid, FALSE if not. + */ +static inline gboolean msim_is_userid(const gchar *user) +{ + g_return_val_if_fail(user != NULL, FALSE); + + return strspn(user, "0123456789") == strlen(user); +} + +/** + * Check if a string is an email address (contains an @). + * + * @param user The user id, email, or name. + * + * @return TRUE if is an email, FALSE if not. + * + * This function is not intended to be used as a generic + * means of validating email addresses, but to distinguish + * between a user represented by an email address from + * other forms of identification. + */ +static inline gboolean msim_is_email(const gchar *user) +{ + g_return_val_if_fail(user != NULL, FALSE); + + return strchr(user, '@') != NULL; +} + + +/** + * Asynchronously lookup user information, calling callback when receive result. + * + * @param session + * @param user The user id, email address, or username. + * @param cb Callback, called with user information when available. + * @param data An arbitray data pointer passed to the callback. + */ +static void msim_lookup_user(MsimSession *session, const gchar *user, MSIM_USER_LOOKUP_CB cb, gpointer data) +{ + gchar *field_name; + gchar *msg_string; + guint rid, cmd, dsn, lid; + + g_return_if_fail(MSIM_SESSION_VALID(session)); + g_return_if_fail(user != NULL); + g_return_if_fail(cb != NULL); + + gaim_debug_info("msim", "msim_lookup_userid", "asynchronously looking up <%s>\n", user); + + /* TODO: check if this user's info was cached and fresh; if so return immediately */ +#if 0 + /* If already know userid, then call callback immediately */ + cached_userid = g_hash_table_lookup(session->userid_cache, who); + if (cached_userid && !by_userid) + { + cb(cached_userid, NULL, NULL, data); + return; + } +#endif + + rid = rand(); //om(); + + /* Setup callback. Response will be associated with request using 'rid'. */ + g_hash_table_insert(session->user_lookup_cb, GUINT_TO_POINTER(rid), cb); + g_hash_table_insert(session->user_lookup_cb_data, GUINT_TO_POINTER(rid), data); + + /* Send request */ + + cmd = 1; + + if (msim_is_userid(user)) + { + /* TODO: document cmd,dsn,lid */ + field_name = "UserID"; + dsn = 4; + lid = 3; + } else if (msim_is_email(user)) { + field_name = "Email"; + dsn = 5; + lid = 7; + } else { + field_name = "UserName"; + dsn = 5; + lid = 7; + } + + msg_string = g_strdup_printf("\\persist\\1\\sesskey\\%s\\cmd\\1\\dsn\\%d\\uid\\%s\\lid\\%d\\rid\\%d\\body\\%s=%s\\final\\", + session->sesskey, dsn, session->userid, lid, rid, field_name, user); + + msim_send(session, msg_string); +} + +/** + * Schedule an IM to be sent once the user ID is looked up. + * + * @param gc Connection. + * @param who A user id, email, or username to send the message to. + * @param message Instant message text to send. + * @param flags Flags. + * + * @return 1 in all cases, even if the message delivery is destined to fail. + * + * Allows sending to a user by username, email address, or userid. If + * a username or email address is given, the userid must be looked up. + * This function does that by calling msim_lookup_user(), setting up + * a msim_send_im_by_userid_cb() callback function called when the userid + * response is received from the server. + * + * The callback function calls msim_send_im_by_userid() to send the actual + * instant message. If a userid is specified directly, this function is called + * immediately here. + */ +static int msim_send_im(GaimConnection *gc, const char *who, + const char *message, GaimMessageFlags flags) +{ + MsimSession *session; + const char *from_username = gc->account->username; + send_im_cb_struct *cbinfo; + + g_return_val_if_fail(gc != NULL, 0); + g_return_val_if_fail(who != NULL, 0); + g_return_val_if_fail(message != NULL, 0); + + gaim_debug_info("msim", "sending message from %s to %s: %s\n", + from_username, who, message); + + session = gc->proto_data; + + /* If numeric ID, can send message immediately without userid lookup */ + if (msim_is_userid(who)) + { + gaim_debug_info("msim", "msim_send_im: numeric 'who' detected, sending asap\n"); + msim_send_im_by_userid(session, who, message, flags); + return 1; + } + + /* Otherwise, add callback to IM when userid of destination is available */ + + /* Setup a callback for when the userid is available */ + cbinfo = g_new0(send_im_cb_struct, 1); + cbinfo->who = g_strdup(who); + cbinfo->message = g_strdup(message); + cbinfo->flags = flags; + + /* Send the request to lookup the userid */ + msim_lookup_user(session, who, msim_send_im_by_userid_cb, cbinfo); + + /* msim_send_im_by_userid_cb will now be called once userid is looked up */ + + /* Return 1 to have Gaim show this IM as being sent, 0 to not. I always + * return 1 even if the message could not be sent, since I don't know if + * it has failed yet--because the IM is only sent after the userid is + * retrieved from the server (which happens after this function returns). + * + * TODO: In MySpace, you login with your email address, but don't talk to other + * users using their email address. So there is currently an asymmetry in the + * IM windows when using this plugin: + * + * you@example.com: hello + * some_other_user: what's going on? + * you@example.com: just coding a prpl + * + * TODO: Make the sent IM's appear as from the user's username, instead of + * their email address. Gaim uses the login (in MSIM, the email)--change this. + */ + return 1; +} + +/** + * Obtain the status text for a buddy. + * + * @param buddy The buddy to obtain status text for. + * + * @return Status text. + * + * Currently returns the display name. + */ +static char *msim_status_text(GaimBuddy *buddy) +{ + MsimSession *session; + GHashTable *userinfo; + gchar *display_name; + + g_return_val_if_fail(buddy != NULL, NULL); + + session = (MsimSession*)buddy->account->gc->proto_data; + g_assert(MSIM_SESSION_VALID(session)); + g_assert(session->user_lookup_cache != NULL); + + userinfo = g_hash_table_lookup(session->user_lookup_cache, buddy->name); + if (!userinfo) + { + return g_strdup(""); + } + + display_name = g_hash_table_lookup(userinfo, "DisplayName"); + g_assert(display_name != NULL); + + return g_strdup(display_name); +} + +/** + * Obtain the tooltip text for a buddy. + * + * @param buddy Buddy to obtain tooltip text on. + * @param user_info Variable modified to have the tooltip text. + * @param full TRUE if should obtain full tooltip text. + * + */ +static void msim_tooltip_text(GaimBuddy *buddy, GaimNotifyUserInfo *user_info, gboolean full) +{ + g_return_if_fail(buddy != NULL); + g_return_if_fail(user_info != NULL); + + if (GAIM_BUDDY_IS_ONLINE(buddy)) + { + MsimSession *session; + GHashTable *userinfo; + + session = (MsimSession*)buddy->account->gc->proto_data; + + g_assert(MSIM_SESSION_VALID(session)); + g_assert(session->user_lookup_cache); + + userinfo = g_hash_table_lookup(session->user_lookup_cache, buddy->name); + + g_assert(userinfo != NULL); + + // TODO: if (full), do something different + gaim_notify_user_info_add_pair(user_info, "User ID", g_hash_table_lookup(userinfo, "UserID")); + gaim_notify_user_info_add_pair(user_info, "Display Name", g_hash_table_lookup(userinfo, "DisplayName")); + gaim_notify_user_info_add_pair(user_info, "User Name", g_hash_table_lookup(userinfo, "UserName")); + gaim_notify_user_info_add_pair(user_info, "Total Friends", g_hash_table_lookup(userinfo, "TotalFriends")); + gaim_notify_user_info_add_pair(user_info, "Song", + g_strdup_printf("%s - %s", + (gchar*)g_hash_table_lookup(userinfo, "BandName"), + (gchar*)g_hash_table_lookup(userinfo, "SongName"))); + } +} + +/** Callbacks called by Gaim, to access this plugin. */ +static GaimPluginProtocolInfo prpl_info = +{ + OPT_PROTO_MAIL_CHECK,/* options - TODO: myspace will notify of mail */ + NULL, /* user_splits */ + NULL, /* protocol_options */ + NO_BUDDY_ICONS, /* icon_spec - TODO: eventually should add this */ + msim_list_icon, /* list_icon */ + NULL, /* list_emblems */ + msim_status_text, /* status_text */ + msim_tooltip_text, /* tooltip_text */ + msim_status_types, /* status_types */ + NULL, /* blist_node_menu */ + NULL, /* chat_info */ + NULL, /* chat_info_defaults */ + msim_login, /* login */ + msim_close, /* close */ + msim_send_im, /* send_im */ + NULL, /* set_info */ + NULL, /* send_typing */ + NULL, /* get_info */ + NULL, /* set_away */ + NULL, /* set_idle */ + NULL, /* change_passwd */ + NULL, /* add_buddy */ + NULL, /* add_buddies */ + NULL, /* remove_buddy */ + NULL, /* remove_buddies */ + NULL, /* add_permit */ + NULL, /* add_deny */ + NULL, /* rem_permit */ + NULL, /* rem_deny */ + NULL, /* set_permit_deny */ + NULL, /* join_chat */ + NULL, /* reject chat invite */ + NULL, /* get_chat_name */ + NULL, /* chat_invite */ + NULL, /* chat_leave */ + NULL, /* chat_whisper */ + NULL, /* chat_send */ + NULL, /* keepalive */ + NULL, /* register_user */ + NULL, /* get_cb_info */ + NULL, /* get_cb_away */ + NULL, /* alias_buddy */ + NULL, /* group_buddy */ + NULL, /* rename_group */ + NULL, /* buddy_free */ + NULL, /* convo_closed */ + NULL, /* normalize */ + NULL, /* set_buddy_icon */ + NULL, /* remove_group */ + NULL, /* get_cb_real_name */ + NULL, /* set_chat_topic */ + NULL, /* find_blist_chat */ + NULL, /* roomlist_get_list */ + NULL, /* roomlist_cancel */ + NULL, /* roomlist_expand_category */ + NULL, /* can_receive_file */ + NULL, /* send_file */ + NULL, /* new_xfer */ + NULL, /* offline_message */ + NULL, /* whiteboard_prpl_ops */ + NULL, /* send_raw */ + NULL /* roomlist_room_serialize */ +}; + + + +/** Based on MSN's plugin info comments. */ +static GaimPluginInfo info = +{ + GAIM_PLUGIN_MAGIC, + GAIM_MAJOR_VERSION, + GAIM_MINOR_VERSION, + GAIM_PLUGIN_PROTOCOL, /**< type */ + NULL, /**< ui_requirement */ + 0, /**< flags */ + NULL, /**< dependencies */ + GAIM_PRIORITY_DEFAULT, /**< priority */ + + "prpl-myspace", /**< id */ + "MySpaceIM", /**< name */ + "0.4", /**< version */ + /** summary */ + "MySpaceIM Protocol Plugin", + /** description */ + "MySpaceIM Protocol Plugin", + "Jeff Connelly <myspaceim@xyzzy.cjb.net>", /**< author */ + "http://developer.pidgin.im/wiki/MySpaceIM/", /**< homepage */ + + NULL, /**< load */ + NULL, /**< unload */ + NULL, /**< destroy */ + NULL, /**< ui_info */ + &prpl_info, /**< extra_info */ + NULL, /**< prefs_info */ + + /* msim_actions */ + NULL +}; + + +GAIM_INIT_PLUGIN(myspace, init_plugin, info);