Request.pm 34 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
68
    ,shutdown_domain => { name => 2, id_domain => 2, uid => 1, timeout => 2, at => 2
                       , id_vm => 2 }
69
    ,force_shutdown_domain => { id_domain => 1, uid => 1, at => 2, id_vm => 2 }
Roberto P. Rubio's avatar
Roberto P. Rubio committed
70
71
    ,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
72
    ,force_reboot_domain => { id_domain => 1, uid => 1, at => 2, id_vm => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
73
    ,screenshot => { id_domain => 1 }
Francesc Guasch's avatar
Francesc Guasch committed
74
    ,domain_autostart => { id_domain => 1 , uid => 1, value => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
75
    ,copy_screenshot => { id_domain => 1 }
Francesc Guasch's avatar
Francesc Guasch committed
76
    ,start_domain => {%$args_manage, remote_ip => 2, name => 2, id_domain => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
77
    ,start_clones => { id_domain => 1, uid => 1, remote_ip => 1, sequential => 2 }
78
    ,shutdown_clones => { id_domain => 1, uid => 1, timeout => 2 }
79
    ,rename_domain => { uid => 1, name => 1, id_domain => 1}
80
    ,dettach => { uid => 1, id_domain => 1 }
81
    ,set_driver => {uid => 1, id_domain => 1, id_option => 1}
82
    ,hybernate=> {uid => 1, id_domain => 1}
Francesc Guasch's avatar
Francesc Guasch committed
83
    ,download => {uid => 2, id_iso => 1, id_vm => 2, verbose => 2, delay => 2, test => 2}
84
    ,refresh_storage => { id_vm => 2 }
85
    ,list_storage_pools => { id_vm => 1 , uid => 1 }
86
    ,check_storage => { uid => 1 }
87
    ,set_base_vm=> {uid => 1, id_vm=> 1, id_domain => 1, value => 2 }
88
    ,cleanup => { }
Francesc Guasch's avatar
Francesc Guasch committed
89
90
91
92
93
94
95
96
    ,clone => { uid => 1, id_domain => 1, name => 2, memory => 2, number => 2
                # 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
97
                ,remote_ip => 2
98
                ,with_cd => 2
Francesc Guasch's avatar
Francesc Guasch committed
99
    }
Joel Alarcón's avatar
Joel Alarcón committed
100
    ,change_owner => {uid => 1, id_domain => 1}
Francesc Guasch's avatar
Francesc Guasch committed
101
    ,add_hardware => {uid => 1, id_domain => 1, name => 1, number => 2, data => 2 }
102
    ,remove_hardware => {uid => 1, id_domain => 1, name => 1, index => 1}
Francesc Guasch's avatar
Francesc Guasch committed
103
    ,change_hardware => {uid => 1, id_domain => 1, hardware => 1, index => 2, data => 1 }
104
    ,enforce_limits => { timeout => 2, _force => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
105
    ,refresh_machine => { id_domain => 1, uid => 1 }
106
    ,refresh_machine_ports => { id_domain => 1, uid => 1 }
Francesc Guasch's avatar
Francesc Guasch committed
107
    ,rebase => { uid => 1, id_base => 1, id_domain => 1 }
108
    ,set_time => { uid => 1, id_domain => 1 }
Francesc Guasch's avatar
Francesc Guasch committed
109
    ,rsync_back => { uid => 1, id_domain => 1, id_node => 1 }
Francesc Guasch's avatar
Francesc Guasch committed
110
111
112
113
    # 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
114
    ,close_exposed_ports => { uid => 1, id_domain => 1, port => 2, clean => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
115
    # Virtual Managers or Nodes
Francesc Guasch's avatar
Francesc Guasch committed
116
    ,refresh_vms => { _force => 2, timeout_shutdown => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
117
118
119
120

    ,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 }
121
122
123
    ,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
124
125
    ,compact => { uid => 1, id_domain => 1 , keep_backup => 2 }
      ,purge => { uid => 1, id_domain => 1 }
Francesc Guasch's avatar
Francesc Guasch committed
126

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

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

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

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

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

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

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

163
164
our $CONNECTOR;

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

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

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

    ,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
205
    }
206
207
208
);
lock_hash %COMMAND;

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

}

=head2 BUILD

    Internal object builder, do not call

219
=cut
220
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

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;

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

    $row->{args} = $args;

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

266
267
268
    return $row;
}

269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
=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
284
285
        id => $self->id
        ,status => $self->status
286
287
288
289
290
        ,error => $self->error
        ,id_domain => $self->id_domain
    }
}

291
292
=head2 create_domain

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


=cut

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

    my %args = @_;

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

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

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

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

=head2 remove_domain

Francesc Guasch's avatar
Francesc Guasch committed
323
324
    my $req = Ravada::Request->remove_domain(
                     name => 'bla'
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
                    , 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);

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

}

=head2 start_domain

Requests to start a domain

Francesc Guasch's avatar
Francesc Guasch committed
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
  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
372
373
374
375
376
377
378
379
380

=cut

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

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

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

Francesc Guasch's avatar
Francesc Guasch committed
384
385
386
    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
387
388
    _remove_low_priority_requests($args->{id_domain} or $args->{name});

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

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

Francesc Guasch's avatar
Francesc Guasch committed
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
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";
        }
    }

}


418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
=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);

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

438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
=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);

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

=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);

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



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

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

    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
508
  my $req = Ravada::Request->force_shutdown_domain( name => 'name' , uid => $user->id );
509
510
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

=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
540
541
542
    confess "ERROR: You must supply either id_domain or name ".Dumper($args)
        if !$args->{id_domain} && !$args->{name};

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

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

Roberto P. Rubio's avatar
Roberto P. Rubio committed
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
=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
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
=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);
594
595
}

Francesc Guasch's avatar
Francesc Guasch committed
596
597
598
599
600
601
602
603
604
605
606
607
=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
608
609
610
611
612
613
614
615
616
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)
    );
}

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

    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
629
    delete $args_d->{uid};
630
    delete $args_d->{at};
Francesc Guasch's avatar
Francesc Guasch committed
631
    my $sth = $$CONNECTOR->dbh->prepare(
Francesc Guasch's avatar
Francesc Guasch committed
632
        "SELECT id,args FROM requests WHERE (status <> 'done')"
Francesc Guasch's avatar
Francesc Guasch committed
633
634
635
636
        ." AND command=?"
    );
    $sth->execute($command);
    while (my ($id,$args_found) = $sth->fetchrow) {
637
        next if $self && $self->id == $id;
Francesc Guasch's avatar
Francesc Guasch committed
638
639
640

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

        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
648
        return Ravada::Request->open($id);
Francesc Guasch's avatar
Francesc Guasch committed
649
650
651
652
    }
    return 0;
}

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

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

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

676
        $args{at_time} = $args{args}->{at} if exists $args{args}->{at};
677
678
679
680
681
682
683
        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;
        }
684
685
686
687
688
        for (qw(after_request after_request_ok retry)) {
            $args{$_} = delete $args{args}->{$_}
            if exists $args{args}->{$_};
        }

689
690
691
        $args{args} = encode_json($args{args});
    }
    _init_connector()   if !$CONNECTOR || !$$CONNECTOR;
692
    if ($args{command} =~ /^(clone|manage_pools)$/
693
        || $CMD_NO_DUPLICATE{$args{command}}
Francesc Guasch's avatar
Francesc Guasch committed
694
        || ($no_duplicate && $args{command} =~ /^(screenshot)$/)) {
Francesc Guasch's avatar
Francesc Guasch committed
695
696
697
698
699
700
701
702
        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
703
    }
704
705
706
707
708
709
710
711
712
713
714
715

    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
716
717
718
719
720
    $sth = $$CONNECTOR->dbh->prepare(
    "UPDATE requests set date_req=date_changed"
    ." WHERE id=?");
    $sth->execute($self->{id});

Francesc Guasch's avatar
Francesc Guasch committed
721
722
723
724
725

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

    return $request;
726
727
728
}

sub _last_insert_id {
Francesc Guasch's avatar
Francesc Guasch committed
729
    return Ravada::Utils::last_insert_id($$CONNECTOR->dbh);
730
731
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
}

=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
757
758
759
760
    for ( 1 .. 10 ) {
        eval {
            my $sth = $$CONNECTOR->dbh->prepare("UPDATE requests set status=? "
                ." WHERE id=?");
761

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

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

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

Francesc Guasch's avatar
Francesc Guasch committed
777
778
779
780
781
782
=head2 at

Sets the time when the request will be scheduled

=cut

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

789
790
791
792
793
794
795
796
797
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
798
799
800
801
802
803
804
805
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;
}


806
807
808
809
810
811
812
813
814
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
815

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

821
822
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
    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;

}

864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
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;

}


883
884
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

=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
957
958
959
960
961
962
=head2 arg

Sets or gets de value of an argument of a Request

=cut

Francesc Guasch's avatar
Francesc Guasch committed
963
964
965
966
967
968
969
970
971
972
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};
}


973
974
975
976
977
978
979
980
981
982
983
984
985
=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};
}

986
987
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 = {};
  bless($self,$class);

For faster browsing, not all history is shown. View entire blame