Hook for post account creation

snewton · Sep 21, 2021

I'm trying to create a hook that will enable CloudLinux Reseller Limits and set the limits for the reseller account when it is created and uses a specific reseller plan/package.

This is what I have but it is not working:

Code:

#!/usr/local/cpanel/3rdparty/bin/perl

package NewAccountHook;

use strict;
use warnings;

sub describe {
    my $hook = {
        'category' => 'Whostmgr',
        'event' => 'Accounts::Create',
        'stage' => 'post',
        'hook' => 'NewAccountHook::actions',
        'exectype' => 'module',
    };
    return $hook;
}

sub actions {

    my ( $context, $data ) = @_;
    my $user = $data->{'user'};
    my $plan = $data->{'plan'};

if ( $plan eq 'Reseller Plan 1' ) {
    system`/sbin/cloudlinux-limits enable-reseller-limits --reseller-name $user --json`;
    system`/sbin/cloudlinux-limits set --reseller-name $user --speed=100% --pmem=3G --nproc=200 --maxEntryProcs=30 --iops=5024 --io=100MB/s --json`;
} elsif ( $plan eq 'Reseller Plan 2' ) {
    system`/sbin/cloudlinux-limits enable-reseller-limits --reseller-name $user --json`;
    system`/sbin/cloudlinux-limits set --reseller-name $user --speed=150% --pmem=5G --nproc=200 --maxEntryProcs=50 --iops=7024 --io=250MB/s --json`;
} else {
   # Executes when the none of the above condition is true
}


}

1;

I've created other cPanel hooks, so I have the basics and it is created correctly in hooks, etc.

Perl is definitely not my expertise, so I'm struggling to get this to work.

Any help would be awesome!

Thanks!

snewton · Sep 21, 2021

I did some more searching and I found:

https://features.cpanel.net/topic/reseller-modification-hook

So it appears that post account creation hooks do not include reseller accounts, so I'm essentially whipping a dead horse on this?

cPRex · Sep 22, 2021

Hey there! That feature request you found is correct as the hooks do not currently work for resellers. I did reach out to our Accounts team and they confirmed this isn't something that is doable at the moment, although they are aware of the feature request.

snewton · Sep 22, 2021

cPRex said:
Hey there! That feature request you found is correct as the hooks do not currently work for resellers. I did reach out to our Accounts team and they confirmed this isn't something that is doable at the moment, although they are aware of the feature request.

So no workaround for this?

If not, then it looks like CloudLinux needs to update their documentation:

https://cloudlinux.zendesk.com/hc/en-us/articles/115005515269-CloudLinux-Reseller-Limits-FAQ#q45

cPRex · Sep 22, 2021

That does seem out of date as it's pointed to our older documentation site as well, where the new data is now at cPanel & WHM Developer Portal · cPanel & WHM Developer Portal for API calls and cPanel & WHM Documentation | cPanel & WHM Documentation for the standard documentation.

snewton · Sep 22, 2021

cPRex said:
That does seem out of date as it's pointed to our older documentation site as well, where the new data is now at cPanel & WHM Developer Portal · cPanel & WHM Developer Portal for API calls and cPanel & WHM Documentation | cPanel & WHM Documentation for the standard documentation.

Why cPanel hooks are ran prior to reseller permissions being added during account creation makes no sense.

I must say that I really find it annoying that I got this to work with a hook on our DirectAdmin servers quite easily, but can't get it to work on cPanel (the control panel that costs me 10x more).

snewton · Sep 23, 2021

I had an idea for a work around for this, but during testing the "$plan" doesn't seem to be working.

I came across the event "Whostmgr::Resellers::setup".

Any idea if that would achieve what I need?

Basically, if a reseller account is created, I want the ability to automatically assign specific CloudLinux Reseller Limits to that reseller account.

There simply has to be a way to achieve this with cPanel.

snewton · Sep 23, 2021

Perhaps @cPanelTJ can suggest something or point me in the right direction?

cPRex · Sep 23, 2021

He is who I really want to poke as he is the API/hook master, but he's out this week.

snewton · Sep 23, 2021

cPRex said:
He is who I really want to poke as he is the API/hook master, but he's out this week.

Ahhh! Thanks, cPRex. I will try harassing him next week then. Hopefully he can shed some light on this and point me in the right direction.

cPRex · Sep 23, 2021

I have this open as a reminder to poke him as well!

snewton · Sep 27, 2021

Just to update, I've been working with CloudLinux support regarding this and the correct command to use for enabling Reseller Limits for an account, so I am using the following code:

Code:

#!/usr/local/cpanel/3rdparty/bin/perl

package ResellerLimits;

use strict;
use warnings;

sub describe {
    my $hook = {
        'category' => 'Whostmgr',
        'event' => 'Accounts::Create',
        'stage' => 'post',
        'hook' => 'ResellerLimits::actions',
        'exectype' => 'module',
    };
    return $hook;
}

sub actions {

    my ( $context, $data ) = @_;
    my $user = $data->{'user'};
    my $plan = $data->{'plan'};

if ( $plan == 'Reseller Plan 1' ) {
    system`lvectl set-reseller $user --speed='100%' --pmem=3G --nproc=200 --maxEntryProcs=30 --iops=5024 --io=102400`;
} elsif ( $plan == 'Reseller Plan 2' ) {
    system`lvectl set-reseller $user --speed='150%' --pmem=5G --nproc=200 --maxEntryProcs=50 --iops=7024 --io=256000`;
} elsif ( $plan == 'Reseller Plan 3' ) {
    system`lvectl set-reseller $user --speed='200%' --pmem=6G --nproc=200 --maxEntryProcs=60 --iops=10024 --io=358400`;
} elsif ( $plan == 'Reseller Plan 4 ' ) {
    system`lvectl set-reseller $user --speed='250%' --pmem=4G --nproc=200 --maxEntryProcs=40 --iops=10024 --io=204800`;
} else {
   # Do nothing
}


}

1;

However, it still does not work.

snewton · Sep 30, 2021

@cPanelTJ, have you had a chance to look at this issue?

cPRex · Sep 30, 2021

We definitely haven't forgot about this and we're still doing some testing on our end.

cPanelTJ · Oct 1, 2021

snewton said:
Just to update, I've been working with CloudLinux support regarding this and the correct command to use for enabling Reseller Limits for an account, so I am using the following code:

...

However, it still does not work.

@snewton

My apologies for the delay in response. It has been quite a week playing catch-up as we're working on a lot of new, cool things right now.

I wasn't able to fully finish reproducing your issue as I'm not exceptionally proficient with CloudLinux and lvectl, but one problem that jumps out to me immediately is that your perl operator for comparing $plan to the account's package is incorrect. In perl, `==` is meant for numerical comparisons. For string comparisons, `eq` should be used.

Here is a resource with some good examples: Perl | Comparing Scalars - GeeksforGeeks

If this doesn't work, you can turn on Standardized Hooks - Debug Mode (level 4) in WHM -> Tweak Settings, then you can watch the error_log in a split/separate terminal window (tail -F /usr/local/cpanel/logs/error_log) to confirm that your hook triggers when you create a new account.

snewton · Oct 1, 2021

cPanelTJ said:
@snewton

My apologies for the delay in response. It has been quite a week playing catch-up as we're working on a lot of new, cool things right now.

I wasn't able to fully finish reproducing your issue as I'm not exceptionally proficient with CloudLinux and lvectl, but one problem that jumps out to me immediately is that your perl operator for comparing $plan to the account's package is incorrect. In perl, `==` is meant for numerical comparisons. For string comparisons, `eq` should be used.

Here is a resource with some good examples: Perl | Comparing Scalars - GeeksforGeeks

If this doesn't work, you can turn on Standardized Hooks - Debug Mode (level 4) in WHM -> Tweak Settings, then you can watch the error_log in a split/separate terminal window (tail -F /usr/local/cpanel/logs/error_log) to confirm that your hook triggers when you create a new account.

I originally used "eq" and that didn't work either.

I just tried using the following:

Code:

#!/usr/local/cpanel/3rdparty/bin/perl

package ResellerLimits;

use strict;
use warnings;

sub describe {
    my $hook = {
        'category' => 'Whostmgr',
        'event' => 'Accounts::Create',
        'stage' => 'post',
        'hook' => 'ResellerLimits::actions',
        'exectype' => 'module',
    };
    return $hook;
}

sub actions {

    my ( $context, $data ) = @_;
    my $user = $data->{'user'};
    my $plan = $data->{'plan'};

if ( $plan eq 'Reseller Plan 1' ) {
    system`echo "Test succeeded" >> /usr/local/cpanel/test.txt`;
} else {
    system`echo "Test failed" >> /usr/local/cpanel/test.txt`;
}


}

1;

The above should write to the file test.txt with either succeeded or failed after account creation and instead the file test.txt is empty after account creation, so something is not right.

cPanelTJ · Oct 4, 2021

Are you getting any error spew from the hook module when you call whmapi1 createacct over CLI?

What directory is your hook in?

Is it registering properly through the manage_hooks script without error?

snewton · Oct 4, 2021

cPanelTJ said:
Are you getting any error spew from the hook module when you call whmapi1 createacct over CLI?

What directory is your hook in?

Is it registering properly through the manage_hooks script without error?

No error is shown when creating an account via CLI.

The hook .pm file has the correct permissions and is in: /usr/local/cpanel/

The hook is properly registered with no errors. (I've tried deleting and re-adding it several times trying to debug the issue)

snewton · Oct 6, 2021

Any word on this?

cPanelTJ · Oct 7, 2021

Hi @snewton ,

The script is working for me in /usr/local/cpanel and in /user/local/cpanel/hooks.

Here is my code from ULC:

Perl:

#!/usr/local/cpanel/3rdparty/bin/perl

package ResellerTest;

use strict;
use warnings;

sub describe {
    my $hook = {
        'category' => 'Whostmgr',
        'event' => 'Accounts::Create',
        'stage' => 'post',
        'hook' => 'ResellerTest::actions',
        'exectype' => 'module',
    };
    return $hook;
}

sub actions {

    my ( $context, $data ) = @_;
    my $user = $data->{'user'};
    my $plan = $data->{'plan'};

if ( $plan eq 'Package with Spaces' ) {
    system`echo "FROM ULC Test succeeded for User: $user and Plan: $plan" >> /usr/local/cpanel/test.txt`;
 } else {
    system`echo "Test failed FROM ULC" >> /usr/local/cpanel/test.txt`;
 }

}

1;

Here is my output to the test.txt file:

Code:

FROM ULC Test succeeded for User: delete13me and Plan: Package with Spaces

Thread starter	Similar threads	Forum	Replies	Date
M	uucp post hooks not running	Developer Experience	4	Feb 4, 2020
D	Standardized hook - Retrieve PostURL	Developer Experience	5	Jul 9, 2019
	[Resolved] Are Hooks Recursive (ex. postwwwacct) ?	Developer Experience	1	Dec 2, 2013
E	Accounts::Create post hook homedir?	Developer Experience	4	Nov 28, 2012
P	Custom POST variables in scripts/standardized WHM Hooks	Developer Experience	2	Jan 10, 2012

Hook for post account creation

Active Member

Active Member

Jurassic Moderator

Active Member

Jurassic Moderator

Active Member

Active Member

Active Member

Jurassic Moderator

Active Member

Jurassic Moderator

Active Member

Active Member

Jurassic Moderator

Product Owner

Active Member

Product Owner

Active Member

Active Member

Product Owner