solenv/bin/modules/Cws.pm

   1 #*************************************************************************
   2 #
   3 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4 #
   5 # Copyright 2008 by Sun Microsystems, Inc.
   6 #
   7 # OpenOffice.org - a multi-platform office productivity suite
   8 #
   9 # $RCSfile: Cws.pm,v $
  10 #
  11 # $Revision: 1.26 $
  12 #
  13 # This file is part of OpenOffice.org.
  14 #
  15 # OpenOffice.org is free software: you can redistribute it and/or modify
  16 # it under the terms of the GNU Lesser General Public License version 3
  17 # only, as published by the Free Software Foundation.
  18 #
  19 # OpenOffice.org is distributed in the hope that it will be useful,
  20 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 # GNU Lesser General Public License version 3 for more details
  23 # (a copy is included in the LICENSE file that accompanied this code).
  24 #
  25 # You should have received a copy of the GNU Lesser General Public License
  26 # version 3 along with OpenOffice.org.  If not, see
  27 # <http://www.openoffice.org/license.html>
  28 # for a copy of the LGPLv3 License.
  29 #
  30 #*************************************************************************
  31
  32
  33 #
  34 # Cws.pm - package for accessing/manipulating child workspaces
  35 #
  36
  37 # TODO: needs some cleanup
  38
  39 package Cws;
  40 use strict;
  41
  42 use Eis;
  43 use CwsConfig;
  44 use Carp;
  45 use URI::Escape;
  46
  47 my $config = CwsConfig::get_config();
  48
  49 ##### class data #####
  50
  51 my %CwsClassData = (
  52     # EIS database connectivity
  53     EIS_URI        => 'urn:ChildWorkspaceDataService',
  54     EIS_PROXY_LIST => $config->cws_db_url_list_ref(),
  55     NET_PROXY      => $config->net_proxy(),
  56     EIS            => undef
  57 );
  58
  59 ##### ctor #####
  60
  61 sub new
  62 {
  63     my $invocant = shift;
  64     my $class = ref($invocant) || $invocant;
  65     my $self = {};
  66     # instance data
  67     # initialize CWS name from environment
  68     $self->{CHILD}        = undef;    # name of child workspace
  69     $self->{MASTER}       = undef;    # name of master workspace
  70     $self->{EIS_ID}       = undef;    # id of child workspace in EIS
  71     $self->{FILES}        = undef;    # list of files registered with child
  72                                       # any file can be registered multiple times
  73     $self->{PATCH_FILES}  = undef     # list of product patch files registered with
  74                                       # child, each file can be added only once
  75     $self->{MILESTONE}    = undef;    # master milestone to which child is related
  76     $self->{MODULES}      = undef;    # list of modules belonging to child
  77     $self->{INCOMPATIBLE_MODULES}      = undef;    # list of modules belonging to child
  78     $self->{NEW_MODULES}      = undef; # list of public new modules belonging to child
  79     $self->{NEW_MODULES_PRIV}      = undef; # list of private new modules belonging to child
  80     $self->{TASKIDS}      = undef;    # list of tasks registered with child
  81     $self->{_CACHED_TAGS} = undef;    # list of cached tags (tags are looked up frequently)
  82     bless($self, $class);
  83     return $self;
  84 }
  85
  86 #### methods to access instance data ####
  87
  88 # Get the EIS ID for child workspace,
  89 # return value: undef => not yet asked EIS for ID
  90 #                        or connection failed
  91 #               0     => queried EIS but didn't find such
  92 #                        a child workspace for this master
  93 # silently ignore any parameter, only the EIS database,
  94 # hands out EIS IDs.
  95 sub eis_id
  96 {
  97     my $self = shift;
  98     if ( !defined($self->{EIS_ID} ) ) {
  99             $self->{EIS_ID} = $self->get_eis_id();
 100     }
 101     return $self->{EIS_ID};
 102 }
 103
 104 # Generate remaining instance data accessor methods;
 105 # if this looks strange see 'perldoc perltootc'
 106
 107 # Accessor methods for single value instance data
 108 for my $datum (qw(master milestone)) {
 109     no strict "refs";
 110     *$datum = sub {
 111         my $self = shift;
 112         my $ucdatum = uc($datum);
 113         if ( @_ ) {
 114             # set item in database
 115             my $item = shift;
 116             # if we already have a valid EIS registered CWS then reset EIS value
 117             # otherwise just set member to the given value
 118             if ( !$self->{uc($datum)} # keep order of evaluation
 119                 || !$self->eis_id()
 120                 || $self->set_item_in_eis($datum, $item) )
 121             {
 122                $self->{uc($datum)} = $item;
 123
 124             }
 125         }
 126         else {
 127             if ( !defined($self->{$ucdatum} ) ) {
 128                 # fetch item from database
 129                 $self->{$ucdatum} = $self->fetch_item_from_eis($datum);
 130             }
 131         }
 132         return $self->{uc($datum)};
 133     }
 134 }
 135
 136 # Accessor methods for instance data consisting of item lists
 137 # like modules and taskids
 138 for my $datum (qw(files patch_files modules incompatible_modules new_modules new_modules_priv taskids)) {
 139     no strict "refs";
 140     *$datum = sub {
 141         # get current item list
 142         # fetch list from EIS database if called the first time
 143         my $self = shift;
 144         my $ucdatum = uc($datum);
 145         if ( !defined($self->{$ucdatum}) ) {
 146             # fetch item list from databse
 147             $self->{$ucdatum} = $self->fetch_items_from_eis($datum);
 148             return undef if !defined($self->{$ucdatum});
 149         }
 150         return wantarray ? @{$self->{$ucdatum}} : $self->{$ucdatum}
 151     }
 152 }
 153
 154 for my $datum (qw(child)) {
 155     no strict "refs";
 156     *$datum = sub {
 157         my $self = shift;
 158         $self->{uc($datum)} = shift if @_;
 159         return $self->{uc($datum)};
 160     }
 161 }
 162
 163
 164 #### additional public methods ####
 165
 166 # For resync: Sets master and milestone simultaneously
 167 # In case of a cross master resync it does not make sense to
 168 # change both items separately
 169 sub set_master_and_milestone
 170 {
 171     my $self      = shift;
 172     my $master    = shift or return undef;
 173     my $milestone = shift or return undef;
 174
 175     # if we do not yet have a valid EIS registered CWS use the above more basic methods
 176     if ( !$self->master()
 177          || !$self->milestone()
 178          || !$self->eis_id() )
 179     {
 180         $self->master($master);
 181         $self->milestone($milestone);
 182     } else {
 183         if ( $self->set_master_and_milestone_in_eis($master, $milestone) ) {
 184             $self->{'MASTER'} = $self->fetch_item_from_eis('master');
 185             $self->{'MILESTONE'} = $self->fetch_item_from_eis('milestone');
 186         }
 187     }
 188     my @retarray = ($self->{'MASTER'}, $self->{'MILESTONE'});
 189     return wantarray ? @retarray : \@retarray;
 190 }
 191
 192 # Query if CWS name is still available. Does not yet register
 193 # anything with EIS.
 194 sub is_cws_name_available
 195 {
 196     my $self     = shift;
 197
 198     my $is_available = $self->is_cws_name_available_in_eis();
 199     return $is_available;
 200 }
 201
 202 # Register new child workspace with the EIS database.
 203 sub register
 204 {
 205     my $self     = shift;
 206     my $vcsid    = shift;
 207     my $location = shift;
 208
 209     my $child_id = $self->register_child_with_eis($vcsid, $location);
 210     return $child_id;
 211 }
 212
 213 # Promote a child workspace with status 'planned' to a full CWS
 214 sub promote
 215 {
 216     my $self     = shift;
 217     my $vcsid    = shift;
 218     my $location = shift;
 219
 220     my $rc = $self->promote_child_in_eis($vcsid, $location);
 221     return $rc;
 222 }
 223
 224 # New style add_module method. Takes an additional bool indicating if
 225 # a module is public or private. Obsoletes add_modules()
 226 sub add_module
 227 {
 228     my $self   = shift;
 229     my $module = shift;
 230     my $public = shift;
 231
 232     my $items_ref =  $self->add_items('modules', $public, $module);
 233     if (defined ($items_ref->[0]) &&  ($items_ref->[0] eq $module)) {
 234         return 1;  # module has been added
 235     }
 236     elsif ( defined($items_ref) ) {
 237         return 0;  # module was already add
 238     }
 239     return undef;  # something went wrong
 240 }
 241
 242 # Add module to modules list.
 243 sub add_modules
 244 {
 245     my $self   = shift;
 246
 247     my $items_ref =  $self->add_items('modules', undef, @_);
 248     return undef unless defined($items_ref);
 249     return wantarray ? @{$items_ref} : $items_ref;
 250 }
 251
 252 # Add tasksids to taskids list.
 253 sub add_taskids
 254 {
 255     my $self   = shift;
 256     my $vcsid  = shift;
 257
 258     my $items_ref = $self->add_items('taskids', $vcsid, @_);
 259     return undef unless defined($items_ref);
 260     return wantarray ? @{$items_ref} : $items_ref;
 261 }
 262
 263 # Add a file to the files list.
 264 sub add_file
 265 {
 266     my $self         = shift;
 267     my $module       = shift;
 268     my $file         = shift;
 269     my $revision     = shift;
 270     my $authors_ref  = shift;
 271     my $taskids_ref  = shift;
 272     my $archive_path = shift;
 273
 274     my $files_ref = $self->files();
 275
 276     if ( $self->add_file_to_eis($module, $file, $revision,
 277             $authors_ref, $taskids_ref, $archive_path) )
 278     {
 279         push(@{$files_ref}, $file);
 280         return 1;
 281     }
 282     return 0;
 283 }
 284
 285 # Add a file to the patch file list.
 286 sub add_patch_file
 287 {
 288     my $self         = shift;
 289     my $file         = shift;
 290
 291     my $patch_files_ref = $self->patch_files();
 292
 293     foreach (@{$patch_files_ref}) {
 294         return 0 if $file eq $_;
 295     }
 296
 297     if ( $self->add_patch_file_to_eis($file) )
 298     {
 299         push(@{$patch_files_ref}, $file);
 300         return 1;
 301     }
 302     return 0;
 303 }
 304
 305 #
 306 # Procedure retrieves the workspace which
 307 # is based on cvs head (not branch)
 308 #
 309 sub get_cvs_head {
 310     my $eis = Cws::eis();
 311     my $result;
 312     eval { $result = $eis->getCVSHead() };
 313     if ( $@ ) {
 314         carp("ERROR: get_eis_id(): EIS database transaction failed. Reason:\n$@\n");
 315     }
 316     return $result;
 317 };
 318
 319 #### public class methods ####
 320
 321 sub get_master_tag {
 322     my ($self, $master, $milestone) = @_;
 323     $master = $self->master() if (!defined $master);
 324     $milestone = $self->milestone() if (!defined $milestone);
 325     return uc($master) . '_' . lc($milestone);
 326 };
 327
 328 sub get_master_branch_tag {
 329     my ($self, $master) = @_;
 330     $master = $self->master() if (!defined $master);
 331     # check in environment if master is on the the HEAD branch
 332     my $cvs_head = get_cvs_head();
 333     if ( $master eq $cvs_head ) {
 334         return undef;
 335     }
 336     else {
 337         return 'mws_' . lc($master);
 338     }
 339 };
 340
 341 sub get_mws {
 342     my $self = shift;
 343     my $eis = Cws::eis();
 344     my $masters;
 345     my $child  = Eis::to_string($self->child());
 346     eval { $masters = $eis->getMastersForCWS($child) };
 347     if ( $@ ) {
 348         carp("ERROR: get_eis_id(): EIS database transaction failed. Reason:\n$@\n");
 349     }
 350     return $$masters[0];
 351 };
 352
 353 # Returns the branch and root tags for child workspace.
 354 sub get_tags
 355 {
 356     my $self = shift;
 357
 358     # look up if tags have already been retrieved
 359     if ( defined($self->{_CACHED_TAGS}) ) {
 360         return @{$self->{_CACHED_TAGS}};
 361     }
 362
 363     # check if child workspace is valid
 364     my $id = $self->eis_id();
 365     if ( !$id ) {
 366         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
 367         return undef;
 368     }
 369
 370     my $childws = $self->child();
 371     # check if child workspace is a clone,
 372     if ( $childws =~ /(\w+)_[[:upper:]]{3}\d{3}/ ) {
 373         $childws = $1;
 374     }
 375
 376     # check in environment if master is on the the HEAD branch
 377     my $cvs_head = get_cvs_head();
 378     my $current_master = $self->master();
 379     my $creation_master = $self->get_creation_master();
 380     if ( !$creation_master ) {
 381         carp("ERROR: Can't determine creation MWS.\n");
 382         return undef;
 383     }
 384     my $milestone = $self->milestone();
 385
 386     my $master_branch_tag
 387         = (lc($current_master) eq lc($cvs_head)) ? '' : 'mws_' . lc($current_master);
 388     my $cws_branch_tag = 'cws_' . lc($creation_master) . '_' . lc($childws);
 389     my $cws_root_tag   = uc($cws_branch_tag) . "_ANCHOR";
 390     my $master_milestone_tag = uc($current_master) . "_" . $milestone;
 391
 392     $self->{_CACHED_TAGS} = [$master_branch_tag, $cws_branch_tag, $cws_root_tag, $master_milestone_tag];
 393     return @{$self->{_CACHED_TAGS}};
 394 }
 395
 396 # Get childworkspace owner
 397 sub get_owner
 398 {
 399     my $self = shift;
 400
 401     return $self->get_owner_from_eis();
 402 }
 403
 404 # get childworkspace qarep
 405 sub get_qarep
 406 {
 407     my $self = shift;
 408
 409     return $self->get_qarep_from_eis();
 410 }
 411
 412 # store an Attachment to a given CWS
 413 sub save_attachment
 414 {
 415     my $self = shift;
 416     my $name = shift;
 417     my $mediatype = shift;
 418     my $data = shift;
 419
 420     return $self->save_attachment_in_eis($name, $mediatype, $data);
 421 }
 422
 423 # Get child workspace approval status,
 424 # return values can be:
 425 # 'planned', 'new', 'nominated', 'integrated'
 426 # and undef in case of error.
 427 sub get_approval
 428 {
 429     my $self = shift;
 430
 431     return $self->get_status_from_eis();
 432 }
 433
 434 # Set child workspace approval status
 435 # to 'integrated'. Return true if successful
 436 # or undef in case of error
 437 sub set_integrated
 438 {
 439     my $self = shift;
 440
 441     return $self->set_status_in_eis();
 442 }
 443
 444 # Set child workspace integration milestone
 445 # Return true if successful or undef in case of error
 446 sub set_integration_milestone
 447 {
 448     my $self      = shift;
 449     my $milestone = shift;
 450     my $buildid   = shift;
 451
 452     return $self->set_integration_milestone_in_eis($milestone, $buildid);
 453 }
 454
 455 # Get the MWS on which a CWS was created
 456 sub get_creation_master
 457 {
 458     my $self = shift;
 459
 460     return $self->get_creation_master_from_eis();
 461 }
 462
 463 # Get the 'public' flag indicating whether a CWS is visible on OOo
 464 sub get_public_flag
 465 {
 466     my $self = shift;
 467
 468     return $self->get_public_flag_from_eis();
 469 }
 470
 471
 472 # Get the 'publicmaster' flag indicating whether a MWS is visible on OOo
 473 sub get_publicmaster_flag
 474 {
 475     my $self = shift;
 476
 477     return $self->get_publicmaster_flag_from_eis();
 478 }
 479
 480
 481 sub get_subversion_flag {
 482
 483     my $self      = shift;
 484
 485     return $self->get_subversion_flag_from_eis();
 486 }
 487
 488 sub set_subversion_flag {
 489
 490     my $self      = shift;
 491     my $value     = shift;
 492
 493     return $self->set_subversion_flag_in_eis($value);
 494 }
 495
 496 sub get_scm {
 497     my $self  = shift;
 498
 499     return $self->get_scm_from_eis();
 500 }
 501
 502 sub set_scm {
 503     my $self     = shift;
 504     my $scm_name = shift;
 505
 506     return $self->set_scm_in_eis($scm_name);
 507 }
 508
 509
 510 # Check if milestone exists
 511 sub is_milestone
 512 {
 513     my $self      = shift;
 514     my $master    = shift;
 515     my $milestone = shift;
 516
 517     return $self->is_milestone_registered_with_eis($master, $milestone);
 518 }
 519
 520 # Check if this cws contains new ui
 521 sub is_uirelevant
 522 {
 523     my $self      = shift;
 524
 525     return $self->is_uirelevant_from_eis();
 526 }
 527
 528 # Check if this cws contains new online help
 529 sub is_helprelevant
 530 {
 531     my $self      = shift;
 532
 533     return $self->is_helprelevant_from_eis();
 534 }
 535
 536 # Set the l10n status
 537 sub set_l10n_status
 538 {
 539     my $self        = shift;
 540     my $status      = shift;
 541
 542     return $self->set_l10n_status_in_eis( $status );
 543 }
 544
 545 # Get the l10n status
 546 sub get_l10n_status
 547 {
 548     my $self        = shift;
 549
 550     return $self->get_l10n_status_from_eis();
 551 }
 552 sub set_word_count
 553 {
 554     my $self        = shift;
 555     my $language    = shift;
 556     my $wordcount   = shift;
 557
 558     return $self->set_word_count_in_eis( $language , $wordcount );
 559 }
 560
 561
 562 # Get target release for CWS
 563 sub get_release
 564 {
 565     my $self        = shift;
 566
 567     return $self->get_release_from_eis();
 568 }
 569
 570 # Get due date
 571 sub get_due_date
 572 {
 573     my $self        = shift;
 574
 575     return $self->get_due_date_from_eis();
 576 }
 577
 578 # Get due date QA
 579 sub get_due_date_qa
 580 {
 581     my $self        = shift;
 582
 583     return $self->get_due_date_qa_from_eis();
 584 }
 585
 586 # Query master milestone combination for being used by an
 587 # active CWS
 588 sub is_milestone_used
 589 {
 590     my $self      = shift;
 591     my $master    = shift;
 592     my $milestone = shift;
 593
 594     return $self->get_is_milestone_used_from_eis($master, $milestone);
 595 }
 596
 597 # Set current milestone for MWS.
 598 sub set_current_milestone
 599 {
 600     my $self      = shift;
 601     my $master    = shift;
 602     my $milestone = shift;
 603
 604     return $self->set_current_milestone_in_eis($master, $milestone);
 605 }
 606
 607 # Get current milestone for MWS.
 608 sub get_current_milestone
 609 {
 610     my $self      = shift;
 611     my $master    = shift;
 612
 613     return $self->get_current_milestone_from_eis($master);
 614 }
 615
 616 sub get_milestone_integrated
 617 {
 618     my $self      = shift;
 619
 620     return $self->get_milestone_integrated_from_eis();
 621 }
 622
 623 # Get masters
 624 sub get_masters
 625 {
 626
 627     my $self      = shift;
 628
 629     return $self->get_masters_from_eis();
 630 }
 631
 632 # Get milestones for MWS.
 633 sub get_milestones
 634 {
 635     my $self      = shift;
 636     my $master    = shift;
 637
 638     return $self->get_milestones_from_eis($master);
 639 }
 640 # get build string for CWS
 641
 642 sub get_build
 643 {
 644     my $self      = shift;
 645     my $master = $self->master();
 646     my $milestone = $self->milestone();
 647     if ( ! defined($milestone) ) {
 648         return undef;
 649     }
 650     my $bid=$self->get_buildid($master,$milestone);
 651     if ( ! defined($bid) ) {
 652         return undef;
 653     }
 654     return $self->expand_buildid($bid);
 655 }
 656
 657
 658
 659 # expand build for given cwsname
 660 sub expand_buildid
 661 {
 662     my $self      = shift;
 663     my $bid    = shift;
 664     return $self->expand_buildid_in_eis($bid);
 665 }
 666
 667
 668 # Set BuildID of milestone
 669 sub set_milestone_buildid
 670 {
 671     my $self         = shift;
 672     my $master      = shift;
 673     my $milestone   = shift;
 674     my $buildid     = shift;
 675
 676     return $self->set_milestone_buildid_in_eis($master, $milestone, $buildid);
 677 }
 678
 679 # Declare milestone 'removed'
 680 # This triggers EIS to send emails to all (SO-internal) CWS owners
 681 # with living CWSs based on that milestone.
 682 sub milestone_removed
 683 {
 684     my $self      = shift;
 685     my $master    = shift;
 686     my $milestone = shift;
 687
 688     return $self->set_milestone_removed_in_eis($master, $milestone);
 689 }
 690
 691
 692 # Get all child workspaces which have been integrated on a
 693 # given master and milestone.
 694 sub get_integrated_cws
 695 {
 696     my $self      = shift;
 697     my $master    = shift;
 698     my $milestone = shift;
 699
 700     my $childworkspaces_arrref = $self->get_childworkspaces_for_milestone($master, $milestone);
 701     if ( !$childworkspaces_arrref ) {
 702         $childworkspaces_arrref = [];
 703     }
 704     return wantarray ? @$childworkspaces_arrref : $childworkspaces_arrref;
 705 }
 706
 707
 708 # Get builid for given master and milestone.
 709 sub get_buildid
 710 {
 711     my $self      = shift;
 712     my $master    = shift;
 713     my $milestone = shift;
 714
 715     return $self->get_buildid_for_milestone($master, $milestone);
 716 }
 717
 718 #
 719 # Get all cws' with a status passed
 720 #
 721 sub get_cws_with_state
 722 {
 723     my $self = shift;
 724     my $mws = shift;
 725     my $status = shift;
 726
 727     return wantarray ? @{$self->get_cws_with_state_from_eis($mws, $status)}
 728                     :   $self->get_cws_with_state_from_eis($mws, $status);
 729 }
 730
 731 sub get_task_prio_cws
 732 {
 733     my $self        = shift;
 734     my $ref_taskids = shift;
 735     return @{$self->get_task_prios_of_tasks($ref_taskids)};
 736 }
 737
 738 # Check is CWS is cloneable for specified master
 739 sub is_cws_cloneable
 740 {
 741     my $self      = shift;
 742     my $master    = shift;
 743
 744     return $self->get_is_cws_cloneable_from_eis($master);
 745 }
 746
 747 # Clone CWS for specified master
 748 sub clone_cws
 749 {
 750     my $self      = shift;
 751     my $master    = shift;
 752
 753     return $self->clone_cws_in_eis($master);
 754 }
 755
 756 sub set_log_entry
 757 {
 758     my $self            = shift;
 759     my $commandline = shift;
 760     my $vcsid           = shift;
 761     my $start           = shift;
 762     my $stop            = shift;
 763     my $comment         = shift;
 764     return $self->set_log_entry_in_eis($commandline, $vcsid, $start, $stop, $comment);
 765 }
 766
 767 sub set_log_entry_extended
 768 {
 769     my $self            = shift;
 770     my $commandname = shift;
 771     my $parameter       = shift;
 772     my $vcsid           = shift;
 773     my $start           = shift;
 774     my $stop            = shift;
 775     my $comment         = shift;
 776     my $mastername  = shift;
 777     my $childname       = shift;
 778 #set_log_entry_extended_in_eis($commandname, $parameter, $vcsid, $start, $stop, $comment, $mastername, $childname);
 779     return $self->set_log_entry_extended_in_eis($commandname, $parameter, $vcsid, $start, $stop, $comment, $mastername, $childname);
 780 }
 781
 782
 783 #### private ####
 784
 785 # class data accessor methods
 786 sub eis
 787 {
 788     shift; # ignore calling class/object
 789     $CwsClassData{EIS} = shift if @_;
 790     if ( !defined($CwsClassData{EIS}) ) {
 791         $CwsClassData{EIS} = init_eis_connector();
 792     }
 793     return $CwsClassData{EIS};
 794 }
 795
 796 # generate remaining class data accessor methods
 797 # if this looks strange see 'perldoc perltootc'
 798 for my $datum (qw(eis_uri eis_proxy_list net_proxy)) {
 799     no strict "refs";
 800     *$datum = sub {
 801         shift; # ignore calling class/object
 802         return $CwsClassData{uc($datum)};
 803     }
 804 }
 805
 806 #### helper methods ####
 807
 808 # instance methods
 809
 810 # Add item to items list,
 811 # update eis database,
 812 # returns a list of newly added items,
 813 # specifying an existing item is not an
 814 # error, but it want appear in the return list.
 815 sub add_items
 816 {
 817     my $self          = shift;
 818     my $type          = shift;
 819     my $optional_data = shift;
 820
 821     my $items_ref;
 822     if ( $type eq 'modules' ) {
 823         $items_ref   = $self->modules();
 824     }
 825     elsif ( $type eq 'taskids' ) {
 826         $items_ref   = $self->taskids();
 827     }
 828     else {
 829         # fall through, can't happen
 830         carp("ERROR: wrong item type\n");
 831         return undef;
 832     }
 833
 834     my $item;
 835     my @new_items = ();
 836     return undef if !defined($items_ref);
 837     # find which items which are not already in items list
 838     ITEM: while ( $item = shift ) {
 839         foreach ( @{$items_ref} ) {
 840             next ITEM if $_ eq $item;
 841         }
 842         push(@new_items, $item);
 843     }
 844     if ( $#new_items > -1 ) {
 845         # add items to database
 846         if ( $self->add_items_to_eis($type, $optional_data, \@new_items) ) {
 847             push(@{$items_ref}, @new_items);
 848         }
 849         else {
 850             # something went wrong
 851             return undef;
 852         }
 853     }
 854     return \@new_items;
 855 }
 856
 857 # Get EIS id for workspace from EIS database
 858 sub get_eis_id
 859 {
 860     my $self = shift;
 861     my $eis = Cws::eis();
 862
 863     # It's not an error if one of these is unset, so don't carp().
 864     if ( !$self->master() || !$self->child() ) {
 865         return undef;
 866     }
 867
 868     my $master = Eis::to_string($self->master());
 869     my $child  = Eis::to_string($self->child());
 870
 871     my $result;
 872     eval { $result = int($eis->getChildWorkspaceId($master, $child)) };
 873     if ( $@ ) {
 874         carp("ERROR: get_eis_id(): EIS database transaction failed. Reason:\n$@\n");
 875     }
 876     return $result;
 877 }
 878
 879 sub fetch_item_from_eis
 880 {
 881     my $self = shift;
 882     my $type = shift;
 883
 884     my $eis = Cws::eis();
 885     my $id = $self->eis_id();
 886
 887     if ( !$id ) {
 888         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
 889         return undef;
 890     }
 891
 892     my $result;
 893     if ( $type eq 'milestone' ) {
 894         eval { $result = $eis->getMilestone($id) };
 895     }
 896     elsif ( $type eq 'master' ) {
 897         # master can't be queried from the EIS database,
 898         # just return what already in member
 899         return $self->{MASTER}
 900     }
 901     else {
 902         # fall through, can't happen
 903         carp("ERROR: wrong item type\n");
 904         return undef;
 905     }
 906     if ( $@ ) {
 907         carp("ERROR: fetch_item(): EIS database transaction failed. Reason:\n$@\n");
 908     }
 909     return $result;
 910 }
 911
 912 sub set_item_in_eis
 913 {
 914     my $self     = shift;
 915     my $type     = shift;
 916     my $item     = shift;
 917
 918     my $eis = Cws::eis();
 919     my $id = $self->eis_id();
 920
 921     if ( !$id ) {
 922         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
 923         return undef;
 924     }
 925
 926     # make certain that the item is a string, otherwise
 927     # autotyping will occasionally choose the wrong type
 928     $item = Eis::to_string($item);
 929
 930     my $result;
 931     if ( $type eq 'milestone' ) {
 932         # this operation invalidates the cached tags list
 933         $self->{_CACHED_TAGS} = undef;
 934         eval { $result = $eis->setMilestone($id, $item) };
 935     }
 936     elsif ( $type eq 'master' ) {
 937         # this operation invalidates the cached tags list
 938         $self->{_CACHED_TAGS} = undef;
 939         eval { $result = $eis->setMasterWorkspace($id, $item) };
 940     }
 941     else {
 942         # fall through, can't happen
 943         carp("ERROR: wrong item type\n");
 944         return 0;
 945     }
 946
 947     if ( $@ ) {
 948         carp("ERROR: set_item(): EIS database transaction failed. Reason:\n$@\n");
 949         return undef;
 950     }
 951     return 1 if $result;
 952     return 0;
 953 }
 954
 955 sub set_master_and_milestone_in_eis
 956 {
 957     my $self      = shift;
 958     my $master    = shift;
 959     my $milestone = shift;
 960
 961     my $eis = Cws::eis();
 962     my $id = $self->eis_id();
 963
 964     if ( !$id ) {
 965         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
 966         return undef;
 967     }
 968
 969     # make certain that the item is a string, otherwise
 970     # autotyping will occasionally choose the wrong type
 971     $master = Eis::to_string($master);
 972     $milestone = Eis::to_string($milestone);
 973
 974     my $result;
 975     # this operation invalidates the cached tags list
 976     $self->{_CACHED_TAGS} = undef;
 977     eval { $result = $eis->setMasterWorkspaceAndMilestone($id, $master, $milestone) };
 978
 979     if ( $@ ) {
 980         carp("ERROR: set_master_and_milestone(): EIS database transaction failed. Reason:\n$@\n");
 981         return undef;
 982     }
 983     return 1 if $result;
 984     return 0;
 985 }
 986
 987 sub fetch_items_from_eis
 988 {
 989     my $self = shift;
 990     my $type = shift;
 991
 992     my $eis = Cws::eis();
 993     my $id = $self->eis_id();
 994
 995     if ( !$id ) {
 996         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
 997         return undef;
 998     }
 999
1000     my $result;
1001     if ( $type eq 'modules' ) {
1002         eval { $result = $eis->getModules($id) };
1003     }
1004     elsif ( $type eq 'incompatible_modules' ) {
1005         eval { $result = $eis->getIncompatibleModules($id) };
1006     }
1007     elsif ( $type eq 'new_modules' ) {
1008         eval { $result = $eis->getNewModules($id) };
1009     }
1010     elsif ( $type eq 'new_modules_priv' ) {
1011         eval { $result = $eis->getNewModulesPriv($id) };
1012     }
1013     elsif ( $type eq 'taskids' ) {
1014         eval { $result = $eis->getTaskIds($id) };
1015     }
1016     elsif ( $type eq 'files' ) {
1017         eval { $result = $eis->getFiles($id) };
1018     }
1019     elsif ( $type eq 'patch_files' ) {
1020         eval { $result = $eis->getOutputFiles($id) };
1021     }
1022     else {
1023         # fall through, can't happen
1024         carp("ERROR: wrong item type\n");
1025         return undef;
1026     }
1027     if ( $@ ) {
1028         carp("ERROR: fetch_item(): EIS database transaction failed. Reason:\n$@\n");
1029     }
1030     return $result;
1031 }
1032
1033 sub add_items_to_eis
1034 {
1035     my $self          = shift;
1036     my $type          = shift;
1037     my $optional_data = shift;
1038     my $item_ref      = shift;
1039
1040     my $eis = Cws::eis();
1041     my $id = $self->eis_id();
1042
1043     if ( !$id ) {
1044         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1045         return undef;
1046     }
1047
1048     # make certain that all items are strings, otherwise
1049     # autotyping will occasionally choose the wrong type
1050     my @items = ();
1051     foreach ( @{$item_ref} ) {
1052         push(@items, Eis::to_string($_));
1053     }
1054
1055     my $result;
1056     if ( $type eq 'modules' ) {
1057         if ( defined($optional_data) ) {
1058             # add a module new style, with public attribute
1059             eval { $result = $eis->addModule($id, $items[0], $optional_data) };
1060         }
1061         else {
1062             # old style, add a list of modules
1063             eval { $result = $eis->addModules($id, \@items) };
1064         }
1065     }
1066     elsif ( $type eq 'taskids' ) {
1067         eval { $result = $eis->addTaskIds($id, \@items, $optional_data) };
1068     }
1069     else {
1070         # fall through, can't happen
1071         carp("ERROR: wrong item type\n");
1072         return 0;
1073     }
1074
1075     if ( $@ ) {
1076         carp("ERROR: add_item(): EIS database transaction failed. Reason:\n$@\n");
1077         return undef;
1078     }
1079     return 1 if $result;
1080     return 0;
1081 }
1082
1083 sub add_file_to_eis
1084 {
1085     my $self         = shift;
1086     my $module       = shift;
1087     my $file         = shift;
1088     my $revision     = shift;
1089     my $authors_ref  = shift;
1090     my $taskids_ref  = shift;
1091     my $archive_path = shift;
1092
1093
1094     my $eis = Cws::eis();
1095     my $id = $self->eis_id();
1096
1097     if ( !$id ) {
1098         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1099         return undef;
1100     }
1101
1102     # make certain that all task_ids are strings, otherwise
1103     # autotyping will choose the wrong type
1104     # Note: I think typing just the first element should suffice, but ...
1105     my @taskids = ();
1106     foreach ( @{$taskids_ref} ) {
1107         push(@taskids, Eis::to_string($_));
1108     }
1109     # HACK Its possible that we get no valid taskid.
1110     # Autotyping will fail for a list without elements;
1111     if ( !@taskids ) {
1112         push(@taskids, Eis::to_string(''));
1113     }
1114
1115     # same for revision
1116     $revision = Eis::to_string($revision);
1117
1118     if ( !$archive_path ) {
1119         $archive_path = Eis::to_string('');
1120     }
1121
1122     my $result;
1123     eval {
1124         $result = $eis->addFile($id, $module, $file, $archive_path,
1125                                 $revision, $authors_ref, \@taskids)
1126     };
1127     if ( $@ ) {
1128         carp("ERROR: add_file(): EIS database transaction failed. Reason:\n$@\n");
1129         return undef;
1130     }
1131     return 1 if $result;
1132     return 0;
1133 }
1134
1135 sub add_patch_file_to_eis
1136 {
1137     my $self         = shift;
1138     my $file         = shift;
1139
1140     my $eis = Cws::eis();
1141     my $id = $self->eis_id();
1142
1143     if ( !$id ) {
1144         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1145         return undef;
1146     }
1147
1148     my $result;
1149     eval { $result = $eis->addOutputFile($id, $file) };
1150     if ( $@ ) {
1151         carp("ERROR: add_patch_file(): EIS database transaction failed. Reason:\n$@\n");
1152         return undef;
1153     }
1154     return $1;# appOutputFile has void as return value ...
1155 }
1156
1157 sub is_cws_name_available_in_eis
1158 {
1159     my $self     = shift;
1160
1161     if ( !$self->master() ) {
1162         carp("ERROR: master workspace name not set\n");
1163         return undef;
1164     }
1165
1166     if ( !$self->child() ) {
1167         carp("ERROR: child workspace name not set\n");
1168         return undef;
1169     }
1170
1171     my $eis = Cws::eis();
1172     my $master    = Eis::to_string($self->master());
1173     my $child     = Eis::to_string($self->child());
1174
1175     my $result;
1176     eval { $result = $eis->isChildWorkspaceUnique($master, $child) };
1177     if ( $@ ) {
1178         carp("ERROR: is_cws_name_available(): EIS database transaction failed. Reason:\n$@\n");
1179     }
1180     return $result;
1181 }
1182
1183 sub register_child_with_eis
1184 {
1185     my $self     = shift;
1186     my $vcsid    = shift;
1187     my $location = shift;
1188
1189     if ( !$self->master() ) {
1190         carp("ERROR: master workspace name not set\n");
1191         return undef;
1192     }
1193
1194     if ( !$self->milestone() ) {
1195         carp("ERROR: master milestone not set\n");
1196         return undef;
1197     }
1198
1199     if ( !$self->child() ) {
1200         carp("ERROR: child workspace name not set\n");
1201         return undef;
1202     }
1203
1204     $vcsid    = '' unless $vcsid;
1205     $location = '' unless $location;
1206
1207     my $eis = Cws::eis();
1208     my $master    = Eis::to_string($self->master());
1209     my $milestone = Eis::to_string($self->milestone());
1210     my $child     = Eis::to_string($self->child());
1211
1212     $vcsid        = Eis::to_string($vcsid);
1213     $location     = Eis::to_string($location);
1214
1215     my $result;
1216     eval {
1217         $result = $eis->createChildWorkspace($master, $milestone, $child,
1218                                                  $vcsid, $location)
1219     };
1220
1221     if ( $@ ) {
1222         carp("ERROR: create_child_wortkspace(): EIS database transaction failed. Reason:\n$@\n");
1223         return undef;
1224     }
1225     # set EIS_ID directly, since $self->eis_id() is not
1226     # supposed to take parameters.
1227     $self->{EIS_ID} = $result;
1228     return $result;
1229 }
1230
1231 sub promote_child_in_eis
1232 {
1233     my $self     = shift;
1234     my $vcsid    = shift;
1235     my $location = shift;
1236
1237     my $eis = Cws::eis();
1238     my $id = $self->eis_id();
1239
1240     if ( !$id ) {
1241         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1242         return undef;
1243     }
1244
1245     if ( !$self->milestone() ) {
1246         carp("ERROR: master milestone not set\n");
1247         return undef;
1248     }
1249
1250     my $milestone = Eis::to_string($self->milestone());
1251
1252     $vcsid    = '' unless $vcsid;
1253     $location = '' unless $location;
1254
1255     $vcsid        = Eis::to_string($vcsid);
1256     $location     = Eis::to_string($location);
1257
1258     my $result;
1259     eval {
1260         $result = $eis->initializeChildWorkspace($id, $milestone, $vcsid, $location)
1261     };
1262
1263     eval { $result = $eis->getStatus($id) };
1264     if ( $@ ) {
1265         carp("ERROR: promote(): EIS database transaction failed. Reason:\n$@\n");
1266         return 0;
1267     }
1268     return 1;
1269 }
1270
1271 # Get child workspace owner from EIS,
1272 # return undef in case of error.
1273 sub get_owner_from_eis
1274 {
1275     my $self = shift;
1276
1277     # check if child workspace is valid
1278     my $id = $self->eis_id();
1279     if ( !$id ) {
1280         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1281         return undef;
1282     }
1283
1284     my $eis = Cws::eis();
1285     my $result;
1286     eval { $result = $eis->getOwnerEmail($id) };
1287     if ( $@ ) {
1288         carp("ERROR: get_OwnerEmail(): EIS database transaction failed. Reason:\n$@\n");
1289     }
1290     return $result;
1291 }
1292
1293 # Get child workspace qarep from EIS,
1294 # return undef in case of error.
1295 sub get_qarep_from_eis
1296 {
1297     my $self = shift;
1298
1299     # check if child workspace is valid
1300     my $id = $self->eis_id();
1301     if ( !$id ) {
1302         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1303         return undef;
1304     }
1305
1306     my $eis = Cws::eis();
1307     my $result;
1308     eval { $result = $eis->getQARepresentativeEmail($id) };
1309     if ( $@ ) {
1310         carp("ERROR: get_qarep(): EIS database transaction failed. Reason:\n$@\n");
1311     }
1312     return $result;
1313 }
1314
1315 # store an attachment to a given CWS
1316 # return undef in case of error.
1317 sub save_attachment_in_eis
1318 {
1319     my $self      = shift;
1320     my $name      = shift;
1321     my $mediatype = shift;
1322     my $text      = shift;
1323
1324     # check if child workspace is valid
1325     my $eisid = $self->eis_id();
1326     if ( !$eisid )
1327     {
1328         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1329         return undef;
1330     }
1331
1332     my $eisname =      Eis::to_string($name);
1333     my $eismediatype = Eis::to_string($mediatype);
1334     my $eistextstring = Eis::to_string($text);
1335
1336     my $eis = Cws::eis();
1337     my $result;
1338
1339     eval { $result = $eis->saveAttachment($eisid, $eisname, $eismediatype, $eistextstring ) };
1340     if ( $@ ) {
1341         carp("ERROR: save_attachment_in_eis(): EIS database transaction failed. Reason:\n$@\n");
1342     }
1343     return $result;
1344 }
1345
1346 # Get child workspace approval status from EIS,
1347 # return undef in case of error.
1348 sub get_status_from_eis
1349 {
1350     my $self = shift;
1351
1352     # check if child workspace is valid
1353     my $id = $self->eis_id();
1354     if ( !$id ) {
1355         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1356         return undef;
1357     }
1358
1359     my $eis = Cws::eis();
1360     my $result;
1361     eval { $result = $eis->getStatus($id) };
1362     if ( $@ ) {
1363         carp("ERROR: get_status(): EIS database transaction failed. Reason:\n$@\n");
1364     }
1365     return $result;
1366 }
1367
1368 # Get child workspace approval status from EIS,
1369 # return undef in case of error.
1370 sub set_status_in_eis
1371 {
1372     my $self = shift;
1373     my $status = shift;
1374     my $method = 'set';
1375     $method .= (defined $status) ? $status : 'Integrated';
1376
1377     # check if child workspace is valid
1378     my $id = $self->eis_id();
1379     if ( !$id ) {
1380         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1381         return undef;
1382     }
1383     my $eis = Cws::eis();
1384     my $result;
1385     if (defined $status) {
1386         eval { $result = $eis->setFixedOnMaster($id) };
1387     } else {
1388         eval { $result = $eis->setIntegrated($id) };
1389     }
1390     if ( $@ ) {
1391         carp("ERROR: $method(): EIS database transaction failed. Reason:\n$@\n");
1392     }
1393     return $result;
1394 }
1395
1396 # Get child workspace approval status from EIS,
1397 # return undef in case of error.
1398 sub set_integration_milestone_in_eis
1399 {
1400     my $self      = shift;
1401     my $milestone = shift;
1402     my $buildid   = shift;
1403
1404     # check if child workspace is valid
1405     my $id = $self->eis_id();
1406     if ( !$id ) {
1407         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1408         return undef;
1409     }
1410
1411     my $eis = Cws::eis();
1412
1413     # just in case ...
1414     if ( !defined($milestone) ) {
1415         $milestone = Eis::to_string('');
1416     }
1417     # $buildid must be transfered as string
1418     if ( !defined($buildid) ) {
1419         $buildid = Eis::to_string('');
1420     }
1421     else {
1422         $buildid = Eis::to_string($buildid);
1423     }
1424
1425     my $result;
1426     eval { $result = $eis->setIntegrationMilestone($id, $milestone, $buildid) };
1427     if ( $@ ) {
1428         carp("ERROR: set_integration_milestone(): EIS database transaction failed. Reason:\n$@\n");
1429     }
1430     return $result;
1431 }
1432
1433 sub set_milestone_buildid_in_eis
1434 {
1435     my $self      = shift;
1436     my $master    = shift;
1437     my $milestone = shift;
1438     my $buildid   = shift;
1439
1440     $master    = Eis::to_string($master);
1441     $milestone = Eis::to_string($milestone);
1442     $buildid   = Eis::to_string($buildid);
1443
1444     my $eis = Cws::eis();
1445     my $result;
1446     eval { $result = $eis->setMilestoneBuild( $master, $milestone, $buildid ) };
1447     if ( $@ ) {
1448         carp("ERROR: set_milestone_buildid(): EIS database transaction failed. Reason:\n$@\n");
1449     }
1450     return $result;
1451 }
1452
1453 sub set_current_milestone_in_eis
1454 {
1455     my $self      = shift;
1456     my $master    = shift;
1457     my $milestone = shift;
1458
1459     $master    = Eis::to_string($master);
1460     $milestone = Eis::to_string($milestone);
1461
1462     my $eis = Cws::eis();
1463     my $result;
1464     eval { $result = $eis->setCurrentMilestone( $master, $milestone ) };
1465     if ( $@ ) {
1466         carp("ERROR: set_current_milestone(): EIS database transaction failed. Reason:\n$@\n");
1467     }
1468     return $result;
1469 }
1470
1471 sub get_current_milestone_from_eis
1472 {
1473     my $self      = shift;
1474     my $master    = shift;
1475
1476     $master    = Eis::to_string($master);
1477
1478     my $eis = Cws::eis();
1479     my $result;
1480     eval { $result = $eis->getCurrentMilestone( $master ) };
1481     if ( $@ ) {
1482         carp("ERROR: get_current_milestone(): EIS database transaction failed. Reason:\n$@\n");
1483     }
1484     return $result;
1485 }
1486
1487 sub get_masters_from_eis
1488 {
1489     my $self      = shift;
1490
1491     my $eis = Cws::eis();
1492     my @result;
1493     eval { @result = $eis->getMasterWorkspaces() };
1494     if ( $@ ) {
1495         carp("ERROR: get_masters(): EIS database transaction failed. Reason:\n$@\n");
1496     }
1497
1498     my @result2=();
1499     my $i=0;
1500     while ( defined($result[0][$i]) ) {
1501         push @result2,$result[0][$i];
1502         $i++;
1503     }
1504     return @result2;
1505 }
1506
1507
1508 sub get_milestones_from_eis
1509 {
1510     my $self      = shift;
1511     my $master    = shift;
1512
1513     $master    = Eis::to_string($master);
1514
1515     my $eis = Cws::eis();
1516     my @result;
1517     eval { @result = $eis->getMilestones( $master ) };
1518     if ( $@ ) {
1519         carp("ERROR: get_milestones(): EIS database transaction failed. Reason:\n$@\n");
1520     }
1521     my @result2=();
1522     my $i=0;
1523     while ( defined($result[0][$i]) ) {
1524         push @result2,$result[0][$i];
1525         $i++;
1526     }
1527     return @result2;
1528 }
1529
1530 # Get child workspace owner from EIS,
1531 # return undef in case of error.
1532 sub expand_buildid_in_eis
1533 {
1534     my $self = shift;
1535     my $bid = shift;
1536
1537     # check if child workspace is valid
1538     my $id = $self->eis_id();
1539     if ( !$id ) {
1540         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1541         return undef;
1542     }
1543
1544     my $name = $self->child();
1545
1546     my $eis = Cws::eis();
1547     my $result;
1548     eval { $result = $eis->expandBuildId($bid, $name) };
1549     if ( $@ ) {
1550         carp("ERROR: expand_builid(): EIS database transaction failed. Reason:\n$@\n");
1551     }
1552     return $result;
1553 }
1554
1555 sub set_milestone_removed_in_eis
1556 {
1557     my $self      = shift;
1558     my $master    = shift;
1559     my $milestone = shift;
1560
1561     $master    = Eis::to_string($master);
1562     $milestone = Eis::to_string($milestone);
1563
1564     my $eis = Cws::eis();
1565     eval { $eis->minorRemoved( $master, $milestone ) };
1566     if ( $@ ) {
1567         carp("ERROR: set_current_milestone(): EIS database transaction failed. Reason:\n$@\n");
1568     }
1569     return;
1570 }
1571
1572 sub is_milestone_registered_with_eis
1573 {
1574     my $self      = shift;
1575     my $master    = shift;
1576     my $milestone = shift;
1577
1578     $master    = Eis::to_string($master);
1579     $milestone = Eis::to_string($milestone);
1580
1581     my $eis = Cws::eis();
1582     my $result;
1583     eval { $result = $eis->isMilestoneValid($master, $milestone) };
1584     if ( $@ ) {
1585         carp("ERROR: is_milestone(): EIS database transaction failed. Reason:\n$@\n");
1586     }
1587     return $result;
1588 }
1589
1590 sub get_is_milestone_used_from_eis
1591 {
1592     my $self      = shift;
1593     my $master    = shift;
1594     my $milestone = shift;
1595
1596     $master    = Eis::to_string($master);
1597     $milestone = Eis::to_string($milestone);
1598
1599     my $eis = Cws::eis();
1600     my $result;
1601     eval { $result = $eis->isMilestoneInUse($master, $milestone) };
1602     if ( $@ ) {
1603         carp("ERROR: is_milestone_used(): EIS database transaction failed. Reason:\n$@\n");
1604     }
1605     return $result;
1606 }
1607
1608 sub get_buildid_for_milestone
1609 {
1610     my $self      = shift;
1611     my $master    = shift;
1612     my $milestone = shift;
1613
1614     $master    = Eis::to_string($master);
1615     $milestone = Eis::to_string($milestone);
1616
1617     my $eis = Cws::eis();
1618     my $result;
1619     eval { $result = $eis->getMilestoneBuild($master, $milestone) };
1620     if ( $@ ) {
1621         carp("ERROR: get_buildid_for_milestone(): EIS database transaction failed. Reason:\n$@\n");
1622     }
1623     return $result;
1624 }
1625
1626 sub get_childworkspaces_for_milestone
1627 {
1628     my $self      = shift;
1629     my $master    = shift;
1630     my $milestone = shift;
1631
1632     $master    = Eis::to_string($master);
1633     $milestone = Eis::to_string($milestone);
1634
1635     my $eis = Cws::eis();
1636     my $result;
1637     eval { $result = $eis->searchChildWorkspacesForMilestone($master, $milestone) };
1638     if ( $@ ) {
1639         carp("ERROR: get_childworkspaces_for_milestone(): EIS database transaction failed. Reason:\n$@\n");
1640     }
1641     return $result;
1642 }
1643
1644 sub get_cws_with_state_from_eis {
1645     my $self = shift;
1646     my $mws = shift;
1647     my $status = shift;
1648
1649     my $eis = Cws::eis();
1650     my $result;
1651     eval { $result = $eis->getCWSWithState($mws, $status) };
1652     if ( $@ ) {
1653         carp("ERROR: get_cws_with_state_from_eis(): EIS database transaction failed. Reason:\n$@\n");
1654     }
1655     return $result;
1656 }
1657
1658 sub get_task_prios_of_tasks
1659 {
1660     my $self        = shift;
1661     my $ref_taskids = shift;
1662
1663     my $eis = Cws::eis();
1664     my $result;
1665     my @items = ();
1666     foreach ( @{$ref_taskids} ) {
1667         push(@items, Eis::to_string($_));
1668     }
1669
1670     eval { $result = $eis->getTasksPriorities( \@items ) };
1671     if ( $@ ) {
1672         carp("ERROR: get_task_prios_of_tasks(): EIS database transaction failed. Reason:\n$@\n");
1673     }
1674     return $result;
1675 }
1676
1677 sub get_creation_master_from_eis
1678 {
1679     my $self      = shift;
1680
1681     # check if child workspace is valid
1682     my $id = $self->eis_id();
1683     if ( !$id ) {
1684         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1685         return undef;
1686     }
1687
1688     my $eis = Cws::eis();
1689     my $result;
1690     eval { $result = $eis->getCreationMasterWorkspace($id) };
1691     if ( $@ ) {
1692         carp("ERROR: get_creation_master(): EIS database transaction failed. Reason:\n$@\n");
1693     }
1694     return $result;
1695
1696 }
1697
1698 sub get_milestone_integrated_from_eis
1699 {
1700     my $self      = shift;
1701
1702     # check if child workspace is valid
1703     my $id = $self->eis_id();
1704     if ( !$id ) {
1705         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1706         return undef;
1707     }
1708
1709     my $eis = Cws::eis();
1710     my $result;
1711     eval { $result = $eis->getMilestoneIntegrated($id) };
1712     if ( $@ ) {
1713         carp("ERROR: get_milestone_integrated(): EIS database transaction failed. Reason:\n$@\n");
1714     }
1715     return $result;
1716
1717 }
1718
1719 # get isPublic flag from eis
1720 sub get_public_flag_from_eis
1721 {
1722     my $self      = shift;
1723
1724     # check if child workspace is valid
1725     my $id = $self->eis_id();
1726     if ( !$id ) {
1727         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1728         return undef;
1729     }
1730
1731     my $eis = Cws::eis();
1732     my $result;
1733     eval { $result = $eis->isPublic($id) };
1734     if ( $@ ) {
1735         carp("ERROR: get_public_flag(): EIS database transaction failed. Reason:\n$@\n");
1736     }
1737     return $result;
1738 }
1739
1740 # get isPublicMaster flag from eis
1741 sub get_publicmaster_flag_from_eis
1742 {
1743     my $self      = shift;
1744
1745     # check if child workspace is valid
1746     my $master = $self->master();
1747     if ( !$master ) {
1748         carp("ERROR: MasterWorkspace not defined.\n");
1749         return undef;
1750     }
1751
1752     my $eis = Cws::eis();
1753     my $result;
1754     eval { $result = $eis->isPublicMaster($master) };
1755     if ( $@ ) {
1756         carp("ERROR: get_publicmaster_flag(): EIS database transaction failed. Reason:\n$@\n");
1757     }
1758     return $result;
1759 }
1760
1761 # get isSubVersion flag from eis
1762 sub get_subversion_flag_from_eis
1763 {
1764     my $self = shift;
1765
1766     # check if child workspace is valid
1767     my $id = $self->eis_id();
1768     if ( !$id ) {
1769         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1770         return undef;
1771     }
1772
1773     my $eis = Cws::eis();
1774     my $result;
1775     eval { $result = $eis->isSubVersion($id) };
1776     if ( $@ ) {
1777         carp("ERROR: get_subversion_flag(): EIS database transaction failed. Reason:\n$@\n");
1778     }
1779     return $result;
1780 }
1781
1782 # set isSubVersion flag in eis
1783 sub set_subversion_flag_in_eis
1784 {
1785     my $self=shift;
1786     my $status=shift;
1787
1788     my $bool_status=SOAP::Data->type(boolean => $status);
1789
1790     # check if child workspace is valid
1791     my $id = $self->eis_id();
1792     if ( !$id ) {
1793         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1794         return undef;
1795     }
1796
1797     my $eis = Cws::eis();
1798     my $result;
1799     eval { $result = $eis->setSubVersion($id,$bool_status) };
1800     if ( $@ ) {
1801         carp("ERROR: get_subversion_flag(): EIS database transaction failed. Reason:\n$@\n");
1802     }
1803     return $result;
1804 }
1805
1806 sub get_scm_from_eis
1807 {
1808     my $self = shift;
1809
1810     # check if child workspace is valid
1811     my $id = $self->eis_id();
1812     if ( !$id ) {
1813         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1814         return undef;
1815     }
1816
1817     my $eis = Cws::eis();
1818     my $result;
1819     eval { $result = $eis->getSCMName($id) };
1820     if ( $@ ) {
1821         carp("ERROR: get_scm_from_eis(): EIS database transaction failed. Reason:\n$@\n");
1822     }
1823     return $result;
1824 }
1825
1826 sub set_scm_in_eis
1827 {
1828     my $self     = shift;
1829     my $scm_name = shift;
1830
1831     # check if child workspace is valid
1832     my $id = $self->eis_id();
1833     if ( !$id ) {
1834         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1835         return undef;
1836     }
1837
1838     my $eis = Cws::eis();
1839     eval { $eis->setSCMName($id, $scm_name) };
1840     if ( $@ ) {
1841         carp("ERROR: set_scm_in_eis(): EIS database transaction failed. Reason:\n$@\n");
1842         return 0;
1843     }
1844     return 1;
1845 }
1846
1847 sub is_uirelevant_from_eis
1848 {
1849     my $self        = shift;
1850
1851     # check if child workspace is valid
1852     my $id = $self->eis_id();
1853     if ( !$id ) {
1854         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1855         return undef;
1856     }
1857
1858     my $eis = Cws::eis();
1859     my $result;
1860     eval { $result = $eis->isUIRelevant($id) };
1861     if ( $@ ) {
1862         carp("ERROR: is_uirelevant_from_eis(): EIS database transaction failed. Reason:\n$@\n");
1863     }
1864
1865     return $result;
1866 }
1867
1868 sub is_helprelevant_from_eis
1869 {
1870     my $self        = shift;
1871
1872     # check if child workspace is valid
1873     my $id = $self->eis_id();
1874     if ( !$id ) {
1875         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1876         return undef;
1877     }
1878
1879     my $eis = Cws::eis();
1880     my $result;
1881     eval { $result = $eis->isHelpRelevant( $id ) };
1882     if ( $@ ) {
1883         carp("ERROR: is_helprelevant_from_eis(): EIS database transaction failed. Reason:\n$@\n");
1884     }
1885
1886     return $result;
1887 }
1888 sub set_word_count_in_eis
1889 {
1890     my $self        = shift;
1891     my $language    = shift;
1892     my $wordcount   = shift;
1893
1894     # check if child workspace is valid
1895     my $id = $self->eis_id();
1896     if ( !$id ) {
1897         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1898         return undef;
1899     }
1900
1901     my $eis = Cws::eis();
1902     my $result;
1903     eval { $result = $eis->setWordCount( $id , $language , $wordcount ) };
1904     if ( $@ ) {
1905         carp("ERROR: set_word_count_from_eis(): EIS database transaction failed. Reason:\n$@\n");
1906     }
1907
1908     return $result;
1909 }
1910
1911
1912 sub get_l10n_status_from_eis
1913 {
1914     my $self        = shift;
1915
1916     # check if child workspace is valid
1917     my $id = $self->eis_id();
1918     if ( !$id ) {
1919         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1920         return undef;
1921     }
1922
1923     my $eis = Cws::eis();
1924     my $result;
1925     eval { $result = $eis->getL10n( $id ) };
1926     if ( $@ ) {
1927         carp("ERROR: get_l10n_status_from_eis(): EIS database transaction failed. Reason:\n$@\n");
1928     }
1929
1930     return $result;
1931 }
1932
1933 sub set_l10n_status_in_eis
1934 {
1935     my $self        = shift;
1936     my $status      = Eis::to_string( shift );
1937
1938     # check if child workspace is valid
1939     my $id = $self->eis_id();
1940     if ( !$id ) {
1941         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1942         return undef;
1943     }
1944
1945     my $eis = Cws::eis();
1946     my $result;
1947
1948     eval { $result = $eis->setL10n( $id , $status ) };
1949     if ( $@ ) {
1950         carp("ERROR: set_l10n_status_in_eis(): EIS database transaction failed. Reason:\n$@\n");
1951     }
1952
1953     return $result;
1954 }
1955
1956 sub get_is_cws_cloneable_from_eis
1957 {
1958     my $self   = shift;
1959     my $master = Eis::to_string( shift );
1960
1961     # check if child workspace is valid
1962     my $id = $self->eis_id();
1963     if ( !$id ) {
1964         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1965         return undef;
1966     }
1967
1968     my $eis = Cws::eis();
1969     my $result;
1970
1971     eval { $result = $eis->isClonableForMaster($id, $master) };
1972     if ( $@ ) {
1973         carp("ERROR:  get_is_cws_cloneable_from_eis(): EIS database transaction failed. Reason:\n$@\n");
1974     }
1975
1976     return $result;
1977 }
1978
1979 sub clone_cws_in_eis
1980 {
1981     my $self   = shift;
1982     my $master = Eis::to_string( shift );
1983
1984     # check if child workspace is valid
1985     my $id = $self->eis_id();
1986     if ( !$id ) {
1987         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
1988         return undef;
1989     }
1990
1991     my $eis = Cws::eis();
1992     my $result;
1993
1994     eval { $eis->cloneForMaster($id, $master) };
1995     if ( $@ ) {
1996         carp("ERROR:  clone_cws_in_eis(): EIS database transaction failed. Reason:\n$@\n");
1997         return 0;
1998     }
1999
2000     return 1;
2001 }
2002
2003 sub get_release_from_eis
2004 {
2005     my $self   = shift;
2006     my $master = Eis::to_string( shift );
2007
2008     # check if child workspace is valid
2009     my $id = $self->eis_id();
2010     if ( !$id ) {
2011         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
2012         return undef;
2013     }
2014
2015     my $eis = Cws::eis();
2016     my $result;
2017
2018     eval { $result = $eis->getRelease($id) };
2019     if ( $@ ) {
2020         carp("ERROR:  get_release_from_eis(): EIS database transaction failed. Reason:\n$@\n");
2021     }
2022
2023     return $result;
2024 }
2025
2026 sub get_due_date_from_eis
2027 {
2028     my $self   = shift;
2029     my $master = Eis::to_string( shift );
2030
2031     # check if child workspace is valid
2032     my $id = $self->eis_id();
2033     if ( !$id ) {
2034         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
2035         return undef;
2036     }
2037
2038     my $eis = Cws::eis();
2039     my $result;
2040
2041     eval { $result = $eis->getDueDate($id) };
2042     if ( $@ ) {
2043         carp("ERROR:  get_due_date_from_eis(): EIS database transaction failed. Reason:\n$@\n");
2044     }
2045
2046     return $result;
2047 }
2048
2049 sub get_due_date_qa_from_eis
2050 {
2051     my $self   = shift;
2052     my $master = Eis::to_string( shift );
2053
2054     # check if child workspace is valid
2055     my $id = $self->eis_id();
2056     if ( !$id ) {
2057         carp("ERROR: Childworkspace not (yet) registered with EIS.\n");
2058         return undef;
2059     }
2060
2061     my $eis = Cws::eis();
2062     my $result;
2063
2064     eval { $result = $eis->getDueDateQA($id) };
2065     if ( $@ ) {
2066         carp("ERROR:  get_due_date_qa_from_eis(): EIS database transaction failed. Reason:\n$@\n");
2067     }
2068
2069     return $result;
2070 }
2071
2072
2073 #logging
2074 sub set_log_entry_in_eis
2075 {
2076     my $self            = shift;
2077     my $commandline = shift;
2078     my $vcsid           = shift;
2079     my $start           = shift;
2080     my $end                     = shift;
2081     my $comment         = shift;
2082
2083     $commandline    = SOAP::Data->type(string => $commandline);
2084     $comment        = SOAP::Data->type(string => $comment);
2085
2086     # *format* for  $start and $end = "2003-05-28 12:34:59";
2087
2088 #=====================================================
2089     #TO DO:
2090     #experimenell für saubere schnittstelle
2091     #$start = SOAP::Data->type(dateTime => $start);
2092     #$end = SOAP::Data->type(dateTime => $end);
2093 #=====================================================
2094
2095     my $eis = Cws::eis();
2096     my $result;
2097     eval { $result = $eis->storeCommandLogEntry( $commandline, $vcsid, $start, $end, $comment ) };
2098     if ( $@ ) {
2099         carp("ERROR: set_log_entry(): Logging failed. Reason:\n$@\n");
2100     }
2101     return $result;
2102 }
2103
2104 #set_log_entry_extended_in_eis($commandname, $parameter, $vcsid, $start, $stop, $comment, $mastername, $childname);
2105 sub set_log_entry_extended_in_eis
2106 {
2107     my $self            = shift;
2108     my $commandname = shift;
2109     my $parameter       = shift;
2110     my $vcsid           = shift;
2111     my $start           = shift;
2112     my $end                     = shift;
2113     my $comment         = shift;
2114     my $mastername      = shift;
2115     my $childname       = shift;
2116
2117     $commandname    = SOAP::Data->type(string => $commandname);
2118     $parameter      = SOAP::Data->type(string => $parameter);
2119     $comment        = SOAP::Data->type(string => $comment);
2120     $mastername         = SOAP::Data->type(string => $mastername);
2121     $childname      = SOAP::Data->type(string => $childname);
2122
2123     # *format* for  $start and $end = "2003-05-28 12:34:59";
2124
2125 #=====================================================
2126     #TO DO:
2127     #experimenell für saubere schnittstelle
2128     #$start = SOAP::Data->type(dateTime => $start);
2129     #$end = SOAP::Data->type(dateTime => $end);
2130 #=====================================================
2131
2132     my $eis = Cws::eis();
2133     my $result;
2134     eval { $result = $eis->storeCommandLogEntry($commandname, $parameter, $vcsid, $start, $end, $comment, $mastername, $childname) };
2135     if ( $@ ) {
2136         carp("ERROR: set_log_entry_extended(): Logging failed. Reason:\n$@\n");
2137     }
2138     return $result;
2139 }
2140
2141
2142 #### class methods ####
2143
2144 sub init_eis_connector
2145 {
2146     my $eis = Eis->new( uri => Cws::eis_uri(),
2147                         proxy_list => Cws::eis_proxy_list(),
2148                         net_proxy => Cws::net_proxy()
2149                       );
2150     return $eis;
2151 }
2152
2153 ####
2154
2155 1; # needed by "use" or "require"
2156 # vim: set ts=4 shiftwidth=4 expandtab syntax=perl: