ejabberd - Comments for "Using mod_rest to update the roster"

Hi please can you help how to

varunjoshi919 — Wed, 16 Dec 2015 14:20:54 +0000

Hi please can you help how to configured mod_rest and mod_admin_extra in my ubuntu machine

Hi i want to make friend on

varunjoshi919 — Wed, 16 Dec 2015 13:53:24 +0000

Hi i want to make friend on ejabberd using php code & for this i use this command Install mod_admin_extra to install roster on my ubuntu machine it shows command not found,please help me,Thanks in Advance.

XMPP Domain

mfoss — Tue, 04 Jan 2011 15:49:21 +0000

nouralk wrote:

$file = file_get_contents("http://ejabberd.ip.address.here:5280/rest/", false, $context);

Instead of IP address, put the XMPP domain (im.mysite.com). If that still fails, then describe what ejabberd and mod_rest versions you use.

add_rosteritem not working from external script

nouralk — Sun, 02 Jan 2011 10:51:01 +0000

i installed mod_admin_extra, and am trying to add 2 users to each other user , when i try from shell its working perfectly, but when i try to call it from an external php script its not working, same happens using TCL script, here is what i get in my error log:

=INFO REPORT==== 2011-01-02 10:02:27 ===
I(<0.356.0>:ejabberd_listener:232) : (#Port<0.1687>) Accepted connection {{my,ip,address,here},37081} -> {{ejabberd,ip,address,here},5280}
=INFO REPORT==== 2011-01-02 10:02:27 ===
D(<0.1108.0>:ejabberd_http:135) : S: [{["rest"],mod_rest},
                                      {["admin"],ejabberd_web_admin},
                                      {["http-bind"],mod_http_bind}, 
                                      {["http-poll"],ejabberd_http_poll}]
=INFO REPORT==== 2011-01-02 10:02:27 ===
I(<0.1108.0>:ejabberd_http:137) : started: {gen_tcp,#Port<0.1687>}
=INFO REPORT==== 2011-01-02 10:02:27 ===
D(<0.1108.0>:ejabberd_http:254) : (#Port<0.1687>) http query: 'POST' /rest/
=INFO REPORT==== 2011-01-02 10:02:27 ===
D(<0.1108.0>:ejabberd_http:420) : client data: "add_rosteritem anna im.mysite.com karen im.mysite.com someOne Friends both"
=INFO REPORT==== 2011-01-02 10:02:27 ===
D(<0.1108.0>:ejabberd_http:323) : ["rest"] matches ["rest"]
=INFO REPORT==== 2011-01-02 10:02:27 ===
I(<0.1108.0>:mod_rest:92) : Data: "add_rosteritem anna im.mysite.com karen im.mysite.com someOne Friends both"
=INFO REPORT==== 2011-01-02 10:02:27 ===
D(<0.1108.0>:mod_rest:58) : Error when processing REST request:
Data: "add_rosteritem anna im.mysite.com karen im.mysite.com someOne Friends both"
Error: {badmatch,false}

here is the php script i tried:

<?php
$param=array("user"=>"admin", "host"=>"ejabberd.ip.address.here");
$request = "add_rosteritem anna im.mysite.com karen im.mysite.com someOne Friends both";
$context = stream_context_create(array('http' => array(
   'method' => "POST",
   'header' => "Content-Type: text/xml\r\n" .
               "Content-Length: ".strlen($request),
   'content' => $request
)));
$file = file_get_contents("http://ejabberd.ip.address.here:5280/rest/", false, $context);
echo $file;
/*$response = xmlrpc_decode($file);
if (xmlrpc_is_fault($response)) {
   trigger_error("xmlrpc: $response[faultString] ($response[faultCode])");
} else {
   print_r($response);
}
*/
?>

What am i doing wrong? can anyone advise me?

Return at least the code

mfoss — Mon, 06 Dec 2010 18:21:27 +0000

With this change, when the response contains no text, at least the status code number is returned, and doesn't return 500 in case of response==false:

--- src/mod_rest.erl    (revision: 1099)
+++ src/mod_rest.erl    (copia de trabajo)
@@ -93,10 +93,14 @@
     Args = split_line(Data),
     AccessCommands = get_option_access(Host),
     case ejabberd_ctl:process2(Args, AccessCommands) of
+       {"", ?STATUS_SUCCESS} ->
+           {200, [], integer_to_list(?STATUS_SUCCESS)};
        {String, ?STATUS_SUCCESS} ->
            {200, [], String};
+       {"", Code} ->
+           {200, [], integer_to_list(Code)};
        {String, _Code} ->
-           {500, [], String}
+           {200, [], String}
     end.

 %% This function throws an error if the module is not started in that VHost.

Try it and tell me if that solves the problem, and it's worth including in SVN.

Return codes

synack — Wed, 01 Dec 2010 10:51:15 +0000

I'm having issues with the way ejabberdctl returns error codes.

If I run a command like

ejabberdctl check_account garth localhost

and the account exists, nothing is returned. To actually check the error code, I have to do

echo $?

If the account exists, it returns a 0, if it doesn't exist, it reutrns a 1. Nevermind the fact that the error codes seem the wrong way around, I have no way of checking these codes when doing a POST to the server in php, using a function as outlined above.

It seems to me, if using the check account exmaple, that if I do a post and the account doesn't exist, then the fopen fails, if it does exist, then the fopen succeeds, but no content is returned.

The problem with this is, I have no way of knowing the difference between the actual post failing or the account simply not existing.

Is there another way I can communicate with the server and actually get the return codes back?

Try recent SVN and look at logs

mfoss — Wed, 04 Aug 2010 09:03:06 +0000

salin wrote:

when I tried through PHP client, I'm getting the following error.

2010-08-02 18:38:00 ERROR 406: Not Acceptable.

The problem happens when processing your request, maybe it lacks some argument, or the arguments are wrongly formatted, or escaped.

I've added some debug lines to mod_rest in SVN. You can download it, recompile, install, configure {loglevel, 5} in ejabberd.cfg, start ejabberd, make your request, and then search in the log files for the word "REST".

able to add_rosteritem using ejabberdctl but not with mod_rest.

salin — Tue, 03 Aug 2010 00:04:31 +0000

Hi,

I have configured mod_rest and mod_admin_extra.
I am able to do following command using shell:
ejabberdctl add_rosteritem ashley ashley garth ashley garth Buddies both

but when I tried through PHP client, I'm getting the following error.

Resolving mydomain.net... xxx.xxx.xxx.xxx
Connecting to mydomain.net|xxx.xxx.xxx.xxx|:5280... connected.
HTTP request sent, awaiting response...
HTTP/1.0 406 Not Acceptable
Connection: keep-alive
Content-Type: text/html; charset=utf-8
Content-Length: 43
2010-08-02 18:38:00 ERROR 406: Not Acceptable.

Could you please point out what else I need to configure?

Best Regards,
Sa Lin

Ok, I've update the code in

mfoss — Thu, 15 Apr 2010 10:11:43 +0000

Ok, I've update the code in the README.

Streamlined sendRESTRequest function for PHP4 as well as PHP5

qu1cksand — Wed, 14 Apr 2010 14:57:13 +0000

I have streamlined the sendRESTRequest function so that it can support PHP5 using file_get_contents and implement the alternative solution for PHP4:

function sendRESTRequest ($url, $request) {
    // Create a stream context so that we can POST the REST request to $url
    $context = stream_context_create (array ('http' => array ('method' => 'POST'
                                            ,'header' => "Content-Length: ".strlen($request)
                                            ,'content' => $request)));

    // Use file_get_contents for PHP 5+ otherwise use fopen, fread, fclose
    if (version_compare(PHP_VERSION, '5.0.0', '>=')) {
        $result = file_get_contents($url, false, $context);
    } else {
        // This is the PHP4 workaround which is slightly less elegant
        // Supress fopen warnings, otherwise they interfere with the page headers
        $fp = @fopen($url, 'r', false, $context);
        $result = '';

        // Only proceed if we have a file handle, otherwise we enter an infinite loop
        if ($fp) {
            while(!feof($fp)) {
                $result .= fread($fp, 4096);
            }
            fclose($fp);
        }
    }

    return $result;
}

example for mod_rest only works in PHP 5 - example in PHP 4

qu1cksand — Tue, 13 Apr 2010 15:56:15 +0000

Thanks for adding the example PHP code to the mod_rest README.txt.

Unfortunately the example PHP code only works in PHP 5 but does not work in PHP 4.

It would be better to change the sendRESTRequest function as follows in order for the example code to work in both PHP 4 and PHP 5.

function sendRESTRequest ($url, $xml) {
    $context = stream_context_create(
         array('http' =>
                        array(
                                'method' => "POST",
                                'header' => "Content-Length: ".strlen($xml),
                                'content' => $xml
                        )
            )
    );
    $fp = fopen($url, 'r', false, $context);
    $response = '';
    while(!feof($fp)) {
        $response .= fread($fp, 4096);
    }
    fclose($fp);
    echo "Response: $response\n";
    return $response;
}

Oh, but in that case it's

mfoss — Tue, 13 Apr 2010 11:52:25 +0000

Oh, but in that case it's necessary to parse the response to know if there was any error. I'll keep the code as it is now.

I've added your example PHP code to mod_rest README.txt

Update the HTTP status code in mod_rest.erl from 500 to 200

qu1cksand — Tue, 13 Apr 2010 10:35:40 +0000

If you update the HTTP status code on line 93 of mod_rest.erl from 500 (Internal Server Error) to 200 (OK), then the correct message will be displayed in Python as well as PHP.

This is problem with mod_rest not PHP

qu1cksand — Mon, 12 Apr 2010 15:43:03 +0000

This is problem is generic to mod_rest and not a problem with PHP.

If you execute the same command in Python, you get the same result:

$ python rest.py 
Traceback (most recent call last):
  File "rest.py", line 16, in 
    resp = urllib2.urlopen(server_url, call)
  File "/usr/lib/python2.6/urllib2.py", line 124, in urlopen
    return _opener.open(url, data, timeout)
  File "/usr/lib/python2.6/urllib2.py", line 395, in open
    response = meth(req, response)
  File "/usr/lib/python2.6/urllib2.py", line 508, in http_response
    'http', request, response, code, msg, hdrs)
  File "/usr/lib/python2.6/urllib2.py", line 433, in error
    return self._call_chain(*args)
  File "/usr/lib/python2.6/urllib2.py", line 367, in _call_chain
    result = func(*args)
  File "/usr/lib/python2.6/urllib2.py", line 516, in http_error_default
    raise HTTPError(req.get_full_url(), code, msg, hdrs, fp)
urllib2.HTTPError: HTTP Error 500: Internal Server Error

More changes in PHP, and last problem

mfoss — Mon, 12 Apr 2010 15:21:11 +0000

Ok, I made some progress. In fact I don't need the allowed_ips option. Then, in the PHP code I changed the array code to indicate explicitely the Host header:

array(
  'method' => "POST",
  'header' => "Host: localhost:5280\nContent-Type: text/html; charset=utf-8",
  'content' => $xml
)

Now I can call:

$ php aa.php
file:[User user12@localhost succesfully registered]

The only problem is that, when there is some error returned, the PHP code doesn't show the exact error reason:

$ php aa.php
PHP Warning:  file_get_contents(http://127.0.0.1:5280/rest):
failed to open stream:
HTTP request failed!
HTTP/1.0 500 Internal Server Error
 in /modules/mod_rest/trunk/aa.php on line 12

file:[]

It's only seen in the network traffic:

HTTP/1.0 500 Internal Server Error
Connection: close
Content-Type: text/html; charset=utf-8
Content-Length: 65

User user12@localhost already registered at node ejabberd@galleta