Ravada.pm 14.7 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
use DBIx::Connector;
9
use Hash::Util qw(lock_hash);
10
use Moose;
Francesc Guasch's avatar
Francesc Guasch committed
11
use POSIX qw(WNOHANG);
12
13
use YAML;

Francesc Guasch's avatar
Francesc Guasch committed
14
use Ravada::Auth;
15
use Ravada::Request;
16
use Ravada::VM::KVM;
17
use Ravada::VM::LXC;
18
use Ravada::VM::Void;
19

Francesc Guasch's avatar
Francesc Guasch committed
20
21
22
23
24
25
26
27
28
29
30
31
=head1 NAME

Ravada - Remove Virtual Desktop Manager

=head1 SYNOPSIS

  use Ravada;

  my $ravada = Ravada->new()

=cut

32
33
34
35
36
37
38

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

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

our $CONNECTOR;
our $CONFIG = {};
39
40
our $DEBUG;

41
42
43
44
45
46
47
48
49
50


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

has 'connector' => (
51
52
53
54
55
56
        is => 'rw'
);

has 'config' => (
    is => 'ro'
    ,isa => 'Str'
57
58
);

Francesc Guasch's avatar
Francesc Guasch committed
59
60
61
62
63
64
65
=head2 BUILD

Internal constructor

=cut


66
67
sub BUILD {
    my $self = shift;
68
    if ($self->config()) {
69
        _init_config($self->config);
70
    } else {
Francesc Guasch's avatar
Francesc Guasch committed
71
        _init_config($FILE_CONFIG) if -e $FILE_CONFIG;
72
    }
73

Francesc Guasch's avatar
Francesc Guasch committed
74
75
76
77
    if ( $self->connector ) {
        $CONNECTOR = $self->connector 
    } else {
        $CONNECTOR = $self->_connect_dbh();
78
        $self->connector($CONNECTOR);
Francesc Guasch's avatar
Francesc Guasch committed
79
    }
Francesc Guasch's avatar
Francesc Guasch committed
80
    Ravada::Auth::init($CONFIG);
81
82
83
84
85
86
}

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
87
88
    my $db = ( $CONFIG->{db}->{db} or 'ravada' );
    return DBIx::Connector->new("DBI:$driver:$db"
89
90
91
92
93
94
95
                        ,$db_user,$db_pass,{RaiseError => 1
                        , PrintError=> 0 });

}

sub _init_config {
    my $file = shift;
96
97

    my $connector = shift;
98
    confess "Deprecated connector" if $connector;
99

100
    $CONFIG = YAML::LoadFile($file);
101
#    $CONNECTOR = ( $connector or _connect_dbh());
102
103
}

104
sub _create_vm_kvm {
105
    my $self = shift;
106

107
108
109
110
    my $cmd_qemu_img = `which qemu-img`;
    chomp $cmd_qemu_img;

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

    my $vm_kvm;
113

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

    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
126
127
    $err_kvm .= ($@ or '');
    return ($vm_kvm,$err_kvm);
128
129
130
131
132
133
134
135
136
}

sub _create_vm {
    my $self = shift;

    my @vms = ();

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

137
138
139
140
141
142
143
144
    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
145
        confess "No VMs found: $err_lxc\n$err_kvm\n";
146
147
148
    }
    return \@vms;

149
150
}

Francesc Guasch's avatar
Francesc Guasch committed
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
=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


170
sub create_domain {
171
172
    my $self = shift;

173
174
    my %args = @_;

175
176
177
    croak "Argument id_owner required "
        if !$args{id_owner};

178
179
    my $vm_name = $args{vm};
    delete $args{vm};
180

Francesc Guasch's avatar
Francesc Guasch committed
181
182
183
    my $request = $args{request}            if $args{request};

    $request->status("Searching for VM")    if $request;
Francesc Guasch's avatar
Francesc Guasch committed
184

185
    my $vm = $self->vm->[0];
186
    $vm = $self->search_vm($vm_name)   if $vm_name;
187

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

191
    confess "I can't find any vm ".Dumper($self->vm) if !$vm;
Francesc Guasch's avatar
Francesc Guasch committed
192

193
    $request->status("creating domain in ".ref($vm))    if $request;
194
    return $vm->create_domain(@_);
195
196
}

Francesc Guasch's avatar
Francesc Guasch committed
197
198
199
200
201
202
203
204
=head2 remove_domain

Removes a domain

  $ravada->remove_domain($name);

=cut

205
206
sub remove_domain {
    my $self = shift;
207
208
    my %arg = @_;

209
    confess "Argument name required "
210
211
        if !$arg{name};

212
213
    confess "Argument uid required "
        if !$arg{uid};
214
215
216
217
218
219

    lock_hash(%arg);

    my $domain = $self->search_domain($arg{name}, 1)
        or confess "ERROR: I can't find domain $arg{name}";

220
221
    my $user = Ravada::Auth::SQL->search_by_id( $arg{uid});
    $domain->remove( $user);
222
223
}

Francesc Guasch's avatar
Francesc Guasch committed
224
225
226
227
228
229
=head2 search_domain

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

=cut

230
231
232
sub search_domain {
    my $self = shift;
    my $name = shift;
233
    my $import = shift;
234
235

    for my $vm (@{$self->vm}) {
Francesc Guasch's avatar
Francesc Guasch committed
236
        my $domain = $vm->search_domain($name, $import);
237
        next if !$domain;
238
        next if !$domain->_select_domain_db && !$import;
239
240
241
        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
242
        warn $@ if $@   && $DEBUG;
243
        return $domain if $id || $import;
244
    }
245
246
247
248
249
250
251
252

    my $vm = $self->search_vm('Void');
    warn "No Void VM" if !$vm;
    return if !$vm;

    my $domain = $vm->search_domain($name, $import);
    return $domain if $domain;

253
    return;
254
}
255

Francesc Guasch's avatar
Francesc Guasch committed
256
257


258
259
=head2 list_domains

Francesc Guasch's avatar
Francesc Guasch committed
260
List all created domains
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276

  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;
}

277
278
279
280
281
282
283
284
285
286
287
288
289
=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;
290
291
292
293
294
295
    my $sth = $CONNECTOR->dbh->prepare(
        "SELECT * FROM domains ORDER BY name"
    );
    $sth->execute;
    while (my $row = $sth->fetchrow_hashref) {
        push @domains,($row);
296
    }
297
    $sth->finish;
298
    return \@domains;
299
300
}

301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
# 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;
# }

318

Francesc Guasch's avatar
Francesc Guasch committed
319
320
321
322
323
324
325
326
327
328
329
330
331
332
=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) {
333
334
335
            eval { $domain->id };
            warn $@ if $@;
            next    if $@;
Francesc Guasch's avatar
Francesc Guasch committed
336
337
338
339
340
341
            push @domains,($domain) if $domain->is_base;
        }
    }
    return @domains;
}

342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
=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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
=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;
}

377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
=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
392

fv3rdugo's avatar
fv3rdugo committed
393
394
395
396
sub list_images_lxc {
    my $self = shift;
    my @domains;
    my $sth = $CONNECTOR->dbh->prepare(
397
        "SELECT * FROM lxc_templates ORDER BY name"
fv3rdugo's avatar
fv3rdugo committed
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
    );
    $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
424
425
426
427
=head2 remove_volume

  $ravada->remove_volume($file);

Francesc Guasch's avatar
Francesc Guasch committed
428

Francesc Guasch's avatar
Francesc Guasch committed
429
430
=cut

431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
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";
    }

}
451

Francesc Guasch's avatar
Francesc Guasch committed
452
453
454
455
456
457
458
459
=head2 process_requests

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

  $ravada->process_requests();

=cut

460
461
sub process_requests {
    my $self = shift;
462
    my $debug = shift;
463
    my $dont_fork = shift;
464

465
466
    $self->_wait_pids_nohang();

467
468
469
    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
470
        my $req = Ravada::Request->open($id);
471
        warn "executing request ".$req." ".Dumper($req) if $DEBUG || $debug;
472
        eval { $self->_execute($req, $dont_fork) };
473
474
        if ($@) {
            $req->error($@);
475
            $req->status('done');
476
        }
477
478
479
        warn "req ".$req->id." , command: ".$req->command." , status: ".$req->status()
            ." , error: '".($req->error or 'NONE')."'" 
                if $DEBUG || $debug;
480
481
482
483
    }
    $sth->finish;
}

484
485
sub _process_requests_dont_fork {
    my $self = shift;
486
487
    my $debug = shift;
    return $self->process_requests($debug,1);
488
}
Francesc Guasch's avatar
Francesc Guasch committed
489

490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
=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;
}

507
508
509
sub _execute {
    my $self = shift;
    my $request = shift;
510
    my $dont_fork = shift;
511

Francesc Guasch's avatar
Francesc Guasch committed
512
513
514
515
516
    my $sub = $self->_req_method($request->command);

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

517
    return $sub->($self,$request, $dont_fork);
Francesc Guasch's avatar
Francesc Guasch committed
518
519
520

}

521
522
523
524
525
526
527
528
529
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});
530
531
    my $user = Ravada::Auth::SQL->search_by_id( $request->args->{uid});
    my $display = $domain->display($user);
532
533
534
535
    $request->result({display => $display});

    $request->status('done');

536
537
}

538
sub _do_cmd_create{
Francesc Guasch's avatar
Francesc Guasch committed
539
540
541
    my $self = shift;
    my $request = shift;

542
    $request->status('creating domain');
543
    warn "$$ creating domain"   if $DEBUG;
544
    my $domain;
545
    $domain = $self->create_domain(%{$request->args},request => $request);
Francesc Guasch's avatar
Francesc Guasch committed
546
    warn $@ if $@;
547

Francesc Guasch's avatar
Francesc Guasch committed
548
549
550
551
552
    $request->status('done');
    $request->error($@);

}

553
554
555
556
557
558
559
560
561
562
563
sub _wait_pids_nohang {
    my $self = shift;
    return if !keys %{$self->{pids}};

    my $kid = waitpid(-1 , WNOHANG);
    return if !$kid;

    warn "Kid $kid finished";
    delete $self->{pids}->{$kid};
}

Francesc Guasch's avatar
Francesc Guasch committed
564
565
566
567
568
sub _wait_pids {
    my $self = shift;
    my $request = shift;

    for my $pid ( keys %{$self->{pids}}) {
569
570
571
        $request->status("waiting for pid $pid")    if $request;

#        warn "Checking for pid '$pid' created at ".localtime($self->{pids}->{$pid});
Francesc Guasch's avatar
Francesc Guasch committed
572
573
        my $kid = waitpid($pid,0);

574
#        warn "Found $kid";
Francesc Guasch's avatar
Francesc Guasch committed
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
        return if $kid  == $pid;
    }
}

sub _add_pid {
    my $self = shift;
    my $pid = shift;

    $self->{pids}->{$pid} = time;
}

sub _cmd_create {

    my $self = shift;
    my $request = shift;
590
591
592
593
    my $dont_fork = shift;

    return $self->_do_cmd_create($request)
        if $dont_fork;
Francesc Guasch's avatar
Francesc Guasch committed
594
595
596
597
598
599
600
601
602
603
604
605
606

    $request->status('waiting for other tasks');

    $self->_wait_pids($request);

    $request->status('forking');
    my $pid = fork();
    if (!defined $pid) {
        $request->status('done');
        $request->error("I can't fork");
        return;
    }
    if ($pid == 0 ) {
607
        $self->_do_cmd_create($request);
Francesc Guasch's avatar
Francesc Guasch committed
608
609
610
611
612
613
        exit;
    }
    $self->_add_pid($pid);
    return;
}

Francesc Guasch's avatar
Francesc Guasch committed
614
615
616
617
618
sub _cmd_remove {
    my $self = shift;
    my $request = shift;

    $request->status('working');
619
620
621
622
    confess "Unknown user id ".$request->args->{uid}
        if !defined $request->args->{uid};

    $self->remove_domain(name => $request->args('name'), uid => $request->args('uid'));
Francesc Guasch's avatar
Francesc Guasch committed
623
624
    $request->status('done');
    $request->error($@);
Francesc Guasch's avatar
Francesc Guasch committed
625

626
}
Francesc Guasch's avatar
Francesc Guasch committed
627

Francesc Guasch's avatar
Francesc Guasch committed
628
629
630
631
632
633
sub _cmd_start {
    my $self = shift;
    my $request = shift;

    $request->status('working');
    my $name = $request->args('name');
634
635
636
    my $domain = $self->search_domain($name);
    die "Unknown domain '$name'" if !$domain;
    $domain->start();
637

Francesc Guasch's avatar
Francesc Guasch committed
638
    $request->status('done');
639
    $request->error($@ or '');
Francesc Guasch's avatar
Francesc Guasch committed
640
641
642

}

Francesc Guasch's avatar
Francesc Guasch committed
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
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
660
661
662
663
664
665
sub _cmd_shutdown {
    my $self = shift;
    my $request = shift;

    $request->status('working');
    my $name = $request->args('name');
666
667
    my $timeout = ($request->args('timeout') or 60);
    my $domain;
Francesc Guasch's avatar
Francesc Guasch committed
668
    eval { 
669
        $domain = $self->search_domain($name);
Francesc Guasch's avatar
Francesc Guasch committed
670
        die "Unknown domain '$name'\n" if !$domain;
671
        $domain->shutdown(timeout => $timeout);
Francesc Guasch's avatar
Francesc Guasch committed
672
673
674
675
676
677
    };
    $request->status('done');
    $request->error($@);

}

678
679
680
681
682
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
683
    $request->result(\@list_types);
684
685
    $request->status('done');
}
Francesc Guasch's avatar
Francesc Guasch committed
686

687
688
689
690
691
692
693
sub _cmd_ping_backend {
    my $self = shift;
    my $request = shift;

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

Francesc Guasch's avatar
Francesc Guasch committed
695
696
697
698
699
sub _req_method {
    my $self = shift;
    my  $cmd = shift;

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

Francesc Guasch's avatar
Francesc Guasch committed
701
702
703
          start => \&_cmd_start
        ,create => \&_cmd_create
        ,remove => \&_cmd_remove
Francesc Guasch's avatar
Francesc Guasch committed
704
      ,shutdown => \&_cmd_shutdown
705
    ,domdisplay => \&_cmd_domdisplay
706
  ,ping_backend => \&_cmd_ping_backend
Francesc Guasch's avatar
Francesc Guasch committed
707
  ,prepare_base => \&_cmd_prepare_base
708
 ,list_vm_types => \&_cmd_list_vm_types
Francesc Guasch's avatar
Francesc Guasch committed
709
710
711
712
    );
    return $methods{$cmd};
}

713
714
715
716
717
718
719
720
721
722
723
724
=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;

725
726
    confess "Missing VM type"   if !$type;

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

729
    if ($type =~ /Void/i) {
730
731
732
        return Ravada::VM::Void->new();
    }

Francesc Guasch's avatar
Francesc Guasch committed
733
734
735
    my @vms;
    eval { @vms = @{$self->vm} };
    for my $vm (@vms) {
736
737
738
739
        return $vm if ref($vm) eq $class;
    }
    return;
}
Francesc Guasch's avatar
Francesc Guasch committed
740

Francesc Guasch's avatar
Francesc Guasch committed
741
742
743
744
745
746
747
748
749
750
=head1 AUTHOR

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

=head1 SEE ALSO

Sys::Virt

=cut

751
1;