Tools/Java/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/Clone.java

   1 /** @file
   2
   3  The file is used to clone workspace, module, package and platform
   4
   5  Copyright (c) 2006, Intel Corporation
   6  All rights reserved. This program and the accompanying materials
   7  are licensed and made available under the terms and conditions of the BSD License
   8  which accompanies this distribution.  The full text of the license may be found at
   9  http://opensource.org/licenses/bsd-license.php
  10
  11  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14  **/
  15 package org.tianocore.frameworkwizard;
  16
  17 import java.awt.event.ActionEvent;
  18 import java.io.File;
  19 import java.io.IOException;
  20 import java.math.BigInteger;
  21 import java.util.Vector;
  22
  23 import javax.swing.JFileChooser;
  24 import javax.swing.JPanel;
  25 import javax.swing.JLabel;
  26 import javax.swing.JTextField;
  27 import javax.swing.JButton;
  28
  29 import org.apache.xmlbeans.XmlException;
  30 import org.tianocore.ModuleDefinitionsDocument.ModuleDefinitions;
  31 import org.tianocore.ModuleSurfaceAreaDocument.ModuleSurfaceArea;
  32 import org.tianocore.PackageDefinitionsDocument.PackageDefinitions;
  33 import org.tianocore.PackageSurfaceAreaDocument.PackageSurfaceArea;
  34 import org.tianocore.PlatformDefinitionsDocument.PlatformDefinitions;
  35 import org.tianocore.PlatformSurfaceAreaDocument.PlatformSurfaceArea;
  36 import org.tianocore.frameworkwizard.common.DataType;
  37 import org.tianocore.frameworkwizard.common.DataValidation;
  38 import org.tianocore.frameworkwizard.common.FileOperation;
  39 import org.tianocore.frameworkwizard.common.GlobalData;
  40 import org.tianocore.frameworkwizard.common.IFileFilter;
  41 import org.tianocore.frameworkwizard.common.Log;
  42 import org.tianocore.frameworkwizard.common.OpenFile;
  43 import org.tianocore.frameworkwizard.common.SaveFile;
  44 import org.tianocore.frameworkwizard.common.Tools;
  45 import org.tianocore.frameworkwizard.common.Identifications.Identification;
  46 import org.tianocore.frameworkwizard.common.ui.IDialog;
  47 import org.tianocore.frameworkwizard.common.ui.IFrame;
  48 import org.tianocore.frameworkwizard.module.Identifications.ModuleIdentification;
  49 import org.tianocore.frameworkwizard.packaging.PackageIdentification;
  50 import org.tianocore.frameworkwizard.platform.PlatformIdentification;
  51 import org.tianocore.frameworkwizard.workspace.Workspace;
  52 import org.tianocore.frameworkwizard.workspace.WorkspaceTools;
  53 import javax.swing.JComboBox;
  54
  55 /**
  56  The class is used to provide functions to clone workspace, module, package and platform
  57  It extends IDialog
  58
  59  **/
  60 public class Clone extends IDialog {
  61
  62     ///
  63     /// Define Class Serial Version UID
  64     ///
  65     private static final long serialVersionUID = -5469299324965727137L;
  66
  67     ///
  68     /// Define Class Members
  69     ///
  70     private JPanel jContentPane = null;
  71
  72     private JLabel jLabelType = null;
  73
  74     private JTextField jTextFieldType = null;
  75
  76     private JLabel jLabelSource = null;
  77
  78     private JTextField jTextFieldSource = null;
  79
  80     private JButton jButtonBrowse = null;
  81
  82     private JLabel jLabelDestinationFile = null;
  83
  84     private JTextField jTextFieldFilePath = null;
  85
  86     private JLabel jLabelBaseName = null;
  87
  88     private JTextField jTextFieldBaseName = null;
  89
  90     private JLabel jLabelGuid = null;
  91
  92     private JTextField jTextFieldGuid = null;
  93
  94     private JLabel jLabelVersion = null;
  95
  96     private JTextField jTextFieldVersion = null;
  97
  98     private JButton jButtonOk = null;
  99
 100     private JButton jButtonCancel = null;
 101
 102     private JButton jButtonGenerateGuid = null;
 103
 104     private JLabel jLabelBelong = null;
 105
 106     private JComboBox jComboBoxExistingPackage = null;
 107
 108     ///
 109     /// Define members not for UI
 110     ///
 111
 112     private int mode = -1;
 113
 114     private Vector<PackageIdentification> packages = null;
 115
 116     private WorkspaceTools wt = new WorkspaceTools();
 117
 118     private Identification oldId = null;
 119
 120     private Identification newId = null;
 121
 122     private ModuleIdentification mid = null;
 123
 124     private PackageIdentification pid = null;
 125
 126     private PlatformIdentification fid = null;
 127
 128     /**
 129      This method initializes jTextFieldType
 130
 131      @return javax.swing.JTextField
 132
 133      **/
 134     private JTextField getJTextFieldType() {
 135         if (jTextFieldType == null) {
 136             jTextFieldType = new JTextField();
 137             jTextFieldType.setBounds(new java.awt.Rectangle(210, 10, 320, 20));
 138             jTextFieldType.setEditable(false);
 139         }
 140         return jTextFieldType;
 141     }
 142
 143     /**
 144      This method initializes jTextFieldSource
 145
 146      @return javax.swing.JTextField
 147
 148      **/
 149     private JTextField getJTextFieldSource() {
 150         if (jTextFieldSource == null) {
 151             jTextFieldSource = new JTextField();
 152             jTextFieldSource.setBounds(new java.awt.Rectangle(210, 35, 320, 20));
 153             jTextFieldSource.setEditable(false);
 154         }
 155         return jTextFieldSource;
 156     }
 157
 158     /**
 159      This method initializes jButtonBrowse
 160
 161      @return javax.swing.JButton
 162
 163      **/
 164     private JButton getJButtonBrowse() {
 165         if (jButtonBrowse == null) {
 166             jButtonBrowse = new JButton();
 167             jButtonBrowse.setBounds(new java.awt.Rectangle(445, 85, 85, 20));
 168             jButtonBrowse.setText("Browse");
 169             jButtonBrowse.addActionListener(this);
 170         }
 171         return jButtonBrowse;
 172     }
 173
 174     /**
 175      This method initializes jTextFieldDestinationFile
 176
 177      @return javax.swing.JTextField
 178
 179      **/
 180     private JTextField getJTextFieldFilePath() {
 181         if (jTextFieldFilePath == null) {
 182             jTextFieldFilePath = new JTextField();
 183             jTextFieldFilePath.setBounds(new java.awt.Rectangle(210, 85, 230, 20));
 184         }
 185         return jTextFieldFilePath;
 186     }
 187
 188     /**
 189      This method initializes jTextFieldBaseName
 190
 191      @return javax.swing.JTextField
 192
 193      **/
 194     private JTextField getJTextFieldBaseName() {
 195         if (jTextFieldBaseName == null) {
 196             jTextFieldBaseName = new JTextField();
 197             jTextFieldBaseName.setBounds(new java.awt.Rectangle(210, 110, 320, 20));
 198         }
 199         return jTextFieldBaseName;
 200     }
 201
 202     /**
 203      This method initializes jTextFieldGuid
 204
 205      @return javax.swing.JTextField
 206
 207      **/
 208     private JTextField getJTextFieldGuid() {
 209         if (jTextFieldGuid == null) {
 210             jTextFieldGuid = new JTextField();
 211             jTextFieldGuid.setBounds(new java.awt.Rectangle(210, 135, 230, 20));
 212         }
 213         return jTextFieldGuid;
 214     }
 215
 216     /**
 217      This method initializes jTextFieldVersion
 218
 219      @return javax.swing.JTextField
 220
 221      **/
 222     private JTextField getJTextFieldVersion() {
 223         if (jTextFieldVersion == null) {
 224             jTextFieldVersion = new JTextField();
 225             jTextFieldVersion.setBounds(new java.awt.Rectangle(210, 160, 320, 20));
 226         }
 227         return jTextFieldVersion;
 228     }
 229
 230     /**
 231      This method initializes jButtonOk
 232
 233      @return javax.swing.JButton
 234
 235      **/
 236     private JButton getJButtonOk() {
 237         if (jButtonOk == null) {
 238             jButtonOk = new JButton();
 239             jButtonOk.setBounds(new java.awt.Rectangle(285, 200, 90, 20));
 240             jButtonOk.setText("Ok");
 241             jButtonOk.addActionListener(this);
 242         }
 243         return jButtonOk;
 244     }
 245
 246     /**
 247      This method initializes jButtonCancel
 248
 249      @return javax.swing.JButton
 250
 251      **/
 252     private JButton getJButtonCancel() {
 253         if (jButtonCancel == null) {
 254             jButtonCancel = new JButton();
 255             jButtonCancel.setBounds(new java.awt.Rectangle(405, 200, 90, 20));
 256             jButtonCancel.setText("Cancel");
 257             jButtonCancel.addActionListener(this);
 258         }
 259         return jButtonCancel;
 260     }
 261
 262     /**
 263      This method initializes jButtonGenerateGuid
 264
 265      @return javax.swing.JButton
 266
 267      **/
 268     private JButton getJButtonGenerateGuid() {
 269         if (jButtonGenerateGuid == null) {
 270             jButtonGenerateGuid = new JButton();
 271             jButtonGenerateGuid.setBounds(new java.awt.Rectangle(445, 135, 85, 20));
 272             jButtonGenerateGuid.setText("Gen");
 273             jButtonGenerateGuid.addActionListener(this);
 274         }
 275         return jButtonGenerateGuid;
 276     }
 277
 278     /**
 279      This method initializes jComboBoxExistingPackage
 280
 281      @return javax.swing.JComboBox
 282
 283      **/
 284     private JComboBox getJComboBoxExistingPackage() {
 285         if (jComboBoxExistingPackage == null) {
 286             jComboBoxExistingPackage = new JComboBox();
 287             jComboBoxExistingPackage.setBounds(new java.awt.Rectangle(210, 60, 320, 20));
 288         }
 289         return jComboBoxExistingPackage;
 290     }
 291
 292     /**
 293      This is the default constructor
 294
 295      **/
 296     public Clone() {
 297         super();
 298         init();
 299     }
 300
 301     /**
 302      This is the override constructor
 303
 304      @param parentFrame       The parent frame which starts this frame
 305      @param modal             To identify the frame's modal
 306      @param fileType          To identify the clone target type
 307      @param identification    The clone target's identification
 308
 309      **/
 310     public Clone(IFrame parentFrame, boolean modal, int fileType, Identification identification) {
 311         super(parentFrame, modal);
 312         this.mode = fileType;
 313         if (identification != null) {
 314             this.oldId = new Identification(identification.getName(), identification.getGuid(),
 315                                             identification.getVersion(), identification.getPath());
 316             this.newId = new Identification(identification.getName(), identification.getGuid(),
 317                                             identification.getVersion(), identification.getPath());
 318         }
 319         init(mode);
 320     }
 321
 322     /**
 323      Query all existing packages and fill them into combox
 324
 325      **/
 326     private void initExistingPackage() {
 327         packages = wt.getAllPackages();
 328         for (int index = 0; index < packages.size(); index++) {
 329             this.jComboBoxExistingPackage.addItem(packages.elementAt(index).getName());
 330         }
 331     }
 332
 333     /**
 334      This method initializes this
 335
 336      **/
 337     private void init() {
 338         this.setSize(550, 260);
 339         this.setContentPane(getJContentPane());
 340         this.setTitle("Clone");
 341         this.centerWindow();
 342     }
 343
 344     /**
 345      This method initializes this with given clone target type.
 346      Customize the frame interface via different clone target type.
 347
 348      @param mode To identify the clone target type
 349
 350      **/
 351     private void init(int mode) {
 352         init();
 353         //
 354         // For MODULE_SURFACE_AREA
 355         //
 356         if (mode == DataType.RETURN_TYPE_MODULE_SURFACE_AREA) {
 357             this.jTextFieldType.setText(DataType.MODULE_SURFACE_AREA);
 358             String s = oldId.getPath();
 359             s = Tools.getRelativePath(s, Tools.getFilePathOnly(wt.getPackageIdByModuleId(oldId).getPath()));
 360             this.jTextFieldSource.setText(Tools.convertPathToCurrentOsType(s));
 361             initExistingPackage();
 362             this.jButtonBrowse.setVisible(false);
 363             this.jTextFieldFilePath
 364                                    .setToolTipText("<html>Input the module's relative path and filename, for example:<br>Application\\HelloWorld\\HelloWorld.msa</html>");
 365             this.jTextFieldFilePath.setSize(320, this.jTextFieldFilePath.getSize().height);
 366             this.jLabelDestinationFile.setText("New Module Path and Filename");
 367         }
 368         //
 369         // For PACKAGE_SURFACE_AREA
 370         //
 371         if (mode == DataType.RETURN_TYPE_PACKAGE_SURFACE_AREA) {
 372             this.jTextFieldType.setText(DataType.PACKAGE_SURFACE_AREA);
 373             String s = oldId.getPath();
 374             s = Tools.getRelativePath(oldId.getPath(), Workspace.getCurrentWorkspace());
 375             this.jTextFieldSource.setText(Tools.convertPathToCurrentOsType(s));
 376             this.jLabelBelong.setEnabled(false);
 377             this.jComboBoxExistingPackage.setEnabled(false);
 378             this.jButtonBrowse.setVisible(false);
 379             this.jTextFieldFilePath
 380                                    .setToolTipText("<html>Input the package's relative path and file name, for example:<br>MdePkg\\MdePkg.spd</html>");
 381             this.jTextFieldFilePath.setSize(320, this.jTextFieldFilePath.getSize().height);
 382             this.jLabelDestinationFile.setText("New Package Path and Filename");
 383
 384             //
 385             // Check if the package can be cloned
 386             //
 387             PackageSurfaceArea spd = GlobalData.openingPackageList
 388                                                                   .getPackageSurfaceAreaFromId(GlobalData.openingPackageList
 389                                                                                                                             .getIdByPath(this.oldId
 390                                                                                                                                                    .getPath()));
 391             if (spd != null) {
 392                 if (spd.getPackageDefinitions() != null) {
 393                     if (!spd.getPackageDefinitions().getRePackage()) {
 394                         Log.wrn("Clone Package", "This package can't repackaged and cloned");
 395                         this.jTextFieldBaseName.setEnabled(false);
 396                         this.jTextFieldFilePath.setEnabled(false);
 397                         this.jTextFieldGuid.setEnabled(false);
 398                         this.jTextFieldVersion.setEnabled(false);
 399                         this.jButtonGenerateGuid.setEnabled(false);
 400                         this.jButtonOk.setEnabled(false);
 401                     }
 402                 }
 403             }
 404         }
 405         //
 406         // For PLATFORM_SURFACE_AREA
 407         //
 408         if (mode == DataType.RETURN_TYPE_PLATFORM_SURFACE_AREA) {
 409             this.jTextFieldType.setText(DataType.PLATFORM_SURFACE_AREA);
 410             this.jTextFieldSource.setText(oldId.getPath());
 411             this.jLabelBelong.setEnabled(false);
 412             this.jComboBoxExistingPackage.setEnabled(false);
 413             this.jTextFieldFilePath
 414                                    .setToolTipText("<html>Select the platform's relative path and filename. For example:<br>C:\\MyWorkspace\\EdkNt32Pkg\\Nt32.fpd</html>");
 415             this.jLabelDestinationFile.setText("New Platform Path and Filename");
 416         }
 417         //
 418         // For WORKSPACE
 419         //
 420         if (mode == DataType.RETURN_TYPE_WORKSPACE) {
 421             this.jTextFieldType.setText(DataType.WORKSPACE);
 422             this.jTextFieldSource.setText(Workspace.getCurrentWorkspace());
 423             this.jLabelBelong.setEnabled(false);
 424             this.jComboBoxExistingPackage.setEnabled(false);
 425             this.jLabelBaseName.setEnabled(false);
 426             this.jTextFieldBaseName.setEditable(false);
 427             this.jLabelGuid.setEnabled(false);
 428             this.jTextFieldGuid.setEnabled(false);
 429             this.jButtonGenerateGuid.setEnabled(false);
 430             this.jLabelVersion.setEnabled(false);
 431             this.jTextFieldVersion.setEnabled(false);
 432             this.jTextFieldFilePath
 433                                    .setToolTipText("<html>Input the workspace path, for example:<br>C:\\MyWorkspace</html>");
 434             this.jLabelDestinationFile.setText("New Workspace Path");
 435         }
 436     }
 437
 438     /**
 439      This method initializes jContentPane
 440
 441      @return javax.swing.JPanel
 442
 443      **/
 444     private JPanel getJContentPane() {
 445         if (jContentPane == null) {
 446             jLabelBelong = new JLabel();
 447             jLabelBelong.setBounds(new java.awt.Rectangle(15, 60, 190, 20));
 448             jLabelBelong.setText("Clone Package");
 449             jLabelVersion = new JLabel();
 450             jLabelVersion.setBounds(new java.awt.Rectangle(15, 160, 190, 20));
 451             jLabelVersion.setText("Version");
 452             jLabelGuid = new JLabel();
 453             jLabelGuid.setBounds(new java.awt.Rectangle(15, 135, 190, 20));
 454             jLabelGuid.setText("Guid");
 455             jLabelBaseName = new JLabel();
 456             jLabelBaseName.setBounds(new java.awt.Rectangle(15, 110, 190, 20));
 457             jLabelBaseName.setText("Base Name");
 458             jLabelDestinationFile = new JLabel();
 459             jLabelDestinationFile.setBounds(new java.awt.Rectangle(15, 85, 190, 20));
 460             jLabelDestinationFile.setText("Destination File Name");
 461             jLabelSource = new JLabel();
 462             jLabelSource.setBounds(new java.awt.Rectangle(15, 35, 190, 20));
 463             jLabelSource.setText("Source");
 464             jLabelType = new JLabel();
 465             jLabelType.setBounds(new java.awt.Rectangle(15, 10, 190, 20));
 466             jLabelType.setText("Type");
 467             jContentPane = new JPanel();
 468             jContentPane.setLayout(null);
 469             jContentPane.setSize(new java.awt.Dimension(540, 227));
 470             jContentPane.add(jLabelType, null);
 471             jContentPane.add(getJTextFieldType(), null);
 472             jContentPane.add(jLabelSource, null);
 473             jContentPane.add(getJTextFieldSource(), null);
 474             jContentPane.add(jLabelDestinationFile, null);
 475             jContentPane.add(getJTextFieldFilePath(), null);
 476             jContentPane.add(jLabelBaseName, null);
 477             jContentPane.add(getJTextFieldBaseName(), null);
 478             jContentPane.add(jLabelGuid, null);
 479             jContentPane.add(getJTextFieldGuid(), null);
 480             jContentPane.add(jLabelVersion, null);
 481             jContentPane.add(getJTextFieldVersion(), null);
 482             jContentPane.add(getJButtonOk(), null);
 483             jContentPane.add(getJButtonCancel(), null);
 484             jContentPane.add(getJButtonBrowse(), null);
 485             jContentPane.add(getJButtonGenerateGuid(), null);
 486             jContentPane.add(jLabelBelong, null);
 487             jContentPane.add(getJComboBoxExistingPackage(), null);
 488         }
 489         return jContentPane;
 490     }
 491
 492     /* (non-Javadoc)
 493      * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
 494      *
 495      * Override actionPerformed to listen all actions
 496      */
 497     public void actionPerformed(ActionEvent arg0) {
 498         if (arg0.getSource() == jButtonCancel) {
 499             this.setVisible(false);
 500             this.returnType = DataType.RETURN_TYPE_CANCEL;
 501         }
 502
 503         if (arg0.getSource() == jButtonOk) {
 504             if (this.check()) {
 505                 try {
 506                     //
 507                     // Save to file
 508                     //
 509                     this.save();
 510                 } catch (IOException e) {
 511                     Log.wrn("Clone", e.getMessage());
 512                     Log.err("Clone", e.getMessage());
 513                     return;
 514                 } catch (XmlException e) {
 515                     Log.wrn("Clone", e.getMessage());
 516                     Log.err("Clone", e.getMessage());
 517                     return;
 518                 } catch (Exception e) {
 519                     Log.wrn("Clone", e.getMessage());
 520                     Log.err("Clone", e.getMessage());
 521                     return;
 522                 }
 523             } else {
 524                 return;
 525             }
 526             this.setVisible(false);
 527         }
 528
 529         if (arg0.getSource() == this.jButtonGenerateGuid) {
 530             this.jTextFieldGuid.setText(Tools.generateUuidString());
 531         }
 532
 533         //
 534         // Use different file ext for different clone target type
 535         //
 536         if (arg0.getSource() == this.jButtonBrowse) {
 537             JFileChooser fc = new JFileChooser();
 538             fc.setAcceptAllFileFilterUsed(false);
 539
 540             if (mode == DataType.RETURN_TYPE_WORKSPACE) {
 541                 fc.setCurrentDirectory(new File(Workspace.getCurrentWorkspace()));
 542                 fc.setFileSelectionMode(JFileChooser.DIRECTORIES_ONLY);
 543             }
 544             if (mode == DataType.RETURN_TYPE_MODULE_SURFACE_AREA) {
 545                 fc.setCurrentDirectory(new File(packages.elementAt(this.jComboBoxExistingPackage.getSelectedIndex())
 546                                                         .getPath()));
 547                 fc.addChoosableFileFilter(new IFileFilter(DataType.MODULE_SURFACE_AREA_EXT));
 548             }
 549             if (mode == DataType.RETURN_TYPE_PACKAGE_SURFACE_AREA) {
 550                 fc.setCurrentDirectory(new File(Workspace.getCurrentWorkspace()));
 551                 fc.addChoosableFileFilter(new IFileFilter(DataType.PACKAGE_SURFACE_AREA_EXT));
 552             }
 553             if (mode == DataType.RETURN_TYPE_PLATFORM_SURFACE_AREA) {
 554                 fc.setCurrentDirectory(new File(Workspace.getCurrentWorkspace()));
 555                 fc.addChoosableFileFilter(new IFileFilter(DataType.PLATFORM_SURFACE_AREA_EXT));
 556             }
 557             int result = fc.showSaveDialog(new JPanel());
 558             if (result == JFileChooser.APPROVE_OPTION) {
 559                 this.jTextFieldFilePath.setText(Tools.addPathExt(fc.getSelectedFile().getPath(), mode));
 560             }
 561         }
 562     }
 563
 564     /**
 565      Check name, guid and version.
 566      If all of them are valid, save information to new id
 567
 568      @retval true   All name, guid and version are valid
 569      @retval false  Any one of name, guid and version is invalid
 570
 571      **/
 572     private boolean checkId(int mode) {
 573         String name = this.jTextFieldBaseName.getText();
 574         String guid = this.jTextFieldGuid.getText();
 575         String version = this.jTextFieldVersion.getText();
 576
 577         //
 578         // Check Basename
 579         //
 580         if (isEmpty(name)) {
 581             Log.wrn("Clone", "The Name is required!");
 582             return false;
 583         }
 584         if (!DataValidation.isBaseName(name)) {
 585             Log
 586                .wrn("Clone",
 587                     "<html>Incorrect data type for the Name, it must<br>be a single word, starting with an alpha character.</html>");
 588             return false;
 589         }
 590
 591         //
 592         // Check Guid
 593         //
 594         if (isEmpty(guid)) {
 595             Log.wrn("Clone", "A Guid is required!!");
 596             return false;
 597         }
 598         if (!DataValidation.isGuid(guid)) {
 599             Log
 600                .wrn(
 601                     "Clone",
 602                     "<html>Incorrect data type for Guid, which must<br>be in registry format (8-4-4-4-12) for example:<br>d3adb123-eef1-466d-39ac-02febcaf5997</html>");
 603             return false;
 604         }
 605
 606         //
 607         // Check Version
 608         //
 609         if (isEmpty(version)) {
 610             Log.wrn("Clone", "A Version must be entered!");
 611             return false;
 612         }
 613         if (!DataValidation.isVersion(version)) {
 614             Log
 615                .wrn(
 616                     "Clone",
 617                     "<html>Incorrect data type for Version, which must<br>be one or more digits, optionally followed by sequence<br>of one or more dot,  one or more digits; examples:<br>1.0 1.0.1 12.25.256</html>");
 618             return false;
 619         }
 620
 621         if (mode == DataType.RETURN_TYPE_MODULE_SURFACE_AREA) {
 622             String packageGuid = packages.elementAt(this.jComboBoxExistingPackage.getSelectedIndex()).getGuid();
 623             String packageVersion = packages.elementAt(this.jComboBoxExistingPackage.getSelectedIndex()).getVersion();
 624             if (GlobalData.findModuleId(guid, version, packageGuid, packageVersion) != null) {
 625                 Log.wrn("Clone", "A module with same Guid and same Version already exists, please selece a new Guid or Version!");
 626                 return false;
 627             }
 628         }
 629
 630         if (mode == DataType.RETURN_TYPE_PACKAGE_SURFACE_AREA) {
 631             if (GlobalData.findPackageId(guid, version) != null) {
 632                 Log.wrn("Clone", "A package with same Guid and same Version already exists, please selece a new Guid or Version!");
 633                 return false;
 634             }
 635         }
 636
 637         if (mode == DataType.RETURN_TYPE_PLATFORM_SURFACE_AREA) {
 638             if (GlobalData.findPlatformId(guid, version) != null) {
 639                 Log.wrn("Clone", "A platform with same Guid and same Version already exists, please selece a new Guid or Version!");
 640                 return false;
 641             }
 642         }
 643
 644         //
 645         // Save information to id
 646         //
 647         newId.setName(this.jTextFieldBaseName.getText());
 648         newId.setGuid(this.jTextFieldGuid.getText());
 649         newId.setVersion(this.jTextFieldVersion.getText());
 650         newId.setPath(this.jTextFieldFilePath.getText());
 651
 652         return true;
 653     }
 654
 655     /**
 656      Check before save
 657
 658      @retval true   All check points are passed
 659      @retval false  Any one of check points is failed
 660
 661      **/
 662     private boolean check() {
 663         String src = this.oldId.getPath();
 664         String trg = this.jTextFieldFilePath.getText();
 665         File srcFile = new File(src);
 666         File trgFile = new File(trg);
 667
 668         //
 669         // Common Check
 670         //
 671         if (!srcFile.exists()) {
 672             Log.wrn("Clone", "The source file does not exist!");
 673             return false;
 674         }
 675         if (isEmpty(trg)) {
 676             Log.wrn("Clone", "The destination file path must be entered!");
 677             return false;
 678         }
 679         if (src.equals(trg)) {
 680             Log.wrn("Clone", "The source and destination can not be same!");
 681             return false;
 682         }
 683         if (trgFile.exists()) {
 684             Log.wrn("Clone", "The destination already exists!");
 685             return false;
 686         }
 687
 688         //
 689         // Check for workspace
 690         //
 691         if (mode == DataType.RETURN_TYPE_WORKSPACE) {
 692             if (trg.indexOf(src + DataType.FILE_SEPARATOR) == 0) {
 693                 Log.wrn("Clone", "The new workspace can not be located within the current workspace!");
 694                 return false;
 695             }
 696         }
 697
 698         //
 699         // Check for Module
 700         //
 701         if (mode == DataType.RETURN_TYPE_MODULE_SURFACE_AREA) {
 702             trg = this.getModulePath();
 703             if (Tools.getFilePathOnly(src).equals(Tools.getFilePathOnly(trg))) {
 704                 Log.wrn("Clone", "The source and destination paths for cloning a module must be different!");
 705                 return false;
 706             }
 707             trgFile = new File(trg);
 708             if (trgFile.exists()) {
 709                 Log.wrn("Clone", "The target module already exists!");
 710                 return false;
 711             }
 712             if (GlobalData.isDuplicateRelativePath(Tools.getFilePathOnly(trg), mode)) {
 713                 Log.wrn("Clone", "There already exists a same directory with a module");
 714                 return false;
 715             }
 716
 717             return checkId(mode);
 718         }
 719
 720         //
 721         // Check for Package
 722         //
 723         if (mode == DataType.RETURN_TYPE_PACKAGE_SURFACE_AREA) {
 724             if (trg.indexOf(DataType.DOS_FILE_SEPARATOR) == -1 && trg.indexOf(DataType.UNIX_FILE_SEPARATOR) == -1) {
 725                 Log.wrn("Clone", "The package name must include a path!");
 726                 return false;
 727             }
 728             trg = this.getPackagePath();
 729             if (Tools.getFilePathOnly(src).equals(Tools.getFilePathOnly(trg))) {
 730                 Log.wrn("Clone", "The source and destination paths for cloning a package must be different!");
 731                 return false;
 732             }
 733             trgFile = new File(trg);
 734             if (trgFile.exists()) {
 735                 Log.wrn("Clone", "The target package already exists!");
 736                 return false;
 737             }
 738             if (GlobalData.isDuplicateRelativePath(Tools.getFilePathOnly(trg), mode)) {
 739                 Log.wrn("Clone", "There already exists a same directory with a package");
 740                 return false;
 741             }
 742
 743             return checkId(mode);
 744         }
 745
 746         //
 747         // Check for Platform
 748         //
 749         if (mode == DataType.RETURN_TYPE_PLATFORM_SURFACE_AREA) {
 750             if (trg.indexOf(Workspace.getCurrentWorkspace()) != 0) {
 751                 Log.wrn("Clone", "The platform clone must be located in the current workspace!");
 752                 return false;
 753             }
 754             if (Tools.getFilePathOnly(src).equals(Tools.getFilePathOnly(trg))) {
 755                 Log.wrn("Clone", "The source and destination paths for cloning a platform must be different!");
 756                 return false;
 757             }
 758             trgFile = new File(trg);
 759             if (trgFile.exists()) {
 760                 Log.wrn("Clone", "The target platform already exists.");
 761                 return false;
 762             }
 763             if (GlobalData.isDuplicateRelativePath(Tools.getFilePathOnly(trg), mode)) {
 764                 Log.wrn("Clone", "There already exists a same directory with a platform");
 765                 return false;
 766             }
 767
 768             return checkId(mode);
 769         }
 770
 771         return true;
 772     }
 773
 774     /**
 775      Save clone target to new location
 776
 777      @throws IOException
 778      @throws XmlException
 779      @throws Exception
 780
 781      **/
 782     private void save() throws IOException, XmlException, Exception {
 783         String src = this.oldId.getPath();
 784         String trg = this.jTextFieldFilePath.getText();
 785         Vector<String> vFiles = new Vector<String>();
 786
 787         //
 788         // Clone Workspace
 789         //
 790         if (mode == DataType.RETURN_TYPE_WORKSPACE) {
 791             FileOperation.copyFolder(src, trg);
 792             this.returnType = DataType.RETURN_TYPE_WORKSPACE;
 793         }
 794
 795         //
 796         // Clone Module Surface Area
 797         //
 798         if (mode == DataType.RETURN_TYPE_MODULE_SURFACE_AREA) {
 799             //
 800             // Get target path from source path
 801             //
 802             trg = getModulePath();
 803             newId.setPath(trg);
 804             vFiles = wt.getAllFilesPathOfModule(src);
 805
 806             String oldPackagePath = GlobalData.openingModuleList.getIdByPath(src).getPackageId().getPath();
 807             String newPackagePath = packages.elementAt(this.jComboBoxExistingPackage.getSelectedIndex()).getPath();
 808
 809             //
 810             // First copy all files to new directory
 811             //
 812             FileOperation.copyFile(src, trg);
 813             for (int index = 1; index < vFiles.size(); index++) {
 814                 String oldFile = vFiles.get(index);
 815                 String newFile = "";
 816                 if (oldFile.indexOf(Tools.getFilePathOnly(src)) > -1) {
 817                     //
 818                     // The file is not include header
 819                     //
 820                     newFile = oldFile.replace(Tools.getFilePathOnly(src), Tools.getFilePathOnly(trg));
 821                 } else if (oldFile.indexOf(Tools.getFilePathOnly(oldPackagePath)) > -1) {
 822                     //
 823                     // The file is include header
 824                     //
 825                     newFile = oldFile.replace(Tools.getFilePathOnly(oldPackagePath),
 826                                               Tools.getFilePathOnly(newPackagePath));
 827                 }
 828
 829                 FileOperation.copyFile(oldFile, newFile);
 830             }
 831
 832             //
 833             // Create new msa file
 834             //
 835             ModuleSurfaceArea msa = null;
 836             msa = OpenFile.openMsaFile(src);
 837
 838             //
 839             // Update to memory
 840             //
 841             msa.getMsaHeader().setModuleName(newId.getName());
 842             msa.getMsaHeader().setGuidValue(newId.getGuid());
 843             msa.getMsaHeader().setVersion(newId.getVersion());
 844
 845             //
 846             // Update <Cloned> Section
 847             //
 848             updateModuleClonedId(msa, oldId);
 849
 850             //
 851             // Save to file
 852             //
 853             SaveFile.saveMsaFile(trg, msa);
 854
 855             //
 856             // Update to platformId
 857             //
 858             this.setMid(new ModuleIdentification(newId,
 859                                                  packages.elementAt(this.jComboBoxExistingPackage.getSelectedIndex())));
 860
 861             //
 862             // Open belonging package
 863             //
 864             PackageSurfaceArea psa = PackageSurfaceArea.Factory.newInstance();
 865             psa = OpenFile.openSpdFile(mid.getPackageId().getPath());
 866
 867             //
 868             // Update the db file
 869             //
 870             wt.addModuleToPackage(mid, psa);
 871
 872             //
 873             // Update GlobalData
 874             //
 875             GlobalData.vModuleList.addElement(mid);
 876             GlobalData.openingModuleList.insertToOpeningModuleList(mid, msa);
 877
 878             this.returnType = DataType.RETURN_TYPE_MODULE_SURFACE_AREA;
 879         }
 880
 881         //
 882         // Clone Package Surface Area
 883         //
 884         if (mode == DataType.RETURN_TYPE_PACKAGE_SURFACE_AREA) {
 885             //
 886             // Get target path from source path
 887             //
 888             trg = this.getPackagePath();
 889             newId.setPath(trg);
 890             vFiles = wt.getAllFilesPathOfPakcage(src);
 891
 892             //
 893             // First copy all files to new directory
 894             //
 895             FileOperation.copyFile(src, trg);
 896             for (int index = 1; index < vFiles.size(); index++) {
 897                 String oldFile = vFiles.get(index);
 898                 String newFile = vFiles.get(index).replace(Tools.getFilePathOnly(src), Tools.getFilePathOnly(trg));
 899                 FileOperation.copyFile(oldFile, newFile);
 900             }
 901
 902             //
 903             // Create new spd file
 904             //
 905             PackageSurfaceArea spd = null;
 906             spd = OpenFile.openSpdFile(src);
 907
 908             //
 909             // Update to memory
 910             //
 911             spd.getSpdHeader().setPackageName(newId.getName());
 912             spd.getSpdHeader().setGuidValue(newId.getGuid());
 913             spd.getSpdHeader().setVersion(newId.getVersion());
 914
 915             //
 916             // Update <Cloned> Section
 917             //
 918             updatePackageClonedId(spd, oldId);
 919
 920             //
 921             // Save to file
 922             //
 923             SaveFile.saveSpdFile(trg, spd);
 924
 925             //
 926             // Update to platformId
 927             //
 928             this.setPid(new PackageIdentification(newId));
 929
 930             //
 931             // Update the db file
 932             //
 933             wt.addPackageToDatabase(pid);
 934
 935             //
 936             // Update GlobalData
 937             //
 938             GlobalData.vPackageList.addElement(pid);
 939             GlobalData.openingPackageList.insertToOpeningPackageList(pid, spd);
 940
 941             //
 942             // Add all cloned modules
 943             //
 944             Vector<String> modulePaths = GlobalData.getAllModulesOfPackage(pid.getPath());
 945             String modulePath = null;
 946             ModuleSurfaceArea msa = null;
 947
 948             for (int indexJ = 0; indexJ < modulePaths.size(); indexJ++) {
 949                 try {
 950                     modulePath = modulePaths.get(indexJ);
 951                     msa = OpenFile.openMsaFile(modulePath);
 952                 } catch (IOException e) {
 953                     Log.err("Open Module Surface Area " + modulePath, e.getMessage());
 954                     continue;
 955                 } catch (XmlException e) {
 956                     Log.err("Open Module Surface Area " + modulePath, e.getMessage());
 957                     continue;
 958                 } catch (Exception e) {
 959                     Log.err("Open Module Surface Area " + modulePath, "Invalid file type");
 960                     continue;
 961                 }
 962                 Identification id = Tools.getId(modulePath, msa);
 963                 mid = new ModuleIdentification(id, pid);
 964                 GlobalData.vModuleList.addElement(mid);
 965                 GlobalData.openingModuleList.insertToOpeningModuleList(mid, msa);
 966             }
 967
 968             this.returnType = DataType.RETURN_TYPE_PACKAGE_SURFACE_AREA;
 969         }
 970
 971         //
 972         // Clone Platform Surface Area
 973         //
 974         if (mode == DataType.RETURN_TYPE_PLATFORM_SURFACE_AREA) {
 975             PlatformSurfaceArea fpd = null;
 976             fpd = OpenFile.openFpdFile(src);
 977
 978             //
 979             // Update to memory
 980             //
 981             fpd.getPlatformHeader().setPlatformName(newId.getName());
 982             fpd.getPlatformHeader().setGuidValue(newId.getGuid());
 983             fpd.getPlatformHeader().setVersion(newId.getVersion());
 984
 985             //
 986             // Update Cloned From element
 987             //
 988             updatePlatformClonedId(fpd, oldId);
 989
 990             //
 991             // Save to file
 992             //
 993             SaveFile.saveFpdFile(trg, fpd);
 994
 995             //
 996             // Update to platformId
 997             //
 998             this.setFid(new PlatformIdentification(newId));
 999
1000             //
1001             // Update the db file
1002             //
1003             wt.addPlatformToDatabase(fid);
1004
1005             //
1006             // Update GlobalData
1007             //
1008             GlobalData.vPlatformList.addElement(fid);
1009             GlobalData.openingPlatformList.insertToOpeningPlatformList(fid, fpd);
1010
1011             this.returnType = DataType.RETURN_TYPE_PLATFORM_SURFACE_AREA;
1012         }
1013         vFiles = null;
1014     }
1015
1016     /**
1017      Get the path of selected package
1018
1019      @return String The path of selected package
1020
1021      **/
1022     private String getSelectPackagePath() {
1023         return Tools.getFilePathOnly(packages.elementAt(this.jComboBoxExistingPackage.getSelectedIndex()).getPath());
1024     }
1025
1026     /**
1027      Get the path of source module
1028      Since the path of source module is relative, make it up to full path.
1029
1030      @return String The full path of source module
1031
1032      **/
1033     private String getModulePath() {
1034         String trg = this.jTextFieldFilePath.getText();
1035         trg = Tools.addPathExt(trg, mode);
1036         trg = Tools.addFileSeparator(getSelectPackagePath()) + trg;
1037         Tools.convertPathToCurrentOsType(trg);
1038         return trg;
1039     }
1040
1041     /**
1042      Get the path of source package
1043      Since the path of source package is relative, make it up to full path.
1044
1045      @return String The full path of source package
1046
1047      **/
1048     private String getPackagePath() {
1049         String trg = this.jTextFieldFilePath.getText();
1050         trg = Tools.addPathExt(trg, mode);
1051         trg = Tools.addFileSeparator(Workspace.getCurrentWorkspace()) + trg;
1052         trg = Tools.convertPathToCurrentOsType(trg);
1053         return trg;
1054     }
1055
1056     /**
1057      Set msa file's <Cloned> section via given identification
1058
1059      @param msa ModuleSurfaceArea for clone target
1060      @param id Identification of clone source
1061
1062      **/
1063     private void updateModuleClonedId(ModuleSurfaceArea msa, Identification id) {
1064         //
1065         // Get PlatformDefinitions First
1066         //
1067         ModuleDefinitions pd = null;
1068         if (msa.getModuleDefinitions() == null) {
1069             pd = ModuleDefinitions.Factory.newInstance();
1070             msa.addNewModuleDefinitions();
1071         } else {
1072             pd = msa.getModuleDefinitions();
1073         }
1074
1075         //
1076         // Get ClonedFrom then
1077         //
1078         ModuleDefinitions.ClonedFrom cf = null;
1079         BigInteger count = new BigInteger("-1");
1080         if (pd.getClonedFrom() == null) {
1081             cf = ModuleDefinitions.ClonedFrom.Factory.newInstance();
1082         } else {
1083             cf = pd.getClonedFrom();
1084             if (cf != null) {
1085                 for (int index = 0; index < cf.getClonedList().size(); index++) {
1086                     if (cf.getClonedList().get(index).getId() != null) {
1087                         count = count.max(cf.getClonedList().get(index).getId());
1088                     }
1089                 }
1090             }
1091         }
1092
1093         //
1094         // Set new Cloned item
1095         //
1096         ModuleDefinitions.ClonedFrom.Cloned c = ModuleDefinitions.ClonedFrom.Cloned.Factory.newInstance();
1097         c.setModuleGuid(id.getGuid());
1098         c.setModuleVersion(id.getVersion());
1099         c.setPackageGuid(wt.getPackageIdByModuleId(oldId).getGuid());
1100         c.setPackageVersion(wt.getPackageIdByModuleId(oldId).getVersion());
1101         c.setId(count.add(new BigInteger("1")));
1102         String guid = wt.getModuleFarGuid(oldId);
1103         if (guid != null && !guid.equals("")) {
1104             c.setFarGuid(guid);
1105         }
1106
1107         cf.addNewCloned();
1108         cf.setClonedArray(cf.getClonedList().size() - 1, c);
1109         pd.addNewClonedFrom();
1110         pd.setClonedFrom(cf);
1111         msa.setModuleDefinitions(pd);
1112     }
1113
1114     /**
1115      Set spd file's <Cloned> section via given identification
1116
1117      @param spd PackageSurfaceArea for clone target
1118      @param id Identification of clone source
1119
1120      **/
1121     private void updatePackageClonedId(PackageSurfaceArea spd, Identification id) {
1122         //
1123         // Get PlatformDefinitions First
1124         //
1125         PackageDefinitions pd = null;
1126         if (spd.getPackageDefinitions() == null) {
1127             pd = PackageDefinitions.Factory.newInstance();
1128             spd.addNewPackageDefinitions();
1129         } else {
1130             pd = spd.getPackageDefinitions();
1131         }
1132
1133         //
1134         // Get ClonedFrom then
1135         //
1136         PackageDefinitions.ClonedFrom cf = null;
1137         BigInteger count = new BigInteger("-1");
1138         if (pd.getClonedFrom() == null) {
1139             cf = PackageDefinitions.ClonedFrom.Factory.newInstance();
1140         } else {
1141             cf = pd.getClonedFrom();
1142             if (cf != null) {
1143                 for (int index = 0; index < cf.getClonedList().size(); index++) {
1144                     if (cf.getClonedList().get(index).getId() != null) {
1145                         count = count.max(cf.getClonedList().get(index).getId());
1146                     }
1147                 }
1148             }
1149         }
1150
1151         //
1152         // Set new Cloned item
1153         //
1154         PackageDefinitions.ClonedFrom.Cloned c = PackageDefinitions.ClonedFrom.Cloned.Factory.newInstance();
1155         c.setPackageGuid(id.getGuid());
1156         c.setPackageVersion(id.getVersion());
1157         c.setId(count.add(new BigInteger("1")));
1158         String guid = wt.getPackageFarGuid(oldId);
1159         if (guid != null && !guid.equals("")) {
1160             c.setFarGuid(guid);
1161         }
1162
1163         cf.addNewCloned();
1164         cf.setClonedArray(cf.getClonedList().size() - 1, c);
1165         pd.addNewClonedFrom();
1166         pd.setClonedFrom(cf);
1167         spd.setPackageDefinitions(pd);
1168     }
1169
1170     /**
1171      Set fpd file's <Cloned> section via given identification
1172
1173      @param fpd PlatformSurfaceArea for clone target
1174      @param id Identification of clone source
1175
1176      **/
1177     private void updatePlatformClonedId(PlatformSurfaceArea fpd, Identification id) {
1178         //
1179         // Get PlatformDefinitions First
1180         //
1181         PlatformDefinitions pd = null;
1182         if (fpd.getPlatformDefinitions() == null) {
1183             pd = PlatformDefinitions.Factory.newInstance();
1184             fpd.addNewPlatformDefinitions();
1185         } else {
1186             pd = fpd.getPlatformDefinitions();
1187         }
1188
1189         //
1190         // Get ClonedFrom then
1191         //
1192         PlatformDefinitions.ClonedFrom cf = null;
1193         BigInteger count = new BigInteger("-1");
1194         if (pd.getClonedFrom() == null) {
1195             cf = PlatformDefinitions.ClonedFrom.Factory.newInstance();
1196         } else {
1197             cf = pd.getClonedFrom();
1198             if (cf != null) {
1199                 for (int index = 0; index < cf.getClonedList().size(); index++) {
1200                     if (cf.getClonedList().get(index).getId() != null) {
1201                         count = count.max(cf.getClonedList().get(index).getId());
1202                     }
1203                 }
1204             }
1205         }
1206
1207         //
1208         // Set new Cloned item
1209         //
1210         PlatformDefinitions.ClonedFrom.Cloned c = PlatformDefinitions.ClonedFrom.Cloned.Factory.newInstance();
1211         c.setPlatformGuid(id.getGuid());
1212         c.setPlatformVersion(id.getVersion());
1213         c.setId(count.add(new BigInteger("1")));
1214         String guid = wt.getPlatformFarGuid(oldId);
1215         if (guid != null && !guid.equals("")) {
1216             c.setFarGuid(guid);
1217         }
1218
1219         cf.addNewCloned();
1220         cf.setClonedArray(cf.getClonedList().size() - 1, c);
1221         pd.addNewClonedFrom();
1222         pd.setClonedFrom(cf);
1223         fpd.setPlatformDefinitions(pd);
1224     }
1225
1226     /**
1227      Get PlatformIdentification
1228
1229      @return PlatformIdentification
1230
1231      **/
1232     public PlatformIdentification getFid() {
1233         return fid;
1234     }
1235
1236     /**
1237      Set PlatformIdentification
1238
1239      @param fid PlatformIdentification
1240
1241      **/
1242     public void setFid(PlatformIdentification fid) {
1243         this.fid = fid;
1244     }
1245
1246     /**
1247      Get ModuleIdentification
1248
1249      @return ModuleIdentification
1250
1251      **/
1252     public ModuleIdentification getMid() {
1253         return mid;
1254     }
1255
1256     /**
1257      Set ModuleIdentification
1258
1259      @param mid ModuleIdentification
1260
1261      **/
1262     public void setMid(ModuleIdentification mid) {
1263         this.mid = mid;
1264     }
1265
1266     /**
1267      Get PackageIdentification
1268
1269      @return PackageIdentification
1270
1271      **/
1272     public PackageIdentification getPid() {
1273         return pid;
1274     }
1275
1276     /**
1277      Set PackageIdentification
1278
1279      @param pid PackageIdentification
1280
1281      **/
1282     public void setPid(PackageIdentification pid) {
1283         this.pid = pid;
1284     }
1285 }