Request.pm 34.1 KB
Newer Older
1
2
3
4
5
package Ravada::Request;

use strict;
use warnings;

6
7
8
9
10
11
=head1 NAME

Ravada::Request - Requests library for Ravada

=cut

12
13
use Carp qw(confess);
use Data::Dumper;
14
use Hash::Util qw(lock_hash);
15
16
use JSON::XS;
use Hash::Util;
Francesc Guasch's avatar
Francesc Guasch committed
17
use Time::Piece;
18
19
use Ravada;
use Ravada::Front;
Francesc Guasch's avatar
Francesc Guasch committed
20
use Ravada::Utils;
21
22
23

use vars qw($AUTOLOAD);

24
25
26
no warnings "experimental::signatures";
use feature qw(signatures);

27
28
29
30
31
32
=pod

Request a command to the ravada backend

=cut

Francesc Guasch's avatar
Francesc Guasch committed
33
my $COUNT = 0;
Francesc Guasch's avatar
Francesc Guasch committed
34
our %FIELD = map { $_ => 1 } qw(error output);
35
36
37
our %FIELD_RO = map { $_ => 1 } qw(id name);

our $args_manage = { name => 1 , uid => 1 };
38
our $args_prepare = { id_domain => 1 , uid => 1, with_cd => 2 };
39
40
41
42
43
our $args_remove_base = { id_domain => 1 , uid => 1 };
our $args_manage_iptables = {uid => 1, id_domain => 1, remote_ip => 1};

our %VALID_ARG = (
    create_domain => {
frankiejol's avatar
frankiejol committed
44
              vm => 2
45
46
           ,name => 1
           ,swap => 2
Francesc Guasch's avatar
Francesc Guasch committed
47
         ,id_iso => 2
48
         ,iso_file => 2
Francesc Guasch's avatar
Francesc Guasch committed
49
        ,id_base => 2
50
       ,id_owner => 1
Francesc Guasch's avatar
Francesc Guasch committed
51
    ,id_template => 2
52
53
         ,memory => 2
           ,disk => 2
Francesc Guasch's avatar
Francesc Guasch committed
54
           #        ,network => 2
55
56
      ,remote_ip => 2
          ,start => 2
Francesc Guasch's avatar
Francesc Guasch committed
57
           ,data => 2
58
59
60
61
    }
    ,open_iptables => $args_manage_iptables
      ,remove_base => $args_remove_base
     ,prepare_base => $args_prepare
Francesc Guasch's avatar
Francesc Guasch committed
62
     ,spinoff => { id_domain => 1, uid => 1 }
63
64
65
     ,pause_domain => $args_manage
    ,resume_domain => {%$args_manage, remote_ip => 1 }
    ,remove_domain => $args_manage
Francesc Guasch's avatar
Francesc Guasch committed
66
    ,restore_domain => { id_domain => 1, uid => 1 }
67
    ,shutdown_domain => { name => 2, id_domain => 2, uid => 1, timeout => 2, at => 2
68
                       , check => 2
69
                       , id_vm => 2 }
70
    ,force_shutdown_domain => { id_domain => 1, uid => 1, at => 2, id_vm => 2 }
Roberto P. Rubio's avatar
Roberto P. Rubio committed
71
72
    ,reboot_domain => { name => 2, id_domain => 2, uid => 1, timeout => 2, at => 2
                       , id_vm => 2 }
Roberto P. Rubio's avatar
Roberto P. Rubio committed
73
    ,force_reboot_domain => { id_domain => 1, uid => 1, at => 2, id_vm => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
74
    ,screenshot => { id_domain => 1 }
Francesc Guasch's avatar
Francesc Guasch committed
75
    ,domain_autostart => { id_domain => 1 , uid => 1, value => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
76
    ,copy_screenshot => { id_domain => 1 }
Francesc Guasch's avatar
Francesc Guasch committed
77
    ,start_domain => {%$args_manage, remote_ip => 2, name => 2, id_domain => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
78
    ,start_clones => { id_domain => 1, uid => 1, remote_ip => 1, sequential => 2 }
79
    ,shutdown_clones => { id_domain => 1, uid => 1, timeout => 2 }
80
    ,rename_domain => { uid => 1, name => 1, id_domain => 1}
81
    ,dettach => { uid => 1, id_domain => 1 }
82
    ,set_driver => {uid => 1, id_domain => 1, id_option => 1}
83
    ,hybernate=> {uid => 1, id_domain => 1}
Francesc Guasch's avatar
Francesc Guasch committed
84
    ,download => {uid => 2, id_iso => 1, id_vm => 2, verbose => 2, delay => 2, test => 2}
85
    ,refresh_storage => { id_vm => 2 }
86
    ,list_storage_pools => { id_vm => 1 , uid => 1 }
87
    ,check_storage => { uid => 1 }
88
    ,set_base_vm=> {uid => 1, id_vm=> 1, id_domain => 1, value => 2 }
89
    ,cleanup => { timeout => 2 }
90
    ,clone => { uid => 1, id_domain => 1, name => 2, memory => 2, number => 2, volatile => 2, id_owner => 2
Francesc Guasch's avatar
Francesc Guasch committed
91
92
93
94
95
96
97
                # If base has pools, from_pool = 1 if undefined
                # when from_pool is true the clone is picked from the pool
                # when from_pool is false the clone is created
                ,from_pool => 2
                # If base has pools, create anew and add to the pool
                ,add_to_pool => 2
                ,start => 2,
Francesc Guasch's avatar
Francesc Guasch committed
98
                ,remote_ip => 2
99
                ,with_cd => 2
Francesc Guasch's avatar
Francesc Guasch committed
100
    }
Joel Alarcón's avatar
Joel Alarcón committed
101
    ,change_owner => {uid => 1, id_domain => 1}
Francesc Guasch's avatar
Francesc Guasch committed
102
    ,add_hardware => {uid => 1, id_domain => 1, name => 1, number => 2, data => 2 }
103
    ,remove_hardware => {uid => 1, id_domain => 1, name => 1, index => 1}
Francesc Guasch's avatar
Francesc Guasch committed
104
    ,change_hardware => {uid => 1, id_domain => 1, hardware => 1, index => 2, data => 1 }
105
    ,enforce_limits => { timeout => 2, _force => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
106
    ,refresh_machine => { id_domain => 1, uid => 1 }
107
    ,refresh_machine_ports => { id_domain => 1, uid => 1 }
Francesc Guasch's avatar
Francesc Guasch committed
108
    ,rebase => { uid => 1, id_base => 1, id_domain => 1 }
109
    ,set_time => { uid => 1, id_domain => 1 }
Francesc Guasch's avatar
Francesc Guasch committed
110
    ,rsync_back => { uid => 1, id_domain => 1, id_node => 1 }
Francesc Guasch's avatar
Francesc Guasch committed
111
112
113
114
    # ports
    ,expose => { uid => 1, id_domain => 1, port => 1, name => 2, restricted => 2, id_port => 2}
    ,remove_expose => { uid => 1, id_domain => 1, port => 1}
    ,open_exposed_ports => {uid => 1, id_domain => 1 }
Francesc Guasch's avatar
Francesc Guasch committed
115
    ,close_exposed_ports => { uid => 1, id_domain => 1, port => 2, clean => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
116
    # Virtual Managers or Nodes
Francesc Guasch's avatar
Francesc Guasch committed
117
    ,refresh_vms => { _force => 2, timeout_shutdown => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
118
119
120
121

    ,shutdown_node => { id_node => 1, at => 2 }
    ,start_node => { id_node => 1, at => 2 }
    ,connect_node => { backend => 2, hostname => 2, id_node =>2, timeout => 2 }
122
123
124
    ,migrate => { uid => 1, id_node => 1, id_domain => 1, start => 2, remote_ip => 2
        ,shutdown => 2, shutdown_timeout => 2
    }
Francesc Guasch's avatar
Francesc Guasch committed
125
126
    ,compact => { uid => 1, id_domain => 1 , keep_backup => 2 }
      ,purge => { uid => 1, id_domain => 1 }
Francesc Guasch's avatar
Francesc Guasch committed
127

Francesc Guasch's avatar
Francesc Guasch committed
128
    #users
129
    ,post_login => { user => 1, locale => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
130

Francesc Guasch's avatar
Francesc Guasch committed
131
132
133
    #networks
    ,list_network_interfaces => { uid => 1, vm_type => 1, type => 2 }

Fernando Verdugo's avatar
Fernando Verdugo committed
134
135
136
    #isos
    ,list_isos => { vm_type => 1 }

Francesc Guasch's avatar
Francesc Guasch committed
137
    ,manage_pools => { uid => 2, id_domain => 2 }
138
    ,ping_backend => {}
139
140
141
);

our %CMD_SEND_MESSAGE = map { $_ => 1 }
142
    qw( create start shutdown force_shutdown reboot prepare_base remove remove_base rename_domain screenshot download
Francesc Guasch's avatar
Francesc Guasch committed
143
            clone
144
            set_base_vm remove_base_vm
Francesc Guasch's avatar
Francesc Guasch committed
145
            domain_autostart hibernate hybernate
Francesc Guasch's avatar
Francesc Guasch committed
146
            change_owner
Francesc Guasch's avatar
Francesc Guasch committed
147
            add_hardware remove_hardware set_driver change_hardware
Francesc Guasch's avatar
Francesc Guasch committed
148
            expose remove_expose
Francesc Guasch's avatar
Francesc Guasch committed
149
            rebase rebase_volumes
Roberto P. Rubio's avatar
Roberto P. Rubio committed
150
            shutdown_node reboot_node start_node
151
    );
152

153
154
155
156
our %CMD_NO_DUPLICATE = map { $_ => 1 }
qw(
    set_base_vm
    remove_base_vm
Francesc Guasch's avatar
Francesc Guasch committed
157
158
    rsync_back
    cleanup
159
160
);

Francesc Guasch's avatar
Francesc Guasch committed
161
our $TIMEOUT_SHUTDOWN = 120;
Roberto P. Rubio's avatar
Roberto P. Rubio committed
162
our $TIMEOUT_REBOOT = 20;
Francesc Guasch's avatar
Francesc Guasch committed
163

164
165
our $CONNECTOR;

166
our %COMMAND = (
Francesc Guasch's avatar
Francesc Guasch committed
167
168
    long => {
        limit => 4
Francesc Guasch's avatar
Francesc Guasch committed
169
        ,priority => 10
Francesc Guasch's avatar
Francesc Guasch committed
170
    } #default
Francesc Guasch's avatar
Francesc Guasch committed
171
172
173
174
175
176

    # list from low to high priority
    ,disk_low_priority => {
        limit => 2
        ,commands => ['rsync_back','check_storage', 'refresh_vms']
        ,priority => 30
177
    }
178
179
    ,disk => {
        limit => 1
180
        ,commands => ['prepare_base','remove_base','set_base_vm','rebase_volumes'
181
                    , 'remove_base_vm'
Francesc Guasch's avatar
Francesc Guasch committed
182
                    , 'screenshot'
Francesc Guasch's avatar
Francesc Guasch committed
183
                    , 'cleanup'
Francesc Guasch's avatar
Francesc Guasch committed
184
                    , 'compact'
185
                ]
Francesc Guasch's avatar
Francesc Guasch committed
186
        ,priority => 20
187
    }
Francesc Guasch's avatar
Francesc Guasch committed
188
189
190
191
    ,huge => {
        limit => 1
        ,commands => ['download']
        ,priority => 15
192
    }
Francesc Guasch's avatar
Francesc Guasch committed
193

Francesc Guasch's avatar
Francesc Guasch committed
194
195
    ,secondary => {
        limit => 50
Francesc Guasch's avatar
Francesc Guasch committed
196
        ,priority => 4
197
198
199
        ,commands => ['shutdown','shutdown_now', 'manage_pools','enforce_limits', 'set_time'
            ,'remove_domain'
        ]
Francesc Guasch's avatar
Francesc Guasch committed
200
201
202
203
204
205
    }

    ,important=> {
        limit => 20
        ,priority => 1
        ,commands => ['clone','start','start_clones','shutdown_clones','create','open_iptables','list_network_interfaces','list_isos','ping_backend','refresh_machine']
Francesc Guasch's avatar
Francesc Guasch committed
206
    }
207
208
209
);
lock_hash %COMMAND;

210
211
212
213
214
215
216
217
218
219
sub _init_connector {
    $CONNECTOR = \$Ravada::CONNECTOR;
    $CONNECTOR = \$Ravada::Front::CONNECTOR   if !$$CONNECTOR;

}

=head2 BUILD

    Internal object builder, do not call

220
=cut
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258

sub BUILD {
    _init_connector();
}

sub _request {
    my $proto = shift;
    my $class=ref($proto) || $proto;

    my $self = {};
    bless ($self, $class);
    return $self;
}

=head2 open

Opens the information of a previous request by id

  my $req = Ravada::Request->open($id);

=cut

sub open {
    my $proto = shift;
    my $class = ref($proto) || $proto;

    my $id = shift or confess "Missing request id";

    _init_connector()   if !$CONNECTOR || !$$CONNECTOR;

    my $sth = $$CONNECTOR->dbh->prepare("SELECT * FROM requests "
        ." WHERE id=?");
    $sth->execute($id);
    my $row = $sth->fetchrow_hashref;

    confess "I can't find id=$id " if !defined $row;
    $sth->finish;

259
260
    my $args = {};
    $args = decode_json($row->{args}) if $row->{args};
261
262
263
264

    $row->{args} = $args;

    bless ($row, $class);
Francesc Guasch's avatar
Francesc Guasch committed
265
266
    $row->{priority} = $row->_set_priority();

267
268
269
    return $row;
}

270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
=head2 info

Returns information of the request

=cut

sub info {
    my $self = shift;
    my $user = shift;
    confess "USER ".$user->name." not authorized"
        unless $user->is_admin
            || ($self->defined_arg('uid') && $user->id == $self->args('uid'))
            || ($self->defined_arg('id_owner') && $user->id == $self->args('id_owner'));

    return {
Francesc Guasch's avatar
Francesc Guasch committed
285
286
        id => $self->id
        ,status => $self->status
287
288
        ,error => $self->error
        ,id_domain => $self->id_domain
289
        ,output => $self->output
290
291
292
    }
}

293
294
=head2 create_domain

Francesc Guasch's avatar
Francesc Guasch committed
295
296
    my $req = Ravada::Request->create_domain(
                        name => 'bla'
297
298
299
300
301
302
303
304
305
306
307
308
                    , id_iso => 1
    );


=cut

sub create_domain {
    my $proto = shift;
    my $class=ref($proto) || $proto;

    my %args = @_;

Francesc Guasch's avatar
Francesc Guasch committed
309
    my $args = _check_args('create_domain', @_ );
310

311
312
313
    confess "ERROR: Argument vm required without id_base"
        if !exists $args->{vm} && !exists $args->{id_base};

314
    my $self = {};
Francesc Guasch's avatar
Francesc Guasch committed
315
316
    if ($args->{network}) {
        $args->{network} = JSON::XS->new->convert_blessed->encode($args->{network});
317
318
319
    }

    bless($self,$class);
Francesc Guasch's avatar
Francesc Guasch committed
320
    return $self->_new_request(command => 'create' , args => encode_json($args));
321
322
323
324
}

=head2 remove_domain

Francesc Guasch's avatar
Francesc Guasch committed
325
326
    my $req = Ravada::Request->remove_domain(
                     name => 'bla'
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
                    , uid => $user->id
    );


=cut


sub remove_domain {
    my $proto = shift;
    my $class=ref($proto) || $proto;

    my %args = @_;
    confess "Missing domain name"   if !$args{name};
    confess "Name is not scalar"    if ref($args{name});
    confess "Missing uid"           if !$args{uid};

    for (keys %args) {
        confess "Invalid argument $_" if !$VALID_ARG{'remove_domain'}->{$_};
    }

    my $self = {};
    bless($self,$class);

350
    return $self->_new_request(command => 'remove' , args => \%args);
351
352
353
354
355
356
357

}

=head2 start_domain

Requests to start a domain

Francesc Guasch's avatar
Francesc Guasch committed
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
  my $req = Ravada::Request->start_domain(
     name => 'name'
    , uid => $user->id
  );

Mandatory arguments: one of those must be passed:

=over

=item * name or id_domain

=item * uid: user id

=item * remote_ip: [optional] IP of the remote client that requested to start the domain

=back
374
375
376
377
378
379
380
381
382

=cut

sub start_domain {
    my $proto = shift;
    my $class=ref($proto) || $proto;

    my $args = _check_args('start_domain', @_);

383
384
385
    confess "ERROR: choose either id_domain or name "
        if $args->{id_domain} && $args->{name};

Francesc Guasch's avatar
Francesc Guasch committed
386
387
388
    confess "Error: remote ip invalid '$args->{remote_ip}'"
    if $args->{remote_ip} && $args->{remote_ip} !~ /^(localhost|\d+\.\d+\.\d+\.\d+)$/;

Francesc Guasch's avatar
Francesc Guasch committed
389
390
    _remove_low_priority_requests($args->{id_domain} or $args->{name});

391
392
393
    my $self = {};
    bless($self,$class);

394
    return $self->_new_request(command => 'start' , args => $args);
395
396
}

Francesc Guasch's avatar
Francesc Guasch committed
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
sub _remove_low_priority_requests($id_domain) {

    _init_connector()   if !$CONNECTOR || !$$CONNECTOR;

    if ($id_domain !~ /^\d+$/) {
        $id_domain = _search_domain_id(undef,$id_domain);
    }
    for my $command (sort @{$COMMAND{disk_low_priority}->{commands}}) {
        my $sth = $$CONNECTOR->dbh->prepare("SELECT id FROM requests "
            ." WHERE command=? AND id_domain=? "
            ."    AND status <> 'done' "
        );
        $sth->execute($command, $id_domain);
        while ( my ($id_request) = $sth->fetchrow ) {
            my $req = Ravada::Request->open($id_request);
            $req->stop();
            warn "Stopping request $id_request";
        }
    }

}


420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
=head2 start_clones

Requests to start the clones of a base

  my $req = Ravada::Request->start_clones( name => 'name', uid => $user->id );

=cut

sub start_clones {
    my $proto = shift;
    my $class=ref($proto) || $proto;

    my $args = _check_args('start_clones', @_);

    my $self = {};
    bless($self,$class);

437
    return $self->_new_request(command => 'start_clones' , args => $args);
438
439
}

440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
=head2 pause_domain

Requests to pause a domain

  my $req = Ravada::Request->pause_domain( name => 'name', uid => $user->id );

=cut

sub pause_domain {
    my $proto = shift;
    my $class=ref($proto) || $proto;

    my $args = _check_args('pause_domain', @_);

    my $self = {};
    bless($self,$class);

457
    return $self->_new_request(command => 'pause' , args => $args);
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
}

=head2 resume_domain

Requests to pause a domain

  my $req = Ravada::Request->resume_domain( name => 'name', uid => $user->id );

=cut

sub resume_domain {
    my $proto = shift;
    my $class=ref($proto) || $proto;

    my $args = _check_args('resume_domain', @_);

    my $self = {};
    bless($self,$class);

477
    return $self->_new_request(command => 'resume' , args => $args);
478
479
480
481
482
483
}



sub _check_args {
    my $sub = shift;
Francesc Guasch's avatar
Francesc Guasch committed
484
    confess "Odd number of elements ".Dumper(\@_)   if scalar(@_) % 2;
485
486
487
    my $args = { @_ };

    my $valid_args = $VALID_ARG{$sub};
488
    for (qw(at after_request after_request_ok retry _no_duplicate _force)) {
489
490
        $valid_args->{$_}=2 if !exists $valid_args->{$_};
    }
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509

    confess "Unknown method $sub" if !$valid_args;
    for (keys %{$args}) {
        confess "Invalid argument $_ , valid args ".Dumper($valid_args)
            if !$valid_args->{$_};
    }

    for (keys %{$VALID_ARG{$sub}}) {
        next if $VALID_ARG{$sub}->{$_} == 2; # optional arg
        confess "Missing argument $_"   if !exists $args->{$_};
    }

    return $args;
}

=head2 force_shutdown_domain

Requests to stop a domain now !

Roberto P. Rubio's avatar
Roberto P. Rubio committed
510
  my $req = Ravada::Request->force_shutdown_domain( name => 'name' , uid => $user->id );
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541

=cut

sub force_shutdown_domain {
    my $proto = shift;
    my $class=ref($proto) || $proto;

    my $args = _check_args('force_shutdown_domain', @_ );

    my $self = {};
    bless($self,$class);

    return $self->_new_request(command => 'force_shutdown' , args => $args);
}

=head2 shutdown_domain

Requests to stop a domain

  my $req = Ravada::Request->shutdown_domain( name => 'name' , uid => $user->id );
  my $req = Ravada::Request->shutdown_domain( name => 'name' , uid => $user->id
                                            ,timeout => $timeout );

=cut

sub shutdown_domain {
    my $proto = shift;
    my $class=ref($proto) || $proto;

    my $args = _check_args('shutdown_domain', @_ );

Francesc Guasch's avatar
Francesc Guasch committed
542
543
544
    confess "ERROR: You must supply either id_domain or name ".Dumper($args)
        if !$args->{id_domain} && !$args->{name};

545
546
547
    my $self = {};
    bless($self,$class);

548
    return $self->_new_request(command => 'shutdown' , args => $args);
549
550
}

Roberto P. Rubio's avatar
Roberto P. Rubio committed
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
=head2 force_reboot_domain

Requests to stop a domain now !

  my $req = Ravada::Request->force_reboot_domain( name => 'name' , uid => $user->id );

=cut

sub force_reboot_domain {
    my $proto = shift;
    my $class=ref($proto) || $proto;

    my $args = _check_args('force_reboot_domain', @_ );

    my $self = {};
    bless($self,$class);

    return $self->_new_request(command => 'force_reboot' , args => $args);
}

Roberto P. Rubio's avatar
Roberto P. Rubio committed
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
=head2 reboot_domain

Requests to reboot a domain

  my $req = Ravada::Request->reboot_domain( name => 'name' , uid => $user->id );
  my $req = Ravada::Request->reboot_domain( name => 'name' , uid => $user->id
                                            ,timeout => $timeout );

=cut

sub reboot_domain {
    my $proto = shift;
    my $class=ref($proto) || $proto;

    my $args = _check_args('reboot_domain', @_ );

    $args->{timeout} = $TIMEOUT_REBOOT if !exists $args->{timeout};

    confess "ERROR: You must supply either id_domain or name ".Dumper($args)
        if !$args->{id_domain} && !$args->{name};

    my $self = {};
    bless($self,$class);

    return $self->_new_request(command => 'reboot' , args => $args);
596
597
}

Francesc Guasch's avatar
Francesc Guasch committed
598
599
600
601
602
603
604
605
606
607
608
609
=head2 new_request

Creates a new request

    $req = Ravada::Request->new_request(
        start_domain
        ,uid => $user->id
        ,id_domain => $domain->id
    );

=cut

Francesc Guasch's avatar
Francesc Guasch committed
610
611
612
613
614
615
616
617
618
sub new_request($self, $command, @args) {
    die "Error: Unknown request '$command'" if !$VALID_ARG{$command};
    return _new_request(
        $self
        ,command => $command
           ,args => _check_args($command, @args)
    );
}

619
sub _duplicated_request($self=undef, $command=undef, $args=undef) {
Francesc Guasch's avatar
Francesc Guasch committed
620
    _init_connector()   if !$CONNECTOR || !$$CONNECTOR;
621
622
623
624
625
626
627
628
629
630

    my $args_d;
    if ($self) {
        confess "Error: do not supply args if you supply request" if $args;
        confess "Error: do not supply command if you supply request" if $command;
        $args_d = $self->args;
        $command = $self->command;
    } else {
        $args_d = decode_json($args);
    }
Francesc Guasch's avatar
Francesc Guasch committed
631
    delete $args_d->{uid};
632
    delete $args_d->{at};
Francesc Guasch's avatar
Francesc Guasch committed
633
    my $sth = $$CONNECTOR->dbh->prepare(
Francesc Guasch's avatar
Francesc Guasch committed
634
        "SELECT id,args FROM requests WHERE (status <> 'done')"
Francesc Guasch's avatar
Francesc Guasch committed
635
636
637
638
        ." AND command=?"
    );
    $sth->execute($command);
    while (my ($id,$args_found) = $sth->fetchrow) {
639
        next if $self && $self->id == $id;
Francesc Guasch's avatar
Francesc Guasch committed
640
641
642

        my $args_found_d = decode_json($args_found);
        delete $args_found_d->{uid};
643
        delete $args_found_d->{at};
Francesc Guasch's avatar
Francesc Guasch committed
644
645
646
647
648
649

        next if join(".",sort keys %$args_d) ne join(".",sort keys %$args_found_d);
        my $args_d_s = join(".",map { $args_d->{$_} } sort keys %$args_d);
        my $args_found_s = join(".",map {$args_found_d->{$_} } sort keys %$args_found_d);
        next if $args_d_s ne $args_found_s;

Francesc Guasch's avatar
Francesc Guasch committed
650
        return Ravada::Request->open($id);
Francesc Guasch's avatar
Francesc Guasch committed
651
652
653
654
    }
    return 0;
}

655
656
sub _new_request {
    my $self = shift;
657
658
659
    if ( !ref($self) ) {
        my $proto = $self ;
        my $class = ref($proto) || $proto;
Francesc Guasch's avatar
Francesc Guasch committed
660
661
662
        $self = {};
        bless ($self, $class);
    }
663
664
    my %args = @_;

Francesc Guasch's avatar
Francesc Guasch committed
665
    $args{status} = 'requested';
666
667
668
669
670

    if ($args{name}) {
        $args{domain_name} = $args{name};
        delete $args{name};
    }
Francesc Guasch's avatar
Francesc Guasch committed
671
    my $no_duplicate = delete $args{_no_duplicate};
Francesc Guasch's avatar
Francesc Guasch committed
672
    my $uid;
673
674
675
    if ( ref $args{args} ) {
        $args{args}->{uid} = $args{args}->{id_owner}
            if !exists $args{args}->{uid};
Francesc Guasch's avatar
Francesc Guasch committed
676
677
        $uid = $args{args}->{uid} if exists $args{args}->{uid};

678
        $args{at_time} = $args{args}->{at} if exists $args{args}->{at};
679
680
681
682
683
684
685
        my $id_domain_args = $args{args}->{id_domain};

        if ($id_domain_args) {
            confess "ERROR: Different id_domain: ".Dumper(\%args)
                if $args{id_domain} && $args{id_domain} ne $id_domain_args;
            $args{id_domain} = $id_domain_args;
        }
686
687
688
689
690
        for (qw(after_request after_request_ok retry)) {
            $args{$_} = delete $args{args}->{$_}
            if exists $args{args}->{$_};
        }

691
692
693
        $args{args} = encode_json($args{args});
    }
    _init_connector()   if !$CONNECTOR || !$$CONNECTOR;
694
    if ($args{command} =~ /^(clone|manage_pools)$/
695
        || $CMD_NO_DUPLICATE{$args{command}}
Francesc Guasch's avatar
Francesc Guasch committed
696
        || ($no_duplicate && $args{command} =~ /^(screenshot)$/)) {
Francesc Guasch's avatar
Francesc Guasch committed
697
698
699
700
701
702
703
704
        my $dupe = _duplicated_request(undef, $args{command}, $args{args});
        return $dupe if $dupe;

        my $recent;
        $recent = done_recently(undef, 60, $args{command})
        if $args{command} !~ /^(clone|migrate|set_base_vm)$/;
        return if $recent;

Francesc Guasch's avatar
Francesc Guasch committed
705
    }
706
707
708
709
710
711
712
713
714
715
716
717

    my $sth = $$CONNECTOR->dbh->prepare(
        "INSERT INTO requests (".join(",",sort keys %args).")"
        ."  VALUES ( "
                .join(",", map { '?' } keys %args)
                ." )"
    );
    $sth->execute(map { $args{$_} } sort keys %args);
    $sth->finish;

    $self->{id} = $self->_last_insert_id();

Francesc Guasch's avatar
Francesc Guasch committed
718
719
720
721
722
    $sth = $$CONNECTOR->dbh->prepare(
    "UPDATE requests set date_req=date_changed"
    ." WHERE id=?");
    $sth->execute($self->{id});

Francesc Guasch's avatar
Francesc Guasch committed
723
724
725
726
727

    my $request = $self->open($self->{id});
    $request->status('requested');

    return $request;
728
729
730
}

sub _last_insert_id {
Francesc Guasch's avatar
Francesc Guasch committed
731
    return Ravada::Utils::last_insert_id($$CONNECTOR->dbh);
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
}

=head2 status

Returns or sets the status of a request

  $req->status('done');

  my $status = $req->status();

=cut

sub status {
    my $self = shift;
    my $status = shift;
    my $message = shift;

    if (!defined $status) {
        my $sth = $$CONNECTOR->dbh->prepare("SELECT * FROM requests "
            ." WHERE id=?");
        $sth->execute($self->{id});
        my $row = $sth->fetchrow_hashref;
        $sth->finish;

        return ($row->{status} or 'unknown');
    }

Francesc Guasch's avatar
Francesc Guasch committed
759
760
761
762
    for ( 1 .. 10 ) {
        eval {
            my $sth = $$CONNECTOR->dbh->prepare("UPDATE requests set status=? "
                ." WHERE id=?");
763

Francesc Guasch's avatar
Francesc Guasch committed
764
765
766
767
768
769
770
771
772
            $status = substr($status,0,64);

            $sth->execute($status, $self->{id});
            $sth->finish;
        };
        last if !$@;
        die $@ if $@ !~ /Deadlock found/;
        warn "Warning: retrying '$@'";
    }
773
774
775
776
777
778

    $self->_send_message($status, $message)
        if $CMD_SEND_MESSAGE{$self->command} || $self->error ;
    return $status;
}

Francesc Guasch's avatar
Francesc Guasch committed
779
780
781
782
783
784
=head2 at

Sets the time when the request will be scheduled

=cut

Francesc Guasch's avatar
Francesc Guasch committed
785
786
787
788
789
790
sub at($self, $value) {
    my $sth = $$CONNECTOR->dbh->prepare("UPDATE requests set at_time=? "
            ." WHERE id=?");
    $sth->execute($value, $self->{id});
}

791
792
793
794
795
796
797
798
799
sub _search_domain_name {
    my $self = shift;
    my $domain_id = shift;

    my $sth = $$CONNECTOR->dbh->prepare("SELECT name FROM domains where id=?");
    $sth->execute($domain_id);
    return $sth->fetchrow;
}

Francesc Guasch's avatar
Francesc Guasch committed
800
801
802
803
804
805
806
807
sub _search_domain_id($self,$domain_name) {

    my $sth = $$CONNECTOR->dbh->prepare("SELECT id FROM domains where name=?");
    $sth->execute($domain_name);
    return $sth->fetchrow;
}


808
809
810
811
812
813
814
815
816
sub _send_message {
    my $self = shift;
    my $status = shift;
    my $message = ( shift or $self->error );

    my $uid;

    $uid = $self->args('id_owner') if $self->defined_arg('id_owner');
    $uid = $self->args('uid')      if !$uid && $self->defined_arg('uid');
Francesc Guasch's avatar
Francesc Guasch committed
817

Francesc Guasch's avatar
Francesc Guasch committed
818
819
820
821
822
    if (!$uid) {
        my $user = $self->defined_arg('user');
        $uid = $user->id if $user;
    }

823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
    return if !$uid;

    my $domain_name = $self->defined_arg('name');
    if (!$domain_name) {
        my $domain_id = $self->defined_arg('id_domain');
        $domain_name = $self->_search_domain_name($domain_id)   if $domain_id;
        $domain_name = '' if !defined $domain_name;
    }
    $domain_name = "$domain_name "  if length $domain_name;

    $self->_remove_unnecessary_messages() if $self->status eq 'done';

    my $subject = $self->command." $domain_name ".$self->status;
    $subject = $message if $message && $self->status eq 'done'
            && length ($message)<60;

    my $sth = $$CONNECTOR->dbh->prepare(
        "INSERT INTO messages ( id_user, id_request, subject, message, date_shown ) "
        ." VALUES ( ?,?,?,?, NULL)"
    );
    $sth->execute($uid, $self->id,$subject, $message);
    $sth->finish;
}

sub _remove_unnecessary_messages {
    my $self = shift;

    my $uid;
    $uid = $self->defined_arg('id_owner');
    $uid = $self->defined_arg('uid')        if !$uid;
    return if !$uid;


    my $sth = $$CONNECTOR->dbh->prepare(
        "DELETE FROM messages WHERE id_user=? AND id_request=? "
        ." AND (message='' OR message IS NULL)"
    );

    $sth->execute($uid, $self->id);
    $sth->finish;

}

866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
sub _remove_messages {
    my $self = shift;

    my $uid;
    $uid = $self->defined_arg('id_owner');
    $uid = $self->defined_arg('uid')        if !$uid;
    return if !$uid;


    my $sth = $$CONNECTOR->dbh->prepare(
        "DELETE FROM messages WHERE id_user=? AND id_request=? "
    );

    $sth->execute($uid, $self->id);
    $sth->finish;

}


885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958

=head2 result

  Returns the result of the request if any

  my $result = $req->result;

=cut

sub result {
    my $self = shift;

    my $value = shift;

    if (defined $value ) {
        my $sth = $$CONNECTOR->dbh->prepare("UPDATE requests set result=? "
            ." WHERE id=?");
        $sth->execute(encode_json($value), $self->{id});
        $sth->finish;

    } else {
        my $sth = $$CONNECTOR->dbh->prepare("SELECT result FROM requests where id=? ");
        $sth->execute($self->{id});
        ($value) = $sth->fetchrow;
        $value = decode_json($value)    if defined $value;
        $sth->finish;

    }

    return $value;
}

=head2 command

Returns the requested command

=cut

sub command {
    my $self = shift;
    return $self->{command};
}

=head2 args

Returns the requested command

  my $command = $req->command;

=cut


=head2 args

Returns the arguments of a request or the value of one argument field

  my $args = $request->args();
  print $args->{name};

  print $request->args('name');

=cut


sub args {
    my $self = shift;
    my $name = shift;
    return $self->{args}    if !$name;

    confess "Unknown argument $name ".Dumper($self->{args})
        if !exists $self->{args}->{$name};
    return $self->{args}->{$name};
}

Francesc Guasch's avatar
Francesc Guasch committed
959
960
961
962
963
964
=head2 arg

Sets or gets de value of an argument of a Request

=cut

Francesc Guasch's avatar
Francesc Guasch committed
965
966
967
968
969
970
971
972
973
974
sub arg($self, $name, $value) {

    confess "Unknown argument $name ".Dumper($self->{args})
        if !exists $self->{args}->{$name} && !defined $value;

    $self->{args}->{$name} = $value if defined $value;
    return $self->{args}->{$name};
}


975
976
977
978
979
980
981
982
983
984
985
986
987
=head2 defined_arg

Returns if an argument is defined

=cut

sub defined_arg {
    my $self = shift;
    my $name = shift;
    confess "ERROR: missing arg name" if !defined $name;
    return $self->{args}->{$name};
}

988
989
990
991
992
993
994
995
996
997
998
999
1000
=head2 copy_screenshot

Request to copy a screenshot from a domain to another

=cut

sub copy_screenshot {
  my $proto = shift;
  my $class=ref($proto) || $proto;

  my $args = _check_args('copy_screenshot', @_ );

  my $self = {};
For faster browsing, not all history is shown. View entire blame