Request.pm 30.5 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
20
21
22
use Ravada;
use Ravada::Front;

use vars qw($AUTOLOAD);

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

26
27
28
29
30
31
=pod

Request a command to the ravada backend

=cut

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

our $args_manage = { name => 1 , uid => 1 };
37
our $args_prepare = { id_domain => 1 , uid => 1, with_cd => 2 };
38
39
40
41
42
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
43
              vm => 2
44
45
           ,name => 1
           ,swap => 2
Francesc Guasch's avatar
Francesc Guasch committed
46
         ,id_iso => 2
47
         ,iso_file => 2
Francesc Guasch's avatar
Francesc Guasch committed
48
        ,id_base => 2
49
       ,id_owner => 1
Francesc Guasch's avatar
Francesc Guasch committed
50
    ,id_template => 2
51
52
         ,memory => 2
           ,disk => 2
Francesc Guasch's avatar
Francesc Guasch committed
53
           #        ,network => 2
54
55
      ,remote_ip => 2
          ,start => 2
Francesc Guasch's avatar
Francesc Guasch committed
56
           ,data => 2
57
58
59
60
    }
    ,open_iptables => $args_manage_iptables
      ,remove_base => $args_remove_base
     ,prepare_base => $args_prepare
Francesc Guasch's avatar
Francesc Guasch committed
61
     ,spinoff => { id_domain => 1, uid => 1 }
62
63
64
     ,pause_domain => $args_manage
    ,resume_domain => {%$args_manage, remote_ip => 1 }
    ,remove_domain => $args_manage
Francesc Guasch's avatar
Francesc Guasch committed
65
    ,restore_domain => { id_domain => 1, uid => 1 }
66
67
    ,shutdown_domain => { name => 2, id_domain => 2, uid => 1, timeout => 2, at => 2
                       , id_vm => 2 }
68
    ,force_shutdown_domain => { id_domain => 1, uid => 1, at => 2, id_vm => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
69
    ,screenshot => { id_domain => 1 }
Francesc Guasch's avatar
Francesc Guasch committed
70
    ,domain_autostart => { id_domain => 1 , uid => 1, value => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
71
    ,copy_screenshot => { id_domain => 1 }
Francesc Guasch's avatar
Francesc Guasch committed
72
    ,start_domain => {%$args_manage, remote_ip => 2, name => 2, id_domain => 2 }
73
    ,start_clones => { id_domain => 1, uid => 1, remote_ip => 1 }
74
    ,shutdown_clones => { id_domain => 1, uid => 1, timeout => 2 }
75
    ,rename_domain => { uid => 1, name => 1, id_domain => 1}
76
    ,dettach => { uid => 1, id_domain => 1 }
77
    ,set_driver => {uid => 1, id_domain => 1, id_option => 1}
78
    ,hybernate=> {uid => 1, id_domain => 1}
Francesc Guasch's avatar
Francesc Guasch committed
79
    ,download => {uid => 2, id_iso => 1, id_vm => 2, verbose => 2, delay => 2, test => 2}
80
    ,refresh_storage => { id_vm => 2 }
81
    ,set_base_vm=> {uid => 1, id_vm=> 1, id_domain => 1, value => 2 }
82
    ,cleanup => { }
Francesc Guasch's avatar
Francesc Guasch committed
83
84
85
86
87
88
89
90
    ,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
91
                ,remote_ip => 2
92
                ,with_cd => 2
Francesc Guasch's avatar
Francesc Guasch committed
93
    }
Joel Alarcón's avatar
Joel Alarcón committed
94
    ,change_owner => {uid => 1, id_domain => 1}
Francesc Guasch's avatar
Francesc Guasch committed
95
    ,add_hardware => {uid => 1, id_domain => 1, name => 1, number => 2, data => 2 }
96
    ,remove_hardware => {uid => 1, id_domain => 1, name => 1, index => 1}
Francesc Guasch's avatar
Francesc Guasch committed
97
    ,change_hardware => {uid => 1, id_domain => 1, hardware => 1, index => 2, data => 1 }
98
    ,enforce_limits => { timeout => 2, _force => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
99
    ,refresh_machine => { id_domain => 1, uid => 1 }
Francesc Guasch's avatar
Francesc Guasch committed
100
    ,rebase => { uid => 1, id_base => 1, id_domain => 1 }
101
    ,set_time => { uid => 1, id_domain => 1 }
Francesc Guasch's avatar
Francesc Guasch committed
102
103
104
105
    # 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
106
    # Virtual Managers or Nodes
Francesc Guasch's avatar
Francesc Guasch committed
107
    ,refresh_vms => { _force => 2, timeout_shutdown => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
108
109
110
111
112

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

Francesc Guasch's avatar
Francesc Guasch committed
113
    #users
114
    ,post_login => { user => 1, locale => 2 }
Francesc Guasch's avatar
Francesc Guasch committed
115

Francesc Guasch's avatar
Francesc Guasch committed
116
117
118
    #networks
    ,list_network_interfaces => { uid => 1, vm_type => 1, type => 2 }

Fernando Verdugo's avatar
Fernando Verdugo committed
119
120
121
    #isos
    ,list_isos => { vm_type => 1 }

Francesc Guasch's avatar
Francesc Guasch committed
122
    ,manage_pools => { uid => 2, id_domain => 2 }
123
    ,ping_backend => {}
124
125
126
);

our %CMD_SEND_MESSAGE = map { $_ => 1 }
127
    qw( create start shutdown prepare_base remove remove_base rename_domain screenshot download
Francesc Guasch's avatar
Francesc Guasch committed
128
            clone
129
            set_base_vm remove_base_vm
Francesc Guasch's avatar
Francesc Guasch committed
130
            domain_autostart hibernate hybernate
Francesc Guasch's avatar
Francesc Guasch committed
131
            change_owner
Francesc Guasch's avatar
Francesc Guasch committed
132
            add_hardware remove_hardware set_driver change_hardware
Francesc Guasch's avatar
Francesc Guasch committed
133
            expose remove_expose
Francesc Guasch's avatar
Francesc Guasch committed
134
            rebase rebase_volumes
Francesc Guasch's avatar
Francesc Guasch committed
135
            shutdown_node start_node
136
    );
137

138
139
140
141
142
143
our %CMD_NO_DUPLICATE = map { $_ => 1 }
qw(
    set_base_vm
    remove_base_vm
);

Francesc Guasch's avatar
Francesc Guasch committed
144
145
our $TIMEOUT_SHUTDOWN = 120;

146
147
our $CONNECTOR;

148
our %COMMAND = (
Francesc Guasch's avatar
Francesc Guasch committed
149
150
151
152
    long => {
        limit => 4
        ,priority => 4
    } #default
153
154
155
    ,huge => {
        limit => 1
        ,commands => ['download']
Francesc Guasch's avatar
Francesc Guasch committed
156
        ,priority => 5
157
    }
158
159
    ,disk => {
        limit => 1
160
        ,commands => ['prepare_base','remove_base','set_base_vm','rebase_volumes'
161
                    , 'remove_base_vm'
Francesc Guasch's avatar
Francesc Guasch committed
162
                    , 'screenshot'
163
                ]
164
165
        ,priority => 6
    }
Francesc Guasch's avatar
Francesc Guasch committed
166
    ,important=> {
167
        limit => 20
Francesc Guasch's avatar
Francesc Guasch committed
168
        ,priority => 1
169
        ,commands => ['clone','start','start_clones','shutdown_clones','create','open_iptables','list_network_interfaces','list_isos']
170
    }
Francesc Guasch's avatar
Francesc Guasch committed
171
172
173
    ,secondary => {
        limit => 50
        ,priority => 2
174
        ,commands => ['shutdown','shutdown_now', 'manage_pools']
Francesc Guasch's avatar
Francesc Guasch committed
175
    }
176
177
178
);
lock_hash %COMMAND;

179
180
181
182
183
184
185
186
187
188
sub _init_connector {
    $CONNECTOR = \$Ravada::CONNECTOR;
    $CONNECTOR = \$Ravada::Front::CONNECTOR   if !$$CONNECTOR;

}

=head2 BUILD

    Internal object builder, do not call

189
=cut
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227

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;

228
229
    my $args = {};
    $args = decode_json($row->{args}) if $row->{args};
230
231
232
233

    $row->{args} = $args;

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

236
237
238
    return $row;
}

239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
=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
254
255
        id => $self->id
        ,status => $self->status
256
257
258
259
260
        ,error => $self->error
        ,id_domain => $self->id_domain
    }
}

261
262
=head2 create_domain

Francesc Guasch's avatar
Francesc Guasch committed
263
264
    my $req = Ravada::Request->create_domain(
                        name => 'bla'
265
266
267
268
269
270
271
272
273
274
275
276
                    , id_iso => 1
    );


=cut

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

    my %args = @_;

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

279
280
281
    confess "ERROR: Argument vm required without id_base"
        if !exists $args->{vm} && !exists $args->{id_base};

282
    my $self = {};
Francesc Guasch's avatar
Francesc Guasch committed
283
284
    if ($args->{network}) {
        $args->{network} = JSON::XS->new->convert_blessed->encode($args->{network});
285
286
287
    }

    bless($self,$class);
Francesc Guasch's avatar
Francesc Guasch committed
288
    return $self->_new_request(command => 'create' , args => encode_json($args));
289
290
291
292
}

=head2 remove_domain

Francesc Guasch's avatar
Francesc Guasch committed
293
294
    my $req = Ravada::Request->remove_domain(
                     name => 'bla'
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
                    , 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);

318
    return $self->_new_request(command => 'remove' , args => \%args);
319
320
321
322
323
324
325

}

=head2 start_domain

Requests to start a domain

Francesc Guasch's avatar
Francesc Guasch committed
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
  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
342
343
344
345
346
347
348
349
350

=cut

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

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

351
352
353
    confess "ERROR: choose either id_domain or name "
        if $args->{id_domain} && $args->{name};

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

357
    return $self->_new_request(command => 'start' , args => $args);
358
359
}

360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
=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);

377
    return $self->_new_request(command => 'start_clones' , args => $args);
378
379
}

380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
=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);

397
    return $self->_new_request(command => 'pause' , args => $args);
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
}

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

417
    return $self->_new_request(command => 'resume' , args => $args);
418
419
420
421
422
423
}



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

    my $valid_args = $VALID_ARG{$sub};
Francesc Guasch's avatar
Francesc Guasch committed
428
    for (qw(at after_request retry _no_duplicate)) {
429
430
        $valid_args->{$_}=2 if !exists $valid_args->{$_};
    }
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481

    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 !

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

=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
482
    $args->{timeout} = $TIMEOUT_SHUTDOWN if !exists $args->{timeout};
483

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

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

490
    return $self->_new_request(command => 'shutdown' , args => $args);
491
492
}

Francesc Guasch's avatar
Francesc Guasch committed
493
494
495
496
497
498
499
500
501
502
503
504
=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
505
506
507
508
509
510
511
512
513
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)
    );
}

514
515
516
517
518
519
520
521
522
523
524
sub _duplicated_request($self=undef, $command=undef, $args=undef) {

    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
525
    delete $args_d->{uid};
526
    delete $args_d->{at};
Francesc Guasch's avatar
Francesc Guasch committed
527
528
529
530
531
532
    my $sth = $$CONNECTOR->dbh->prepare(
        "SELECT id,args FROM requests WHERE status='requested'"
        ." AND command=?"
    );
    $sth->execute($command);
    while (my ($id,$args_found) = $sth->fetchrow) {
533
        next if $self && $self->id == $id;
Francesc Guasch's avatar
Francesc Guasch committed
534
535
536

        my $args_found_d = decode_json($args_found);
        delete $args_found_d->{uid};
537
        delete $args_found_d->{at};
Francesc Guasch's avatar
Francesc Guasch committed
538
539
540
541
542
543
544
545
546
547
548

        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;

        return $id;
    }
    return 0;
}

549
550
sub _new_request {
    my $self = shift;
551
552
553
    if ( !ref($self) ) {
        my $proto = $self ;
        my $class = ref($proto) || $proto;
Francesc Guasch's avatar
Francesc Guasch committed
554
555
556
        $self = {};
        bless ($self, $class);
    }
557
558
    my %args = @_;

Francesc Guasch's avatar
Francesc Guasch committed
559
    $args{status} = 'initializing';
560
561
562
563
564

    if ($args{name}) {
        $args{domain_name} = $args{name};
        delete $args{name};
    }
Francesc Guasch's avatar
Francesc Guasch committed
565
    my $no_duplicate = delete $args{_no_duplicate};
Francesc Guasch's avatar
Francesc Guasch committed
566
    my $uid;
567
568
569
    if ( ref $args{args} ) {
        $args{args}->{uid} = $args{args}->{id_owner}
            if !exists $args{args}->{uid};
Francesc Guasch's avatar
Francesc Guasch committed
570
571
        $uid = $args{args}->{uid} if exists $args{args}->{uid};

572
        $args{at_time} = $args{args}->{at} if exists $args{args}->{at};
573
574
575
576
577
578
        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;
579
580
            $args{after_request} = delete $args{args}->{after_request}
                if exists $args{args}->{after_request};
Francesc Guasch's avatar
Francesc Guasch committed
581
582
            $args{retry} = delete $args{args}->{retry}
                if exists $args{args}->{retry};
583

584
        }
585
586
587
        $args{args} = encode_json($args{args});
    }
    _init_connector()   if !$CONNECTOR || !$$CONNECTOR;
588
    if ($args{command} =~ /^(clone|manage_pools)$/
589
        || $CMD_NO_DUPLICATE{$args{command}}
Francesc Guasch's avatar
Francesc Guasch committed
590
        || ($no_duplicate && $args{command} =~ /^(screenshot)$/)) {
591
        if ( _duplicated_request(undef, $args{command}, $args{args})
Francesc Guasch's avatar
Francesc Guasch committed
592
            || ( $args{command} ne 'clone' && done_recently(undef, 60, $args{command}))) {
frankiejol's avatar
frankiejol committed
593
            #            warn "Warning: duplicated request for $args{command} $args{args}";
Francesc Guasch's avatar
Francesc Guasch committed
594
595
596
            return;
        }
    }
597
598
599
600
601
602
603
604
605
606
607
608

    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
609
610
611
612
613
    $sth = $$CONNECTOR->dbh->prepare(
    "UPDATE requests set date_req=date_changed"
    ." WHERE id=?");
    $sth->execute($self->{id});

Francesc Guasch's avatar
Francesc Guasch committed
614
615
616
617
618

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

    return $request;
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
}

sub _last_insert_id {
    my $driver = $$CONNECTOR->dbh->{Driver}->{Name};

    if ( $driver =~ /sqlite/i ) {
        return _last_insert_id_sqlite(@_);
    } elsif ( $driver =~ /mysql/i ) {
        return _last_insert_id_mysql(@_);
    } else {
        confess "I don't know how to get last_insert_id for $driver";
    }
}

sub _last_insert_id_mysql {
    my $self = shift;
    my $sth = $$CONNECTOR->dbh->prepare("SELECT last_insert_id()");
    $sth->execute;
    my ($id) = $sth->fetchrow;
    $sth->finish;
    return $id;

}

sub _last_insert_id_sqlite {
    my $self = shift;

    my $sth = $$CONNECTOR->dbh->prepare("SELECT last_insert_rowid()");
    $sth->execute;
    my ($id) = $sth->fetchrow;
    $sth->finish;
    return $id;
}

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

    my $sth = $$CONNECTOR->dbh->prepare("UPDATE requests set status=? "
            ." WHERE id=?");
680
681

    $status = substr($status,0,64);
682
683
684
685
686
687
688
689
    $sth->execute($status, $self->{id});
    $sth->finish;

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

Francesc Guasch's avatar
Francesc Guasch committed
690
691
692
693
694
695
=head2 at

Sets the time when the request will be scheduled

=cut

Francesc Guasch's avatar
Francesc Guasch committed
696
697
698
699
700
701
sub at($self, $value) {
    my $sth = $$CONNECTOR->dbh->prepare("UPDATE requests set at_time=? "
            ." WHERE id=?");
    $sth->execute($value, $self->{id});
}

702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
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;
}

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
720

Francesc Guasch's avatar
Francesc Guasch committed
721
722
723
724
725
    if (!$uid) {
        my $user = $self->defined_arg('user');
        $uid = $user->id if $user;
    }

726
727
728
729
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
757
758
759
760
761
762
763
764
765
766
767
768
    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;

}

769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
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;

}


788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
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

=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
862
863
864
865
866
867
=head2 arg

Sets or gets de value of an argument of a Request

=cut

Francesc Guasch's avatar
Francesc Guasch committed
868
869
870
871
872
873
874
875
876
877
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};
}


878
879
880
881
882
883
884
885
886
887
888
889
890
=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};
}

891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
=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);

  return $self->_new_request(
       command => 'copy_screenshot'
      ,id_domain => $args->{id_domain}
      ,args => $args
      );
Joel Alarcón's avatar
Joel Alarcón committed
911

912
913
}

Francesc Guasch's avatar
Francesc Guasch committed
914
915
=head2 refresh_vms

916
Refreshes the Virtual Mangers
Francesc Guasch's avatar
Francesc Guasch committed
917
918
919
920
921
922
923
924

=cut

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

    my $args = _check_args('refresh_vms', @_ );
925
926
927
    if  (!$args->{_force} ) {
          return if done_recently(undef,60,'refresh_vms') || _requested('refresh_vms');
    }
Francesc Guasch's avatar
Francesc Guasch committed
928

Francesc Guasch's avatar
Francesc Guasch committed
929
930
    $args->{timeout} = 120 if ! $args->{timeout};

Francesc Guasch's avatar
Francesc Guasch committed
931
932
933
    my $self = {};
    bless($self,$class);

934
    _init_connector();
Francesc Guasch's avatar
Francesc Guasch committed
935
936
937
938
939
940
    return $self->_new_request(
        command => 'refresh_vms'
        , args => $args
    );


941
942
943
944
945
946
947
948
949
950
951
952
953
}

=head2 set_base_vm

Enables a base in a Virtual Manager

=cut

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

    my $args = _check_args('set_base_vm', @_ );
954
    $args->{value} = 1 if !exists $args->{value};
955
956

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

    return $self->_new_request(
960
            command => 'set_base_vm'
961
             , args => $args
962
963
    );

964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
}

=head2 remove_base_vm

Disables a base in a Virtual Manager

=cut

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

    my $args = _check_args('set_base_vm', @_ );
    $args->{value} = 0;

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

    return $self->_new_request(
Francesc Guasch's avatar
Francesc Guasch committed
983
            command => 'remove_base_vm'
984
             , args => $args
985
    );
986
987
988

}

989
990
991
992
993
994
995

=head2 type

Returns the type of the request

=cut

996
sub type($self) {
997
998
    my $command = $self;
    $command = $self->command if ref($self);
999
1000
    for my $type ( keys %COMMAND ) {
        return $type if grep /^$command$/, @{$COMMAND{$type}->{commands}};
For faster browsing, not all history is shown. View entire blame