Event handler or Function hook for AddonDomain and Mysql actions

Hi,

I want to create an event handler that would be called on a couple of different events:

- add on domain created/deleted
- mysql user created/deleted
- mysql db created/deleted

These events would call an external API donig a regular get/post web request.

Can you guys please advise on how I can get started, where I put the files, how I tell cpanel to hook into my files, etc ?

The documentation is a little convoluted and hard to understand in this regard.

Thanks

 

oh thank god, i *hate* writing perl scripts

 

so If I want to create one for Adding and Removing of a domain I am guessing it would be

/usr/local/cpanel/hooks/AddonDomain/addaddondomain
/usr/local/cpanel/hooks/AddonDomain/deladdondomain

??

In this xml sample on that site
Function Hooks

PHP:

<xml>
    <cpanelevent>
        <errors></errors>
        <event>addpop</event>
        <module>email</module>
        <params>
            <param0>emailuser</param0>
            <param1>emailpassword</param1>
            <param2>250</param2>
            <param3>testdomain.com</param3>
        </params>
    </cpanelevent>
    <CPDATA>
        <DOMAIN>testdomain.com</DOMAIN>
        <USER>testdoma</USER>
    </CPDATA>
</xml>


its specifically for email accounts - but I am guessing that the CPDATA nodes will always be there for any action - but the cpanelevent nodes will be different each time right?

is there a way to get a list of what nodes will come back, what paramaters are passed in, in what order so that I can properly get the values and create an association?

Is it safe to assume that if there is nothing in the errors node that the request was successfull - or will it always be sucessfull if it gets to this point and calls my hook ?

PHP:

    $xml = "";
    
    //read in STDIN and convert to XML String
    $stdin_fh = fopen('php://stdin', 'r');
    while ($line = fgets( $stdin_fh )) {
        $xml .= $line;
    }
    fclose($stdin_fh);

    /*
    <xml>
        <cpanelevent>
            <errors></errors>
            <event>addpop</event>
            <module>email</module>
            <params>
                <param0>emailuser</param0>
                <param1>emailpassword</param1>
                <param2>250</param2>
                <param3>testdomain.com</param3>
            </params>
        </cpanelevent>
        <CPDATA>
            <DOMAIN>testdomain.com</DOMAIN>
            <USER>testdoma</USER>
        </CPDATA>
    </xml>
    */    

    $xml_string = new SimpleXMLElement($xml);
    $eventName = $xml_string->xml->cpanelevent->event;
    $moduleName = $xml_string->xml->cpanelevent->module;
    $param0 = $xml_string->xml->cpanelevent->params->param0;
    $param1 = $xml_string->xml->cpanelevent->params->param1;
    $param2 = $xml_string->xml->cpanelevent->params->param2;
    $param3 = $xml_string->xml->cpanelevent->params->param3;



 

it doesnt seem to work - I took the change_password.example and renamed it to change_password and made sure it was set to 0755

I then put some code in it that creates a log file and dumps the XML to the file, and prints some value

the log file does not get created and nothing gets written to the page.

If I run the file manually it does create the log file although its empty becuase it gets stuck in reading the STDIN since I dont know how to manipulate that or send it data, but if I comment that and put in static XML and run the file manually it does work as expected - but it does *not* appear to being called from the cpanel when a user changes their password.

 

David,

Thanks for the reply - I feel like a dolt now missing something so simple. That was teh culprit

Additionally it also output'ed

Code:

X-Powered-By: PHP/5.2.14 Content-type: text/html 

to the page as well - can I not have it do that ?

 

The xpowered by is showin up in the control panel, as the script being called does an echo or print like in the example change password file - it appears that if I set expose php to off it gets rid of the powered by, but the content type still shows up.

Everything else I got working, but now I need to try and do the mysql ones which are using the API1 - based on your last response that may prove to be a little harder

oh and btw - you can call me w/e you want :D

 

So I created teh hooks and they do the same thing as the others, log to a file and make an external call.

Unfortunately these dont seem to be doing either of those things - additionally when I change password, do an addon domain, etc the pages take a little while becuase of that external call - however the db pages are exteremely quick, so I dont think its calling anything there either.

They did get registered

Code:

# /usr/local/cpanel/bin/register_hooks
Registered hook addondomain::addaddondomain
Registered hook addondomain::deladdondomain
Registered hook passwd::change_password
Registered hook mysql::adddb
Registered hook mysql::deluser
Registered hook mysql::deldb
Registered hook mysql::adduser
Registered 7 hooks

when I go to /frontend/x3/sql/addb.html and try and add a new db, delete that db, create a user and then add that user to the db and then delete the user it doesnt seem to call the mysql::* hooks as it doesnt write the files, and it doesnt throw any errors on the page (like it would if the log file directory doesnt exist for example)

any ideas ?

Code:

#pwd
/var/log/mylog
#ls -la hooks/*

hooks/addaddondomain:
total 8
drwxr-xr-x 2 root root 4096 Sep  3 11:03 .
drwxr-xr-x 9 root root 4096 Sep  3 11:02 ..
-rw-r--r-- 1 root wheel 1506 Sep  3 11:07 log-09-03-2010

hooks/adddb:
total 8
drwxr-xr-x 2 root root 4096 Sep  3 11:01 .
drwxr-xr-x 9 root root 4096 Sep  3 11:02 ..

hooks/adduser:
total 8
drwxr-xr-x 2 root root 4096 Sep  3 11:02 .
drwxr-xr-x 9 root root 4096 Sep  3 11:02 ..

hooks/deladdondomain:
total 8
drwxr-xr-x 2 root root 4096 Sep  3 11:03 .
drwxr-xr-x 9 root root 4096 Sep  3 11:02 ..
-rw-r--r-- 1 root wheel 1566 Sep  3 11:08 log-09-03-2010


hooks/deldb:
total 8
drwxr-xr-x 2 root root 4096 Sep  3 11:02 .
drwxr-xr-x 9 root root 4096 Sep  3 11:02 ..

hooks/deluser:
total 8
drwxr-xr-x 2 root root 4096 Sep  3 11:02 .
drwxr-xr-x 9 root root 4096 Sep  3 11:02 ..

hooks/passwd:
total 8
drwxr-xr-x 2 root root 4096 Sep  3 10:14 .
drwxr-xr-x 9 root root 4096 Sep  3 11:02 ..

 

Thanks, I was able to get it working - I deleted and recreated the file and for some reason that fixed it, so it must have been a problem with the file somehow.