phpurple

Anatol Belski

Monday, December 24. 2007

phpurple

Some time ago i've started to write the binding for the libpurple, the im lib. About 3-4 weeks ago i had a simple functional implementation, which i've presented on php pecl and libpurple mailing lists. Subsequently i've completely revised the whole thing to be OO and would present it again. There is the same minimal functionality implemented, but all is OO. So, lets begin. First install the php development package and get the code:

CODE:
user@host~# svn co https://phpurple.svn.sourceforge.net/svnroot/phpurple/trunk phpurple


Compiling the extension is quite simple. Just cd into the phpurple dir and do the following:

CODE:
user@host~# phpize && ./configure --enable-purple && make


After this you should have the subdir modules with purple.so in it. If not, something went wrong. If yes, don't hurry to run "make install" yet. Now lets build a piece of php code to test the ext. First load the ext

PHP:
if(!extension_loaded('purple')) {
	dl('purple.' . PHP_SHLIB_SUFFIX);
}


With php >=5.3 namespaces must be used:

PHP:
use Purple::Purple;
use Purple::Account;
use Purple::Conversation;
use Purple::Connection;
use Purple::Callback;


Define the ui id

PHP:
$ui_id = "hello_world";


Now we need a callback class, which must inherit from the Purple::Callback, to pass it to the Purple instance:

PHP:
/**
 * @class MyCallback
 *
 * The method names are firmly and must be overloaded to work
 */
class MyCallback extends Callback
{
 
	private $somevar;
 
	function __construct()
	{
		$this->somevar = "I'm private callback class var!";
	}
 
	/**
	 * @access public
	 * @param object $conversation
	 * @param string $who
	 * @param string $alias
	 * @param string $message
	 * @param integer $time
	 * @return void
	 *
	 */
	public function writeConv($conversation, $who, $alias, $message, $flags, $time)
	{
		if ($alias) {
			$name = $alias;
		} else if ($who) {
			$name = $who;
		} else {
			$name = NULL;
		}
 
		if(Conversation::MESSAGE_RECV == $flags) {
			printf(	"(%s) %s %s: %s\n",
					$conversation->getName(),
					date("H:i:s", $time),
					$name,
					$message
					);
			if(preg_match("/.*hello.*/i", strtolower($message)) ||
				preg_match("/.*hi.*/i", strtolower($message))) {
				$conversation->sendIM("hi there!\n");
			} else if(preg_match("/.*\/date.*/i", strtolower($message))) {
				$conversation->sendIM(shell_exec("date"));
			} else if(preg_match("/.*\/engine_version.*/i", strtolower($message))) {
				$conversation->sendIM("libpurple v" . Purple::getCoreVersion());
			} else if(preg_match("/.*\/show_var.*/i", strtolower($message))) {
				$conversation->sendIM($this->somevar);
			} else {
				$conversation->sendIM("sorry, i don't understand you!\n");
			}
		}
	}
}


Note, that the Purple::Callback is abstract and may not be instantiated. It contains all the callback methods, which can be implemented to be used internally by the purple object. The not implemented methods will simply not be called (in reality they does being called, but they are empty).

Instansiate a purple object and initalize libpurple is now possible:

PHP:
$client = new Purple( new MyCallback );
 
echo "Using libpurple v" . $client->getCoreVersion() . "\n";
 
if(!$client->initCore($ui_id)) {
	die("libpurple initialization failed\n");
}


Only one class instance of the Purple may exist at the same time. I'm asking me now, what has to happen if an other object is created in the same process?

Create account and bring it online:

PHP:
$account = new Account("someone@hotmail.com", "MSN");
$account->setPassword("password");
$account->setEnabled($ui_id, true);
 
$client->connectToSignal("signed-on");


This account must be accepted in yours one and your account must be accepted in it accordingly to rules of the respective im network.

Since libpurple is designed for ui clients, we can use the loop (which may be my temporary solution for this):

PHP:
purple_loop();


Save all the php code in the same dir where the extension was compiled in the file test.php and then run:

CODE:
user@host~# php -n -d extension_dir=./modules/ -d purple.debug_enabled=0 -f test_oop.php


Now the script gets online and if i start a conversation, i can see the answers from this small bot. Can you?


Posted by Anatol Belski in C/C++, Linux, PHP5, PHP5 extentions at 18:39 | Comments (20) | Trackbacks (0)

Trackbacks
Trackback specific URI for this entry

No Trackbacks

Comments
Display comments as (Linear | Threaded)

nice design.
likely
#1 alex on 2007-12-24 20:07 (Reply)
my reply-email is bounced by your server for some reason. You'll have to check pecl-dev manually
#2 Alexey Zakhlestin (Homepage) on 2007-12-25 11:34 (Reply)
I seem to be running into the issue:

"Fatal Error: Uncaught exception 'Exception' with message 'The callback object class must inherit from the Purple::Callback class' ... line 72"

This is on the latest PHP 5.3 build, phpurple compiled properly. Any reason this would be occurring?

- Anon.
#3 Anonymous on 2007-12-27 17:45 (Reply)
it's no issue, your callback class must inherit from the generic Purple::Callback class (to inherit it's methods).

By the way, i'm working on the new classes design so it will not be compatible with this design, so would have a sense to do something with the new design, no more with this
#3.1 Anatol Belski on 2007-12-28 15:54 (Reply)
nice one!

just tryed but had some trouble as i've php5.2 why are you on 5.3?
also, why is the hack with the inheritance needed?

would be great if the repository cointained a test.php so it's possible to try without too much hassle ;]

got this message:
** (process:29117): CRITICAL **: x509_tls_peers_init: assertion `ret == 0' failed
but if debug=1 the client connects and is able to get messages. well the purple :]

cheers,
f
#3.1.1 fatso on 2008-01-02 21:23 (Reply)
thanks for the interest

on php 5.2 we have no namespaces, so that piece of code isn't needed ...

we must inherit because of the callback methods ... so i they are implemented, the ext uses them ... in the new design the classes will inherit directly from the client class

so wait a couple of weeks till i've implemented the new design ...
#3.1.1.1 Anatol Belski (Homepage) on 2008-01-03 08:22 (Reply)
Hey,
First of all thanks for libpurple.

I downloaded phpurple, I configured it.
I have php 5.2.1, which doesn't have namespace support.
I Installed php 5.2.5 , which also doesnt have it.

How can I add namespace support to PHP ? Is there any patch available for it ?

Is there any other way (without use of namespaces) to run this script ?
#4 Jignesh (Homepage) on 2008-01-09 09:45 (Reply)
namespaces are supported starting from php5.3 ... don't use it with earlier versions
#4.1 Anatol Belski (Homepage) on 2008-01-09 11:08 (Reply)
I installed PHP 5.3.
Now I am running this script & Its giving me this output..


root@phpls6:/home/jignesh.patel/phpurple# php -n -d extension_dir=./modules/ -d purple.debug_enabled=0 -f test.php

Warning: dl(): purple: Unable to initialize module
Module compiled with module API=20060613, debug=0, thread-safety=0
PHP compiled with module API=20071006, debug=0, thread-safety=0
These options need to match
in /home/jignesh.patel/phpurple/test.php on line 4

Fatal error: Class 'Purple::Callback' not found in /home/jignesh.patel/phpurple/test.php on line 22
#4.1.1 Jignesh (Homepage) on 2008-01-09 12:05 (Reply)
Is the Problems in php 5.3 ? ,which I downloaded from this link..
http://snaps.php.net/

If this script working fine... than please send me your php 5.3 source package on...
jaggsr@yahoo.com or jaggsr@gmail.com
#4.1.2 Jignesh (Homepage) on 2008-01-09 12:25 (Reply)
the first thing - please checkout the revision previous to head because the new stuff there is not compatible with this article

you seem to compile or run with different php version

use something like this:

install php 5.3 in /usr/local/dev using

[bash]
ext# /usr/local/dev/bin/phpize

ext# ./configure --prefix=/usr/local/dev --exec-prefix=/usr/local/dev --with-libdir=/usr/local/dev/lib/ --with-php-config=/usr/local/dev/bin/php-config -enable-purple

ext# make

ext# /usr/local/dev/bin/php -n -d extension_dir=./modules/ -d purple.debug_enabled=0 -f test.php
[bash]
or use some other dir instead of /usr/local/dev
#4.1.2.1 Anatol Belski (Homepage) on 2008-01-09 14:38 (Reply)
Thanks for your support.
I reinstalled PHP 5.3
I Have compile phpurple according to your suggestions.

First 10 lines from my test.php are as below:

PHP Code:

1 if(!extension_loaded('purple')) {
2 dl('purple.' . PHP_SHLIB_SUFFIX);
3
4 use Purple::Purple;
5 use Purple::Account;
6 use Purple::Conversation;
7 use Purple::Connection;
8 use Purple::Callback;
9
10 $ui_id = "hello_world";

.
.
.
.
.


Now I am running it (and its giving me parse error) using:
root@phpls6://home/jignesh.patel/phpurple# /usr/local/dev/bin/php -n -d extension_dir=./modules/ -d purple.debug_enabled=0 -f test.php

Parse error: syntax error, unexpected T_USE in /home/jignesh.patel/phpurple/test.php on line 4
#4.1.2.1.1 Jignesh (Homepage) on 2008-01-10 09:24 (Reply)
Please Ignore / Delete Last reply.
I regret for it.

But problem is still there.
Can you provided me PHP 5.3 source (on which i can run your script succesfully ?)

Because the source which I have is not stable & giving lot of errors while 'make' step.
#4.1.2.1.2 Jignesh (Homepage) on 2008-01-11 05:52 (Reply)
Do you have php 5.2 sample code?

phpInfo shows purple is loaded, but
$client = new Purple(New MyCallback)

returns Class 'Purple' not found (using purple instead of Purple returns the same thing).

-Jason
#5 JasonR (Homepage) on 2008-02-21 11:13 (Reply)
You should take a look on the new oo design here : http://thinker.rubay.de/archives/11-phpurple-new-oo-design,.html

In general, now is the very alpha phase, where the changes can come unexpected in purpose for better functionality. A couple of weeks ago i've stopped to update the sf.net's subversion, because the trunk becomes very fast to be not this article conform.

So, the best way for you would be to look into the php_purple.h file, where all the at the moment existing class methods are listed.

I'm planing an alpha release in a couple of weeks, and I'll release some docs and new example for this.
#5.1 Anatol Belski (Homepage) on 2008-02-23 17:27 (Reply)
Is there anyway you could compile the binaries for windows? I'd be willing to pay for it
#6 Teddy on 2008-06-23 13:24 (Reply)
Actually I've a lack of time and no windows, to do this. But anyway, I'm still planing to make windows builds in indefinite future.
#6.1 Anatol Belski (Homepage) on 2008-06-24 19:48 (Reply)
You can compile your own with the source code using a C/C++ compiler like Visual Studio

This page shows you how to make a php DLL extension using Visual C++ Express 2008(free version)

http://geeks.netindonesia.net/blogs/risman/archive/2008/06/15/part-2-writing-php-extension.aspx

I tried compiling it, but PHP doesn't seem to initialize it correctly.
#6.2 Stanislav Palatnik (Homepage) on 2008-07-02 16:00 (Reply)
While installing PHurple I am getting error "checking for purple files in default path... not found", I have pasted the command line code and response.. Please help


phpize && ./configure --enable-phurple && make && make installclear
Configuring for:
PHP Api Version: 20041225
Zend Module Api No: 20060613
Zend Extension Api No: 220060519
checking for grep that handles long lines and -e... /bin/grep
checking for egrep... /bin/grep -E
checking for a sed that does not truncate output... /bin/sed
checking for gcc... gcc
checking for C compiler default output file name... a.out
checking whether the C compiler works... yes
checking whether we are cross compiling... no
checking for suffix of executables...
checking for suffix of object files... o
checking whether we are using the GNU C compiler... yes
checking whether gcc accepts -g... yes
checking for gcc option to accept ISO C89... none needed
checking whether gcc and cc understand -c and -o together... yes
checking for system library directory... lib
checking if compiler supports -R... no
checking if compiler supports -Wl,-rpath,... yes
checking build system type... i686-pc-linux-gnu
checking host system type... i686-pc-linux-gnu
checking target system type... i686-pc-linux-gnu
checking for PHP prefix... /usr
checking for PHP includes... -I/usr/include/php -I/usr/include/php/main -I/usr/include/php/TSRM -I/usr/include/php/Zend -I/usr/include/php/ext -I/usr/include/php/ext/date/lib
checking for PHP extension directory... /usr/lib/php/modules
checking for PHP installed headers prefix... /usr/include/php
checking for re2c... re2c
checking for re2c version... 0.12.3 (ok)
checking for gawk... gawk
checking whether to enable phurple support... yes, shared
checking for glib files in default path... found in /usr
checking for g_hash_table_new in -lglib-2.0... yes
checking for purple files in default path... not found
configure: error: Please reinstall the phurple distribution
#7 Anup Singh on 2009-01-06 09:27 (Reply)
Hi

I am using this lib purple to integrate the all Messengers in the web. So i have installed and configured in my server and it's working fine. I can able to send and receive the message for all IM Networks. I have read the purple documentation and used the PhurpleBuddy::isOnline method to check the whether the buddy is in online or not. But it's not working . Now i wondering to know the method name to display the Online Buddy list for all the IM networks. And also i have tried to display the chat messages in the User Interface for that i am not able to get the post data in the following class

class CustomPhurpleClient extends PhurpleClient

can any one help to achieve the above things. Looking forward for the reply. Thanks in advance.
#8 Balamurugan on 2009-04-18 07:34 (Reply)

Add Comment

Standard emoticons like :-) and ;-) are converted to images.
E-Mail addresses will not be displayed and will only be used for E-Mail notifications.
BBCode format allowed
BBCode format allowed
 
Submitted comments will be subject to moderation before being displayed.
 

Quicksearch

Categories

Archives