add a disk_backend class with a plugin structure

5 files changed, 809 insertions, 0 deletions

diff --git a/lib/ManaTools/Shared/disk_backend/IO.pm b/lib/ManaTools/Shared/disk_backend/IO.pm
new file mode 100644
index 00000000..a143e54b
--- /dev/null
+++ b/lib/ManaTools/Shared/disk_backend/IO.pm
@@ -0,0 +1,120 @@
+# vim: set et ts=4 sw=4:
+package ManaTools::Shared::disk_backend::IO;
+
+#============================================================= -*-perl-*-
+
+=head1 NAME
+
+    ManaTools::Shared::disk_backend::IO - IO class
+
+=head1 SYNOPSIS
+
+    use ManaTools::Shared::disk_backend::IO;
+
+    my $db_man = ManaTools::Shared::disk_backend::IO->new($id);
+    $db_man->label();
+    $db_man->id();
+
+
+=head1 DESCRIPTION
+
+    This is an abstract class for IO in the backend to manadisk
+
+=head1 SUPPORT
+
+    You can find documentation for this class with the perldoc command:
+
+    perldoc ManaTools::Shared::disk_backend::IO
+
+
+=head1 AUTHOR
+
+    Maarten Vanraes <alien@rmail.be>
+
+=head1 COPYRIGHT and LICENSE
+
+Copyright (c) 2015 Maarten Vanraes <alien@rmail.be>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License version 2, as
+published by the Free Software Foundation.
+
+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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+=head1 METHODS
+
+=cut
+
+use Moose;
+
+with 'ManaTools::Shared::PropertiesRole';
+
+## Class data
+has 'type' => (
+    is => 'ro',
+    isa => 'Str',
+    init_arg => undef,
+    lazy => 1,
+    default => 'IO'
+);
+
+## Object vars
+has 'db' => (
+    is => 'rw',
+    isa => 'ManaTools::Shared::disk_backend',
+    init_arg => undef,
+    lazy => 1,
+    default => undef,
+);
+
+has 'id' => (
+    is => 'ro',
+    isa => 'Str',
+    required => 1
+);
+
+#=============================================================
+
+=head2 label
+
+=head3 OUTPUT
+
+    label of the IO
+
+=head3 DESCRIPTION
+
+    this method returns the label for this IO
+
+=cut
+
+#=============================================================
+sub label {
+    my $self = shift;
+
+    return $self->type .' '. $self->id;
+}
+
+#=============================================================
+
+=head2 unhook
+
+=head3 DESCRIPTION
+
+    this method returns removes the IO from the parent and Parts
+
+=cut
+
+#=============================================================
+sub unhook {
+    my $self = shift;
+    $self->db->rmio($self);
+}
+
+1;
diff --git a/lib/ManaTools/Shared/disk_backend/IOs.pm b/lib/ManaTools/Shared/disk_backend/IOs.pm
new file mode 100644
index 00000000..5a6dfd30
--- /dev/null
+++ b/lib/ManaTools/Shared/disk_backend/IOs.pm
@@ -0,0 +1,189 @@
+# vim: set et ts=4 sw=4:
+package ManaTools::Shared::disk_backend::IOs;
+
+#============================================================= -*-perl-*-
+
+=head1 NAME
+
+    ManaTools::Shared::disk_backend::IOs - list of IOs
+
+=head1 SYNOPSIS
+
+    use ManaTools::Shared::disk_backend::IOs;
+
+    my $db_man = ManaTools::Shared::disk_backend::IOs->new(parent => $self, restriction => $restriction);
+    $db_man->append($io);
+    $db_man->remove($io);
+    $db_man->list();
+    $db_man->length();
+
+
+=head1 DESCRIPTION
+
+    This plugin is an collection of IOs in the backend to manadisk
+
+=head1 SUPPORT
+
+    You can find documentation for this plugin with the perldoc command:
+
+    perldoc ManaTools::Shared::disk_backend::IOs
+
+
+=head1 AUTHOR
+
+    Maarten Vanraes <alien@rmail.be>
+
+=head1 COPYRIGHT and LICENSE
+
+Copyright (c) 2015 Maarten Vanraes <alien@rmail.be>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License version 2, as
+published by the Free Software Foundation.
+
+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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+=head1 METHODS
+
+=cut
+
+use Moose;
+
+has 'parent' => (
+    is => 'ro',
+    isa => 'ManaTools::Shared::disk_backend::Part',
+    required => 1
+);
+has 'restriction' => (
+    traits => ['Code'],
+    is => 'ro',
+    isa => 'CodeRef',
+    required => 1,
+    handles => {
+        check => 'execute'
+    }
+);
+has 'ios' => (
+    is => 'ro',
+    isa => 'HashRef[ManaTools::Shared::disk_backend::IO]',
+    default => sub {return {};}
+);
+
+#=============================================================
+
+=head2 length
+
+=head3 OUTPUT
+
+    Int
+
+=head3 DESCRIPTION
+
+    this method returns the number of IOs
+
+=cut
+
+#=============================================================
+sub length {
+    my $self = shift;
+
+    return scalar(keys %{$self->ios});
+}
+
+#=============================================================
+
+=head2 list
+
+=head3 OUTPUT
+
+    array of the IOs
+
+=head3 DESCRIPTION
+
+    this method returns a list of IOs
+
+=cut
+
+#=============================================================
+sub list {
+    my $self = shift;
+
+    return values %{$self->ios};
+}
+
+#=============================================================
+
+=head2 append
+
+=head3 INPUT
+
+    $io: IO to add
+
+=head3 OUTPUT
+
+    1 if success, 0 otherwise
+
+=head3 DESCRIPTION
+
+    this method appends an IO
+
+=cut
+
+#=============================================================
+sub append {
+    my $self = shift;
+    my $io = shift;
+
+    # check IO with restriction
+    if (defined $self->restriction) {
+        if (!$self->check($self->parent(), $io)) {
+            return 0;
+        }
+    }
+
+    $self->ios->{$io->id} = $io;
+}
+
+#=============================================================
+
+=head2 remove
+
+=head3 INPUT
+
+    $io: IO to remove
+
+=head3 OUTPUT
+
+    1 if success, 0 otherwise
+
+=head3 DESCRIPTION
+
+    this method removes an IO
+
+=cut
+
+#=============================================================
+sub remove {
+    my $self = shift;
+    my $io = shift;
+
+    # check IO with restriction
+    if (defined $self->restriction) {
+        if (!$self->check($self->parent(), $io, 1)) {
+            return 0;
+        }
+    }
+
+    # remove the io
+    delete $self->ios->{$io->id};
+}
+
+1;
+
diff --git a/lib/ManaTools/Shared/disk_backend/Part.pm b/lib/ManaTools/Shared/disk_backend/Part.pm
new file mode 100644
index 00000000..b4ebbfa4
--- /dev/null
+++ b/lib/ManaTools/Shared/disk_backend/Part.pm
@@ -0,0 +1,254 @@
+# vim: set et ts=4 sw=4:
+package ManaTools::Shared::disk_backend::Part;
+
+#============================================================= -*-perl-*-
+
+=head1 NAME
+
+    ManaTools::Shared::disk_backend::Part - Part class
+
+=head1 SYNOPSIS
+    package ManaTools::Shared::disk_backend::Part::MBR;
+
+    extend 'ManaTools::Shared::disk_backend::Part';
+
+    has '+type', required => 0, default => 'MBR';
+    has '+in_restriction', default => sub { my ($self, $io)=@_; return ($self->in_length() < 1 && $io->type == 'disk');};
+    has '+out_restriction', default => sub { my ($self, $io)=@_; return ($self->out_length() < 4 && $io->type == 'partition');};
+
+    override('label', sub {
+        my $self = shift;
+        my $label = super;
+        if ($self->in_length < 1) {
+            return $label;
+        }
+        my @ins = $self->in_list();
+        return $label .= "(". $ins[0]->id() .")";
+    });
+
+    1;
+
+    ...
+
+    my $mbr = ManaTools::Shared::disk_backend::Part::MBR->new();
+    $mbr->label();  // MBR(/dev/sda)
+    $mbr->get_ins();
+    $mbr->get_outs();
+    $mbr->out_add($io);
+    my $size = $mbr->prop('size');
+    $mbr->prop('size', '20G');
+    $mbr->action('format');
+
+
+=head1 DESCRIPTION
+
+    This is an abstract class for Part in the backend to manadisk
+
+=head1 SUPPORT
+
+    You can find documentation for this plugin with the perldoc command:
+
+    perldoc ManaTools::Shared::disk_backend::Part
+
+
+=head1 AUTHOR
+
+    Maarten Vanraes <alien@rmail.be>
+
+=head1 COPYRIGHT and LICENSE
+
+Copyright (c) 2015 Maarten Vanraes <alien@rmail.be>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License version 2, as
+published by the Free Software Foundation.
+
+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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+=head1 METHODS
+
+=cut
+
+use Moose;
+
+with 'ManaTools::Shared::ActionsRole', 'ManaTools::Shared::PropertiesRole';
+
+use ManaTools::Shared::disk_backend::IOs;
+
+## Class DATA
+has 'type' => (
+    is => 'ro',
+    init_arg => undef,
+    lazy => 1,
+    isa => 'Str',
+    default => 'Part'
+);
+has 'in_restriction' => (
+    is => 'ro',
+    init_arg => undef,
+    lazy => 1,
+    isa => 'Maybe[CodeRef]',
+    default => sub {
+        sub { return 1; }
+    }
+);
+has 'out_restriction' => (
+    is => 'ro',
+    init_arg => undef,
+    lazy => 1,
+    isa => 'Maybe[CodeRef]',
+    default => sub {
+        sub { return 1; }
+    }
+);
+
+## Object Variables
+has 'db' => (
+    is => 'rw',
+    isa => 'ManaTools::Shared::disk_backend',
+    init_arg => undef,
+    lazy => 1,
+    default => undef,
+);
+
+has 'ins' => (
+    is => 'ro',
+    isa => 'ManaTools::Shared::disk_backend::IOs',
+    lazy => 1,
+    default => sub {
+        my $self = shift;
+        return ManaTools::Shared::disk_backend::IOs->new(parent => $self, restriction => $self->in_restriction);
+    },
+    handles => {
+        in_length => 'length',
+        in_list => 'list',
+        in_add => 'append'
+    }
+);
+has 'outs' => (
+    is => 'ro',
+    isa => 'ManaTools::Shared::disk_backend::IOs',
+    lazy => 1,
+    default => sub {
+        my $self = shift;
+        return ManaTools::Shared::disk_backend::IOs->new(parent => $self, restriction => $self->out_restriction);
+    },
+    handles => {
+        out_length => 'length',
+        out_list => 'list',
+        out_add => 'append'
+    }
+);
+
+#=============================================================
+
+=head2 label
+
+=head3 OUTPUT
+
+    label of the IO
+
+=head3 DESCRIPTION
+
+    this method returns the label for this IO
+
+=cut
+
+#=============================================================
+sub label {
+    my $self = shift;
+
+    return $self->type;
+}
+
+#=============================================================
+
+=head2 get_ins
+
+=head3 OUTPUT
+
+    array of the in IOs
+
+=head3 DESCRIPTION
+
+    this method returns the in IOs
+
+=cut
+
+#=============================================================
+sub get_ins {
+    my $self = shift;
+
+    return $self->ins->list();
+}
+
+#=============================================================
+
+=head2 get_outs
+
+=head3 OUTPUT
+
+    array of the out IOs
+
+=head3 DESCRIPTION
+
+    this method returns the out IOs
+
+=cut
+
+#=============================================================
+sub get_outs {
+    my $self = shift;
+
+    return $self->outs->list();
+}
+
+#=============================================================
+
+=head2 rmio
+
+=head3 INPUT
+
+    $io: ManaTools::Shared::disk_backend::IO
+
+=head3 DESCRIPTION
+
+    this method returns removes the IO from the Part
+
+=cut
+
+#=============================================================
+sub rmio {
+    my $self = shift;
+    my $io = shift;
+    my $ins = $self->ins();
+    my $outs = $self->outs();
+    # remove io from ins and outs
+    $ins->remove($io);
+    $outs->remove($io);
+}
+
+#=============================================================
+
+=head2 unhook
+
+=head3 DESCRIPTION
+
+    this method returns removes the Part from the parent
+
+=cut
+
+#=============================================================
+sub unhook {
+    my $self = shift;
+    $self->db->rmpart($self);
+}
+
+1;
diff --git a/lib/ManaTools/Shared/disk_backend/Plugin.pm b/lib/ManaTools/Shared/disk_backend/Plugin.pm
new file mode 100644
index 00000000..e38553a5
--- /dev/null
+++ b/lib/ManaTools/Shared/disk_backend/Plugin.pm
@@ -0,0 +1,243 @@
+# vim: set et ts=4 sw=4:
+package ManaTools::Shared::disk_backend::Plugin;
+
+#============================================================= -*-perl-*-
+
+=head1 NAME
+
+    ManaTools::Shared::disk_backend::Plugin - disks object
+
+=head1 SYNOPSIS
+
+    package ManaTools::Shared::disk_backend::Plugin::Foo;
+    use Moose;
+
+    extend 'ManaTools::Shared::disk_backend::Plugin';
+
+    override('load', sub {
+        ...
+    });
+
+    override('save', sub {
+        ...
+    });
+
+    override('probe', sub {
+        ...
+    });
+
+    override('probeio', sub {
+        ...
+    });
+
+    1;
+
+    package ManaTools::Shared::disk_backend::IO::Bar;
+    use Moose;
+
+    extend 'ManaTools::Shared::disk_backend::IO';
+
+    has '+type', default => 'bar';
+
+    ...
+
+    1;
+
+    package ManaTools::Shared::disk_backend::Part::Baz;
+    use Moose;
+
+    extend 'ManaTools::Shared::disk_backend::Part';
+
+    has '+type', default => 'baz';
+    has '+in_restriction', default => sub { ... };
+    has '+out_restriction', default => sub { ... };
+
+    ...
+
+    1;
+
+=head1 DESCRIPTION
+
+    This plugin is a abstract plugin for the backend to manadisk
+
+=head1 SUPPORT
+
+    You can find documentation for this plugin with the perldoc command:
+
+    perldoc ManaTools::Shared::disk_backend::Plugin
+
+
+=head1 AUTHOR
+
+    Maarten Vanraes <alien@rmail.be>
+
+=head1 COPYRIGHT and LICENSE
+
+Copyright (c) 2015 Maarten Vanraes <alien@rmail.be>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License version 2, as
+published by the Free Software Foundation.
+
+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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+=head1 METHODS
+
+=cut
+
+use Moose;
+
+## class DATA
+has 'dependencies' => (
+    is => 'ro',
+    init_arg => undef,
+    isa => 'ArrayRef[Str]',
+    lazy => 1,
+    default => sub {
+        return [];
+    }
+);
+
+has 'parent' => (
+    is => 'ro',
+    isa => 'ManaTools::Shared::disk_backend',
+    required => 1
+);
+
+#=============================================================
+
+=head2 load
+
+=head3 OUTPUT
+
+    0 if failed, 1 if success
+
+=head3 DESCRIPTION
+
+    this is a default method for loading Part's, the idea is to override it if needed
+
+=cut
+
+#=============================================================
+sub load {
+    my $self = shift;
+
+    1;
+}
+
+#=============================================================
+
+=head2 save
+
+=head3 OUTPUT
+
+    0 if failed, 1 if success
+
+=head3 DESCRIPTION
+
+    this is a default method for saving Part's, the idea is to override it if needed
+
+=cut
+
+#=============================================================
+sub save {
+    my $self = shift;
+
+    1;
+}
+
+#=============================================================
+
+=head2 probe
+
+=head3 OUTPUT
+
+    0 if failed, 1 if success
+
+=head3 DESCRIPTION
+
+    this is a default method for probing IO's and/or Part's, the idea is to override it if needed
+
+=cut
+
+#=============================================================
+sub probe {
+    my $self = shift;
+
+    1;
+}
+
+#=============================================================
+
+=head2 loadio
+
+=head3 OUTPUT
+
+    0 if failed, 1 if success
+
+=head3 DESCRIPTION
+
+    this is a default method for loading a Part from a specific IO, the idea is to override it if needed
+
+=cut
+
+#=============================================================
+sub loadio {
+    my $self = shift;
+    my $io = shift;
+
+    1;
+}
+
+#=============================================================
+
+=head2 savepart
+
+=head3 OUTPUT
+
+    0 if failed, 1 if success
+
+=head3 DESCRIPTION
+
+    this is a default method for saving a specific Part, the idea is to override it if needed
+
+=cut
+
+#=============================================================
+sub savepart {
+    my $self = shift;
+    my $part = shift;
+
+    1;
+}
+
+#=============================================================
+
+=head2 probeio
+
+=head3 OUTPUT
+
+    0 if failed, 1 if success
+
+=head3 DESCRIPTION
+
+    this is a default method for probing specific a specific IO, the idea is to override it if needed
+
+=cut
+
+#=============================================================
+sub probeio {
+    my $self = shift;
+    my $io = shift;
+
+    1;
+}
+
+1;
diff --git a/lib/ManaTools/Shared/disk_backend/Plugin/README b/lib/ManaTools/Shared/disk_backend/Plugin/README
new file mode 100644
index 00000000..3ca9e07a
--- /dev/null
+++ b/lib/ManaTools/Shared/disk_backend/Plugin/README
@@ -0,0 +1,3 @@
+This directory is for placing disk backend plugins subclassed from ManaTools::Shared::disk_backend::Plugin
+
+they should have IO subclasses or Part subclasses or both with some functions to handle Plugin load/probe/save/...