SOLVED Can't locate Cpanel/Logger.pm

Hi All,

I've created a hook.pm that automates some of the things I do after I create a cPanel account. It compiled and registered without issue.

However, when I create an account, none of the actions are completed. So I need to trace through my code to see whats going on.

I tried to add the cPanel::Logger module, but get a compile error:

Can't locate Cpanel/Logger.pm in @INC (@INC contains: /usr/local/lib64/perl5 /usr/local/share/perl5 /usr/lib64/perl5/vendor_perl /usr/share/perl5/vendor_perl /usr/lib64/perl5 /usr/share/perl5 .)

I tried sudo yum install perl-Logger since it worked for the JSON.pm that I also needed, but that didn't work.

I also checked WHM>>Software>>Install a Perl Module, but it wasn't there either.

Any ideas?

 

kdub - Thanks for your quick reply.

I think my problem is that perl -c is not looking in /usr/local/cpanel/Cpanel for Cpanel::Logger.

Code:

[[email protected] ~]# perl -c /usr/local/cpanel/OnCreate.pm
Can't locate Cpanel/Logger.pm in @INC (@INC contains: /usr/local/lib64/perl5 /usr/local/share/perl5 /usr/lib64/perl5/vendor_perl /usr/share/perl5/vendor_perl /usr/lib64/perl5 /usr/share/perl5 .) at /usr/local/cpanel/OnCreate.pm line 12.

At any rate, it fails perl -c, but it does let me register the hook.

Code:

[[email protected] ~]# /usr/local/cpanel/bin/manage_hooks add module OnCreate
Added hook for Whostmgr::Accounts::Create to hooks registry
[[email protected] ~]# /usr/local/cpanel/bin/manage_hooks list
Whostmgr:
        Accounts::Create:
                stage: post
                weight: 100
                exectype: module
                hook: OnCreate::add
                blocking: 0
                id: Na5nNZBe5nFJzvaakxq1OYKw

Still no luck actually getting the hook to work. When I access the error log

Code:

[[email protected] ~]# nano /usr/local/cpanel/logs/error_log

I get

Code:

[2019-04-25 15:06:02 -0400] warn [whostmgr5] Can't call method "uapi" on an undefined value at /usr/local/cpanel/OnCreate.pm line 44.

That correlates to this block of code:

Code:

# Create the [email protected] email address.
    my $new_support_email = $cpliveapi->uapi(
        'Email', 'add_pop',
        {
            'email'           => 'support',
            'password'        => '********',
            'quota'           => '0',
            'skip_update_db'  => '1',
        }
    );

Earlier in the code I have:

Code:

# LiveAPI module
use LiveAPI;

# Connect to cPanel - only do this once.
my $cpliveapi = Cpanel::LiveAPI->new(); 

Not sure why I am getting that error since all required parameters are there.

 

Thanks for all the help so far. I've spent a lot of time reading the documentation and searching for examples on the web but am also turning up empty handed.

If you can't use LiveAPI Perl Modules from hooks, what version of the UAPI should a person use? Or you can't use UAPI at all?

I figured since the hook was a Perl Module, LiveAPI Perl Modules would make sense. But again, this is my first time making one. And it did seem too easy at the beginning...

Here is what I am trying to do with a post account create hook:

• Compress website data
• Create a database
• Create a database user
• Set user privileges for database
• Create [email protected] email
• Encrypt that email
• Create [email protected] email
• Encrypt that email

This was my first pass at creating the hook Perl Module. I basically copied and pasted from the documentation and added the LiveAPI functions for each of the above in the #insert your actions here.

Code:

# Package this module.
package AcctCreationHook;

# Return errors if Perl experiences problems.
use strict;
use warnings;

# Properly decode JSON.
use JSON;

# LiveAPI module
use LiveAPI;

# Embed hook attributes alongside the action code.
sub describe {
    my $my_add = {
        'category' => 'Whostmgr',
        'event'    => 'Accounts::Create',
        'stage'    => 'post',
        'hook'     => 'AcctCreationHook::add',
        'blocking' => 0,
        'exectype' => 'module',
    };
 
    return [ $my_add ];
}

sub add {
    # Get the data that the system passes to the hook.
    my ( $context, $data ) = @_;              
 
    # Set success and failure messages.
    my $result  = 0;                             # This Boolean value is set to fail.  
    my $message = 'This is an error message.';   # This string is a reason for $result.
   
    # Connect to cPanel - only do this once.
    my $cpliveapi = Cpanel::LiveAPI->new();
   
    # Compress website data
    # This is commented out because it is causing a compile error
    # my $configure_mod_deflate = $cpliveapi->api1(OptimizeWS, optimizews ['all', 'text/html',]);
   
    # Create a new database.
    my $create_db = $cpliveapi->uapi(
        'Mysql', 'create_database',
        {
            'name'    => 'wp500',
        }
    );
   
    # Create a new database user.
    my $create_db_user = $cpliveapi->uapi(
        'Mysql', 'create_user',
        {
            'name'       => 'wp500',
            'password'   => 'password',
        }
    );
   
    # Set the user's privileges for the database.
    my $set_dbuser_privs = $cpliveapi->uapi(
        'Mysql', 'set_privileges_on_database',
        {
            'user'       => 'wp500',
            'database'   => 'wp500',
            'privileges' => 'ALL PRIVILEGES',
        }
    );
   
    # Create the [email protected] email address.
    my $new_support_email = $cpliveapi->uapi(
        'Email', 'add_pop',
        {
            'email'           => 'support',
            'password'        => 'password',
            'quota'           => '0',
            'skip_update_db'  => '1',
        }
    );
   
    # Encrypt [email protected]
    my $generate_key = $cpliveapi->api1('Gpg', 'genkey', [$new_support_email, $new_support_email, $new_support_email, '0y', '2048', 'password'] );
   
    # Create the [email protected] email address.
    my $new_office_email = $cpliveapi->uapi(
        'Email', 'add_pop',
        {
            'email'           => 'office',
            'password'        => 'password',
            'quota'           => '0',
            'skip_update_db'  => '1',
        }
    );
   
    # Encrypt [email protected]
    my $generate_key = $cpliveapi->api1('Gpg', 'genkey', [$new_office_email, $new_office_email, $new_office_email, '0y', '2048', 'password'] );
   
    my $cpliveapi->end();
 
 
    # Return the hook's result and message.
    return $result, $message;
}
 
1;

 

@cPanelMichael - Are you able to share any hook.pm examples using uapi for the hook actions? The tutorial doesn't use uapi/api2/api1 functions at all, just File::Copy.

The Guide to Standardized Hooks - Hook Action Code equally does not show how to use uapi/api2/api1 functions, simply:
# Insert your actions here.

I feel like if one example was shared, I could figure out how to implement the rest.

Problem with API call explains why I can't use the live api environment - makes sense it is only for cPanel apps. It doesn't explain how to use uapi/api2/api1 functions in hook, which ultimately is my problem.

Problem with API call also gives various examples of using uapi in PHP, but nothing for Perl.

Thanks for your patience as I learn this stuff.

 

I just wanted to follow up on this thread. After banging my head on the wall for too long trying to get the hook coded as a Perl Module, I decided to try BASH instead.

At least for me, it was much easier. I was able to very quickly implement the hook in BASH.

Thanks for your help @cPanelMichael!!!