aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ManaTools/Shared/disk_backend/FileSystem.pm
blob: 682e3a9f6c00191efbc278e5a37f5b1a9e44ee6b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# vim: set et ts=4 sw=4:
package ManaTools::Shared::disk_backend::FileSystem;

#============================================================= -*-perl-*-

=head1 NAME

    ManaTools::Shared::disk_backend::FileSystem - a FileSystem Moose Role

=head1 SYNOPSIS
    package Foo;

    with 'ManaTools::Shared::disk_backend::FileSystem';

    1;

    ...

    my $f = Foo->new();
    my $in = $f->fsprobe($io);


=head1 DESCRIPTION

    This Role is an collection of FileSystem in the backend to manadisk

=head1 SUPPORT

    You can find documentation for this Role with the perldoc command:

    perldoc ManaTools::Shared::disk_backend::FileSystem


=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::Role;

#=============================================================

=head2 fsprobe

=head3 INPUT

    $io: ManaTools::Shared::disk_backend::IO

=head3 OUTPUT

    ManaTools::Shared::disk_backend::IO or undef

=head3 DESCRIPTION

    this method probes the IO to see if it fits for this
    filesystem, if it does, create a new Part with this IO as in.
    also create an IO (linked as the out) and return that one.
    The resulting one can then be used as an in to eg: a Mount Part.

=cut

#=============================================================

requires 'fsprobe';

has 'fstypes' => (
    is => 'ro',
    isa => 'ArrayRef[Str]',
    init_arg => undef,
    default => sub { return []; },
);

#=============================================================

=head2 has_type

=head3 INPUT

    $type: Str

=head3 OUTPUT

    1 | 0

=head3 DESCRIPTION

    this method checks if this particular plugin can handle
    the given filesystem.

=cut

#=============================================================

sub has_type {
    my $self = shift;
    my $type = shift;
    my $fstypes = $self->fstypes();
    for my $t (@{$fstypes}) {
        if ($t eq $type) {
            return 1;
        }
    }
    return 0;
}

package ManaTools::Shared::disk_backend::IOFS;

use Moose::Role;

package ManaTools::Shared::disk_backend::FileRole;

use Moose::Role;

has 'fs' => (
    is => 'rw',
    does => 'ManaTools::Shared::disk_backend::IOFS',
    required => 1,
);

has 'path' => (
    is => 'rw',
    isa => 'Str',
    required => 1,
);

1;