Hook file allowing to customize hosts file

aseques · Jun 25th 2013

On the standard setup, the /etc/hosts file is recreated every time the setup is run, since there might be stuff that depends on static dns entries, having a way to add (and preserve custom changes) might be useful.

With this hook the content you store in a file (defaults to /etc/imscp/hooks.files/hosts.custom) will be concatenated to the imscp generate hosts file.

You can find the most recent version of the code at bitbucket
I've tested it with current master (as of 27/06/13)

For any issues, just drop a line in this thread.

**TheCry** · Jun 25th 2013

That's nice...
I use it at home on my dev server..
One error you have

Code

open FILE, ">>", "$systemHostsFile"

The ";" is missing
And the CLOSE handle of the files is missing.

aseques · Jun 25th 2013

Quote from TheCry

That's nice...
I use it at home on my dev server..
One error you have

Code

open FILE, ">>", "$systemHostsFile"

The ";" is missing
And the CLOSE handle of the files is missing.

Display More

ok, it was fixed on my local version, just pushed the fixed version, now there are some points I'd like to be adressed

Is it ok to store the .custom file in the hooks dir?
There's to be some way to manage the exit of the program in case the file is not found, die, or exit or just keep working but spit a debug message

**TheCry** · Jun 25th 2013

I see there no problem to store the file there, because only .pl will we included.

Code

if(-f '/etc/imscp/hooks.d/host.custom') {
do all want you want
} else {
error('File /etc/imscp/hooks.d/host.custom not found');
return 1;
}

**Nuxwin** · Jun 25th 2013

Quote from aseques

Is it ok to store the .custom file in the hooks dir?

There's to be some way to manage the exit of the program in case the file is not found, die, or exit or just keep working but spit a debug message

Hello ;

Perl

#!/usr/bin/perl
=head1 NAME
Plugin::CustomHosts
=cut
# i-MSCP - internet Multi Server Control Panel
# Copyright (C) 2010-2013 by internet Multi Server Control Panel
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# @category i-MSCP
# @copyright 2010-2013 by i-MSCP | [url]http://i-mscp.net[/url]
# @author Joan Juvanteny <[email=aseques@gmail.com]aseques@gmail.com[/email]>
# @link [url]http://i-mscp.net[/url] i-MSCP Home Site
# @license [url]http://www.gnu.org/licenses/gpl-2.0.html[/url] GPL v2
Package Plugin::CustomHosts;
use strict;
use warnings;
use iMSCP::Debug;
use iMSCP::HooksManager;
use iMSCP::File;
my $sysHostsFile = '/etc/hosts';
my $customHostsFile = '/etc/imscp/custom.hosts';
=head1 DESCRIPTION
Plugin allowing to add custom content at end of system hosts file.
=head1 PUBLIC METHODS
=over 4
=item addCustomHosts
Add custom hosts file content to the end of system hosts file
Return int 0 on success, other on failure
=cut
sub addCustomHosts
{
if (-f $sysHostsFile) {
if(-f $customHostsFile) {
my $sysHostsFile = iMSCP::File->new('filename' => $sysHostsFile);
my $sysHostsFileContent = $file->get();
unless(defined $sysHostsFileContent) {
error("Unable to read $sysHostsFile");
return 1;
}
my $customHostsFile = iMSCP::File->new('filename' => $customHostsFile);
my $customHostsFileContent = $file->get();
if(defined $customHostsFileContent) {
$sysHostsFileContent .= $customHostsFile;
$sysHostsFile->set($sysHostsFileContent);
$rs = $sysHostsFile->save();
return $rs if $rs;
$rs = $sysHostsFile->owner('user' => $main::imscpConfig{'ROOT_USER'}, 'group' => $main::imscpConfig{'ROOT_GROUP'});
return $rs if $rs;
$rs = $sysHostsFile->mode(0644);
return $rs if $rs;
} else {
error('Unable to read $customHostsFile');
return 1;
}
} else {
debug("Custom host file not found");
}
} else {
error("System host file not found");
return 1;
}
0;
}
my $hooksManager = iMSCP::HooksManager->getInstance();
$hooksManager->register('afterSetupServerHostname', \&addCustomHosts);
=back
=head1 AUTHOR
Joan Juvanteny <[email=aseques@gmail.com]aseques@gmail.com[/email]>
=cut
1;

Display More

aseques · Jun 26th 2013

Very nice code, I had to make some changes to make it work, but it's working fine now, still in the github here

Instead of storing the custom file in /etc/imscp/ woudln't it fit somewhere else? This si is the place where the keys are stored and there is all the important files, what do you think of using for example /etc/imscp/hooks.files or something similar. (in the code I am using /etc/imscp/hooks.files)
Could we store these snippets in github, so people don't keep reinventing the wheel and have more variety of stuff read from? You decide where, it's more a matter of having it versioned/organized
Finally adding the extension .custom is safer than changing the file name to custom.hosts, because if there are more hooks using files it'll be more clear if all of them have the same extension (filename+ custom)
If I preserve the "Package Plugin::CustomHost;" line, I can't use the plugin

Quote

Can't locate object method "Package" via package "Plugin::CustomHost" (perhaps you forgot to load "Plugin::CustomHost"?) at /etc/imscp/hooks.d/preserve_custom_hosts.pl line 32, <$fh> line 738.
Compilation failed in require at /root/imscp-git/engine/PerlLib/iMSCP/HooksManager.pm line 163, <$fh> line 738.

That's it for the moment..

**TheCry** · Jun 26th 2013

Use

Code

package Plugin::CustomHost;

**Nuxwin** · Jun 26th 2013

Quote from TheCry

Use

Code

package Plugin::CustomHost;

Thanks. I did not tested

**Nuxwin** · Jun 26th 2013

Quote from aseques

Instead of storing the custom file in /etc/imscp/ woudln't it fit somewhere else? This si is the place where the keys are stored and there is all the important files, what do you think of using for example /etc/imscp/hooks.files or something similar. (in the code I am using /etc/imscp/hooks.files)

You store the file where you want. You can edit the path in the plugin file easily. Storing the file under /etc/imscp should not harm since the "hook file" is only run by root. But again, you store this file where you want.

Quote from aseques

Could we store these snippets in github, so people don't keep reinventing the wheel and have more variety of stuff read from? You decide where, it's more a matter of having it versioned/organized

We have created the Plugin section on our forum exactly for that purpose. Hook files (wrongly called plugin there) are only some piece of code allowing to change default i-MSCP behavior or adding custom changes. We will not provide a specific repository to store/share such a files.

Of course, feel free to create you own repository to share your own contributions.

Quote from aseques

[Finally adding the extension .custom is safer than changing the file name to custom.hosts, because if there are more hooks using files it'll be more clear if all of them have the same extension (filename+ custom)

Again, since you can edit the path easily in the hook file, you can name it as you want.

Quote from aseques

If I preserve the "Package Plugin::CustomHost;" line, I can't use the plugin

Instead of simply removing some part of code without asking you why it was added , try to debug them. Here, you are removing the package name, which acts as namespace for your hook file. A namespace allow to avoid any collision with other hook file and even with the i-MSCP core.

aseques · Jun 27th 2013

Quote from Nuxwin

We have created the Plugin section on our forum exactly for that purpose. Hook files (wrongly called plugin there) are only some piece of code allowing to change default i-MSCP behavior or adding custom changes. We will not provide a specific repository to store/share such a files.

Since you don't want to create a repository for the hooks, at leas I'd create specific subforum for this, having the plugins and the hooks mixed in the same place doesn't make things clearer.

Quote from Nuxwin

Of course, feel free to create you own repository to share your own contributions.

Done, I created a new repo in my bitbucket here where I'll store the hooks I use
https://bitbucket.org/aseques/imscp-hooks/src if at some point this gets integrated into the imscp tree I'll delete it.

Hook file allowing to customize hosts file

Share

Daily visitors