Ravada.pm 12.2 KB
Newer Older
1
2
3
4
5
package Ravada;

use warnings;
use strict;

6
use Carp qw(carp croak);
7
use Data::Dumper;
8
9
10
11
use DBIx::Connector;
use Moose;
use YAML;

12
use Ravada::Request;
13
use Ravada::VM::KVM;
14
use Ravada::VM::LXC;
15

Francesc Guasch's avatar
Francesc Guasch committed
16
17
18
19
20
21
22
23
24
25
26
27
=head1 NAME

Ravada - Remove Virtual Desktop Manager

=head1 SYNOPSIS

  use Ravada;

  my $ravada = Ravada->new()

=cut

28
29
30
31
32
33
34

our $FILE_CONFIG = "/etc/ravada.conf";

###########################################################################

our $CONNECTOR;
our $CONFIG = {};
35
36
our $DEBUG;

37
38
39
40
41
42
43
44
45
46


has 'vm' => (
          is => 'ro'
        ,isa => 'ArrayRef'
       ,lazy => 1
     , builder => '_create_vm'
);

has 'connector' => (
47
48
49
50
51
52
        is => 'rw'
);

has 'config' => (
    is => 'ro'
    ,isa => 'Str'
53
54
);

Francesc Guasch's avatar
Francesc Guasch committed
55
56
57
58
59
60
61
=head2 BUILD

Internal constructor

=cut


62
63
sub BUILD {
    my $self = shift;
64
    if ($self->config()) {
65
        _init_config($self->config);
66
    } else {
Francesc Guasch's avatar
Francesc Guasch committed
67
        _init_config($FILE_CONFIG) if -e $FILE_CONFIG;
68
    }
69

Francesc Guasch's avatar
Francesc Guasch committed
70
71
72
73
    if ( $self->connector ) {
        $CONNECTOR = $self->connector 
    } else {
        $CONNECTOR = $self->_connect_dbh();
74
        $self->connector($CONNECTOR);
Francesc Guasch's avatar
Francesc Guasch committed
75
    }
76

77
78
79
80
81
82
}

sub _connect_dbh {
    my $driver= ($CONFIG->{db}->{driver} or 'mysql');;
    my $db_user = ($CONFIG->{db}->{user} or getpwnam($>));;
    my $db_pass = ($CONFIG->{db}->{password} or undef);
Francesc Guasch's avatar
Francesc Guasch committed
83
84
    my $db = ( $CONFIG->{db}->{db} or 'ravada' );
    return DBIx::Connector->new("DBI:$driver:$db"
85
86
87
88
89
90
91
                        ,$db_user,$db_pass,{RaiseError => 1
                        , PrintError=> 0 });

}

sub _init_config {
    my $file = shift;
92
93

    my $connector = shift;
94
    confess "Deprecated connector" if $connector;
95

96
    $CONFIG = YAML::LoadFile($file);
97
#    $CONNECTOR = ( $connector or _connect_dbh());
98
99
}

100
sub _create_vm_kvm {
101
    my $self = shift;
102

103
104
105
106
    my $cmd_qemu_img = `which qemu-img`;
    chomp $cmd_qemu_img;

    return(undef,"ERROR: Missing qemu-img") if !$cmd_qemu_img;
107
108

    my $vm_kvm;
109

110
111
    eval { $vm_kvm = Ravada::VM::KVM->new( connector => ( $self->connector or $CONNECTOR )) };
    my $err_kvm = $@;
112
    return (undef, $err_kvm)    if !$vm_kvm;
113
114
115
116
117
118
119
120
121

    my ($internal_vm , $storage);
    eval {
        $internal_vm = $vm_kvm->vm;
        $internal_vm->list_all_domains();

        $storage = $vm_kvm->dir_img();
    };
    $vm_kvm = undef if $@ || !$internal_vm || !$storage;
Francesc Guasch's avatar
Francesc Guasch committed
122
123
    $err_kvm .= ($@ or '');
    return ($vm_kvm,$err_kvm);
124
125
126
127
128
129
130
131
132
}

sub _create_vm {
    my $self = shift;

    my @vms = ();

    my ($vm_kvm, $err_kvm) = $self->_create_vm_kvm();

133
134
135
136
137
138
139
140
    push @vms,($vm_kvm) if $vm_kvm;

    my $vm_lxc;
    eval { $vm_lxc = Ravada::VM::LXC->new( connector => ( $self->connector or $CONNECTOR )) };
    push @vms,($vm_lxc) if $vm_lxc;
    my $err_lxc = $@;

    if (!@vms) {
Francesc Guasch's avatar
Francesc Guasch committed
141
        confess "No VMs found: $err_lxc\n$err_kvm\n";
142
143
144
    }
    return \@vms;

145
146
}

Francesc Guasch's avatar
Francesc Guasch committed
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
=head2 create_domain

Creates a new domain based on an ISO image or another domain.

  my $domain = $ravada->create_domain( 
         name => $name
    , id_iso => 1
  );


  my $domain = $ravada->create_domain( 
         name => $name
    , id_base => 3
  );


=cut


166
sub create_domain {
167
168
    my $self = shift;

169
170
    my %args = @_;

171
172
173
    croak "Argument id_owner required "
        if !$args{id_owner};

174
175
    my $vm_name = $args{vm};
    delete $args{vm};
176

Francesc Guasch's avatar
Francesc Guasch committed
177

178
    my $vm = $self->vm->[0];
179
    $vm = $self->search_vm($vm_name)   if $vm_name;
180

181
182
    carp "WARNING: no VM defined, we will use ".$vm->name
        if !$vm_name;
Francesc Guasch's avatar
Francesc Guasch committed
183

184
    confess "I can't find any vm ".Dumper($self->vm) if !$vm;
185
    return $vm->create_domain(@_);
186
187
}

Francesc Guasch's avatar
Francesc Guasch committed
188
189
190
191
192
193
194
195
=head2 remove_domain

Removes a domain

  $ravada->remove_domain($name);

=cut

196
197
198
199
sub remove_domain {
    my $self = shift;
    my $name = shift or confess "Missing domain name";

200
    my $domain = $self->search_domain($name, 1)
201
202
203
204
        or confess "ERROR: I can't find domain $name";
    $domain->remove();
}

Francesc Guasch's avatar
Francesc Guasch committed
205
206
207
208
209
210
=head2 search_domain

  my $domain = $ravada->search_domain($name);

=cut

211
212
213
sub search_domain {
    my $self = shift;
    my $name = shift;
214
    my $import = shift;
215
216

    for my $vm (@{$self->vm}) {
Francesc Guasch's avatar
Francesc Guasch committed
217
        my $domain = $vm->search_domain($name, $import);
218
        next if !$domain;
219
        next if !$domain->_select_domain_db && !$import;
220
221
222
        my $id;
        eval { $id = $domain->id };
        # TODO import the domain in the database with an _insert_db or something
Francesc Guasch's avatar
Francesc Guasch committed
223
        warn $@ if $@   && $DEBUG;
224
        return $domain if $id || $import;
225
    }
226
    return;
227
}
228

Francesc Guasch's avatar
Francesc Guasch committed
229
230


231
232
=head2 list_domains

Francesc Guasch's avatar
Francesc Guasch committed
233
List all created domains
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249

  my @list = $ravada->list_domains();

=cut

sub list_domains {
    my $self = shift;
    my @domains;
    for my $vm (@{$self->vm}) {
        for my $domain ($vm->list_domains) {
            push @domains,($domain);
        }
    }
    return @domains;
}

250
251
252
253
254
255
256
257
258
259
260
261
262
=head2 list_domains_data

List all domains in raw format. Return a list of id => { name , id , is_active , is_base }

   my $list = $ravada->list_domains_data();

   $c->render(json => $list);

=cut

sub list_domains_data {
    my $self = shift;
    my @domains;
263
264
265
266
267
268
    my $sth = $CONNECTOR->dbh->prepare(
        "SELECT * FROM domains ORDER BY name"
    );
    $sth->execute;
    while (my $row = $sth->fetchrow_hashref) {
        push @domains,($row);
269
    }
270
    $sth->finish;
271
    return \@domains;
272
273
}

274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
# sub list_domains_data {
#     my $self = shift;
#     my @domains;
#     for my $domain ($self->list_domains()) {
#         eval { $domain->id };
#         warn $@ if $@;
#         next if $@;
#         push @domains, {                id => $domain->id 
#                                     , name => $domain->name
#                                   ,is_base => $domain->is_base
#                                 ,is_active => $domain->is_active
                               
#                            }
#     }
#     return \@domains;
# }

291

Francesc Guasch's avatar
Francesc Guasch committed
292
293
294
295
296
297
298
299
300
301
302
303
304
305
=head2 list_bases

List all base domains

  my @list = $ravada->list_domains();


=cut

sub list_bases {
    my $self = shift;
    my @domains;
    for my $vm (@{$self->vm}) {
        for my $domain ($vm->list_domains) {
306
307
308
            eval { $domain->id };
            warn $@ if $@;
            next    if $@;
Francesc Guasch's avatar
Francesc Guasch committed
309
310
311
312
313
314
            push @domains,($domain) if $domain->is_base;
        }
    }
    return @domains;
}

315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
=head2 list_bases_data

List information about the bases

=cut

sub list_bases_data {
    my $self = shift;
    my @data;
    for ($self->list_bases ) {
        push @data,{ id => $_->id , name => $_->name };
    }
    return \@data;
}

Francesc Guasch's avatar
Francesc Guasch committed
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
=head2 list_images

List all ISO images

=cut

sub list_images {
    my $self = shift;
    my @domains;
    my $sth = $CONNECTOR->dbh->prepare(
        "SELECT * FROM iso_images ORDER BY name"
    );
    $sth->execute;
    while (my $row = $sth->fetchrow_hashref) {
        push @domains,($row);
    }
    $sth->finish;
    return @domains;
}

350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
=head2 list_images_data

List information about the images

=cut

sub list_images_data {
    my $self = shift;
    my @data;
    for ($self->list_images ) {
        push @data,{ id => $_->{id} , name => $_->{name} };
    }
    return \@data;
}

Francesc Guasch's avatar
Francesc Guasch committed
365

fv3rdugo's avatar
fv3rdugo committed
366
367
368
369
sub list_images_lxc {
    my $self = shift;
    my @domains;
    my $sth = $CONNECTOR->dbh->prepare(
370
        "SELECT * FROM lxc_templates ORDER BY name"
fv3rdugo's avatar
fv3rdugo committed
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
    );
    $sth->execute;
    while (my $row = $sth->fetchrow_hashref) {
        push @domains,($row);
    }
    $sth->finish;
    return @domains;
}

=head2 list_images_data

List information about the images

=cut

sub list_images_data_lxc {
    my $self = shift;
    my @data;
    for ($self->list_images_lxc ) {
        push @data,{ id => $_->{id} , name => $_->{name} };
    }
    return \@data;
}



Francesc Guasch's avatar
Francesc Guasch committed
397
398
399
400
=head2 remove_volume

  $ravada->remove_volume($file);

Francesc Guasch's avatar
Francesc Guasch committed
401

Francesc Guasch's avatar
Francesc Guasch committed
402
403
=cut

404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
sub remove_volume {
    my $self = shift;

    my $file = shift;
    my ($name) = $file =~ m{.*/(.*)};

    my $removed = 0;
    for my $vm (@{$self->vm}) {
        my $vol = $vm->search_volume($name);
        next if !$vol;

        $vol->delete();
        $removed++;
    }
    if (!$removed && -e $file ) {
        warn "volume $file not found. removing file $file.\n";
        unlink $file or die "$! $file";
    }

}
424

Francesc Guasch's avatar
Francesc Guasch committed
425
426
427
428
429
430
431
432
=head2 process_requests

This is run in the ravada backend. It processes the commands requested by the fronted

  $ravada->process_requests();

=cut

433
434
sub process_requests {
    my $self = shift;
435
    my $debug = shift;
436
437
438
439

    my $sth = $CONNECTOR->dbh->prepare("SELECT id FROM requests WHERE status='requested'");
    $sth->execute;
    while (my ($id)= $sth->fetchrow) {
Francesc Guasch's avatar
Francesc Guasch committed
440
        my $req = Ravada::Request->open($id);
441
        warn "executing request ".$req." ".Dumper($req) if $DEBUG || $debug;
Francesc Guasch's avatar
Francesc Guasch committed
442
        $self->_execute($req);
443
        warn "status: ".$req->status() if $DEBUG || $debug;
444
445
446
447
    }
    $sth->finish;
}

Francesc Guasch's avatar
Francesc Guasch committed
448

449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
=head2 list_vm_types

Returnsa list ofthe types of Virtual Machines available on this system

=cut

sub list_vm_types {
    my $self = shift;
    
    my %type;
    for my $vm (@{$self->vm}) {
            my ($name) = ref($vm) =~ /.*::(.*)/;
            $type{$name}++;
    }
    return sort keys %type;
}

466
467
468
469
sub _execute {
    my $self = shift;
    my $request = shift;

Francesc Guasch's avatar
Francesc Guasch committed
470
471
472
473
474
475
476
477
478
    my $sub = $self->_req_method($request->command);

    die "Unknown command ".$request->command
        if !$sub;

    return $sub->($self,$request);

}

479
480
481
482
483
484
485
486
487
sub _cmd_domdisplay {
    my $self = shift;
    my $request = shift;

    $request->status('working');

    my $name = $request->args('name');
    confess "Unknown name for request ".Dumper($request)  if!$name;
    my $domain = $self->search_domain($request->args->{name});
488
489
    my $user = Ravada::Auth::SQL->search_by_id( $request->args->{uid});
    my $display = $domain->display($user);
490
491
492
493
    $request->result({display => $display});

    $request->status('done');

494
495
}

Francesc Guasch's avatar
Francesc Guasch committed
496
497
498
499
sub _cmd_create {
    my $self = shift;
    my $request = shift;

500
501
502
    $request->status('creating domain');
    my $domain;
    eval {$domain = $self->create_domain(%{$request->args}) };
Francesc Guasch's avatar
Francesc Guasch committed
503
    warn $@ if $@;
504

Francesc Guasch's avatar
Francesc Guasch committed
505
506
507
508
509
510
511
512
513
514
515
516
517
    $request->status('done');
    $request->error($@);

}

sub _cmd_remove {
    my $self = shift;
    my $request = shift;

    $request->status('working');
    eval { $self->remove_domain($request->args('name')) };
    $request->status('done');
    $request->error($@);
Francesc Guasch's avatar
Francesc Guasch committed
518

519
}
Francesc Guasch's avatar
Francesc Guasch committed
520

Francesc Guasch's avatar
Francesc Guasch committed
521
522
523
524
525
526
527
528
529
530
531
sub _cmd_start {
    my $self = shift;
    my $request = shift;

    $request->status('working');
    my $name = $request->args('name');
    eval { 
        my $domain = $self->search_domain($name);
        die "Unknown domain '$name'\n" if !$domain;
        $domain->start();
    };
532

Francesc Guasch's avatar
Francesc Guasch committed
533
534
535
536
537
    $request->status('done');
    $request->error($@);

}

Francesc Guasch's avatar
Francesc Guasch committed
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
sub _cmd_prepare_base {
    my $self = shift;
    my $request = shift;

    $request->status('working');
    my $name = $request->args('name');
    eval { 
        my $domain = $self->search_domain($name);
        die "Unknown domain '$name'\n" if !$domain;
        $domain->prepare_base();
    };
    $request->status('done');
    $request->error($@);

}


Francesc Guasch's avatar
Francesc Guasch committed
555
556
557
558
559
560
sub _cmd_shutdown {
    my $self = shift;
    my $request = shift;

    $request->status('working');
    my $name = $request->args('name');
561
562
    my $timeout = ($request->args('timeout') or 60);
    my $domain;
Francesc Guasch's avatar
Francesc Guasch committed
563
    eval { 
564
        $domain = $self->search_domain($name);
Francesc Guasch's avatar
Francesc Guasch committed
565
        die "Unknown domain '$name'\n" if !$domain;
566
        $domain->shutdown(timeout => $timeout);
Francesc Guasch's avatar
Francesc Guasch committed
567
568
569
570
571
572
    };
    $request->status('done');
    $request->error($@);

}

573
574
575
576
577
sub _cmd_list_vm_types {
    my $self = shift;
    my $request = shift;
    $request->status('working');
    my @list_types = $self->list_vm_types();
Francesc Guasch's avatar
Francesc Guasch committed
578
    $request->result(\@list_types);
579
580
    $request->status('done');
}
Francesc Guasch's avatar
Francesc Guasch committed
581

582
583
584
585
586
587
588
sub _cmd_ping_backend {
    my $self = shift;
    my $request = shift;

    $request->status('done');
    return 1;
}
Francesc Guasch's avatar
Francesc Guasch committed
589

Francesc Guasch's avatar
Francesc Guasch committed
590
591
592
593
594
sub _req_method {
    my $self = shift;
    my  $cmd = shift;

    my %methods = (
Francesc Guasch's avatar
Francesc Guasch committed
595

Francesc Guasch's avatar
Francesc Guasch committed
596
597
598
          start => \&_cmd_start
        ,create => \&_cmd_create
        ,remove => \&_cmd_remove
Francesc Guasch's avatar
Francesc Guasch committed
599
      ,shutdown => \&_cmd_shutdown
600
    ,domdisplay => \&_cmd_domdisplay
601
  ,ping_backend => \&_cmd_ping_backend
Francesc Guasch's avatar
Francesc Guasch committed
602
  ,prepare_base => \&_cmd_prepare_base
603
 ,list_vm_types => \&_cmd_list_vm_types
Francesc Guasch's avatar
Francesc Guasch committed
604
605
606
607
    );
    return $methods{$cmd};
}

608
609
610
611
612
613
614
615
616
617
618
619
=head2 search_vm

Searches for a VM of a given type

  my $vm = $ravada->search_vm('kvm');

=cut

sub search_vm {
    my $self = shift;
    my $type = shift;

620
621
    confess "Missing VM type"   if !$type;

622
    my $class = 'Ravada::VM::'.uc($type);
Francesc Guasch's avatar
Francesc Guasch committed
623

624
625
626
627
    if ($type eq 'Void') {
        return Ravada::VM::Void->new();
    }

Francesc Guasch's avatar
Francesc Guasch committed
628
629
630
    my @vms;
    eval { @vms = @{$self->vm} };
    for my $vm (@vms) {
631
632
633
634
        return $vm if ref($vm) eq $class;
    }
    return;
}
Francesc Guasch's avatar
Francesc Guasch committed
635

Francesc Guasch's avatar
Francesc Guasch committed
636
637
638
639
640
641
642
643
644
645
=head1 AUTHOR

Francesc Guasch-Ortiz	, frankie@telecos.upc.edu

=head1 SEE ALSO

Sys::Virt

=cut

646
1;