4643bb1e711d9e502b13437bbb47b2194453ec4f
[mirror_edk2.git] / 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() {
573 //
574 // Check Basename
575 //
576 if (isEmpty(this.jTextFieldBaseName.getText())) {
577 Log.wrn("Clone", "The Name is required!");
578 return false;
579 }
580 if (!DataValidation.isBaseName(this.jTextFieldBaseName.getText())) {
581 Log
582 .wrn("Clone",
583 "<html>Incorrect data type for the Name, it must<br>be a single word, starting with an alpha character.</html>");
584 return false;
585 }
586
587 //
588 // Check Guid
589 //
590 if (isEmpty(this.jTextFieldGuid.getText())) {
591 Log.wrn("Clone", "A Guid is required!!");
592 return false;
593 }
594 if (!DataValidation.isGuid(this.jTextFieldGuid.getText())) {
595 Log
596 .wrn(
597 "Clone",
598 "<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>");
599 return false;
600 }
601
602 //
603 // Check Version
604 //
605 if (isEmpty(this.jTextFieldVersion.getText())) {
606 Log.wrn("Clone", "A Version must be entered!");
607 return false;
608 }
609 if (!DataValidation.isVersion(this.jTextFieldVersion.getText())) {
610 Log
611 .wrn(
612 "Clone",
613 "<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>");
614 return false;
615 }
616
617 //
618 // Save information to id
619 //
620 newId.setName(this.jTextFieldBaseName.getText());
621 newId.setGuid(this.jTextFieldGuid.getText());
622 newId.setVersion(this.jTextFieldVersion.getText());
623 newId.setPath(this.jTextFieldFilePath.getText());
624
625 return true;
626 }
627
628 /**
629 Check before save
630
631 @retval true All check points are passed
632 @retval false Any one of check points is failed
633
634 **/
635 private boolean check() {
636 String src = this.oldId.getPath();
637 String trg = this.jTextFieldFilePath.getText();
638 File srcFile = new File(src);
639 File trgFile = new File(trg);
640
641 //
642 // Common Check
643 //
644 if (!srcFile.exists()) {
645 Log.wrn("Clone", "The source file does not exist!");
646 return false;
647 }
648 if (isEmpty(trg)) {
649 Log.wrn("Clone", "The destination file path must be entered!");
650 return false;
651 }
652 if (src.equals(trg)) {
653 Log.wrn("Clone", "The source and destination can not be same!");
654 return false;
655 }
656 if (trgFile.exists()) {
657 Log.wrn("Clone", "The destination already exists!");
658 return false;
659 }
660
661 //
662 // Check for workspace
663 //
664 if (mode == DataType.RETURN_TYPE_WORKSPACE) {
665 if (trg.indexOf(src + DataType.FILE_SEPARATOR) == 0) {
666 Log.wrn("Clone", "The new workspace can not be located within the current workspace!");
667 return false;
668 }
669 }
670
671 //
672 // Check for Module
673 //
674 if (mode == DataType.RETURN_TYPE_MODULE_SURFACE_AREA) {
675 trg = this.getModulePath();
676 if (src.equals(trg)) {
677 Log.wrn("Clone", "The source and destination paths for cloning a module must be different!");
678 return false;
679 }
680 trgFile = new File(trg);
681 if (trgFile.exists()) {
682 Log.wrn("Clone", "The target module already exists!");
683 return false;
684 }
685 return checkId();
686 }
687
688 //
689 // Check for Package
690 //
691 if (mode == DataType.RETURN_TYPE_PACKAGE_SURFACE_AREA) {
692 if (trg.indexOf(DataType.DOS_FILE_SEPARATOR) == -1 && trg.indexOf(DataType.UNIX_FILE_SEPARATOR) == -1) {
693 Log.wrn("Clone", "The package name must include a path!");
694 return false;
695 }
696 trg = this.getPackagePath();
697 if (Tools.getFilePathOnly(src).equals(Tools.getFilePathOnly(trg))) {
698 Log.wrn("Clone", "The source and destination paths for cloning a package must be different!");
699 return false;
700 }
701 trgFile = new File(trg);
702 if (trgFile.exists()) {
703 Log.wrn("Clone", "The target package already exists!");
704 return false;
705 }
706 return checkId();
707 }
708
709 //
710 // Check for Platform
711 //
712 if (mode == DataType.RETURN_TYPE_PLATFORM_SURFACE_AREA) {
713 if (trg.indexOf(Workspace.getCurrentWorkspace()) != 0) {
714 Log.wrn("Clone", "The platform clone must be located in the current workspace!");
715 return false;
716 }
717 trgFile = new File(trg);
718 if (trgFile.exists()) {
719 Log.wrn("Clone", "The target platform already exists.");
720 return false;
721 }
722 return checkId();
723 }
724
725 return true;
726 }
727
728 /**
729 Save clone target to new location
730
731 @throws IOException
732 @throws XmlException
733 @throws Exception
734
735 **/
736 private void save() throws IOException, XmlException, Exception {
737 String src = this.oldId.getPath();
738 String trg = this.jTextFieldFilePath.getText();
739 Vector<String> vFiles = new Vector<String>();
740
741 //
742 // Clone Workspace
743 //
744 if (mode == DataType.RETURN_TYPE_WORKSPACE) {
745 FileOperation.copyFolder(src, trg);
746 this.returnType = DataType.RETURN_TYPE_WORKSPACE;
747 }
748
749 //
750 // Clone Module Surface Area
751 //
752 if (mode == DataType.RETURN_TYPE_MODULE_SURFACE_AREA) {
753 //
754 // Get target path from source path
755 //
756 trg = getModulePath();
757 newId.setPath(trg);
758 vFiles = wt.getAllFilesPathOfModule(src);
759
760 String oldPackagePath = GlobalData.openingModuleList.getIdByPath(src).getPackageId().getPath();
761 String newPackagePath = packages.elementAt(this.jComboBoxExistingPackage.getSelectedIndex()).getPath();
762
763 //
764 // First copy all files to new directory
765 //
766 FileOperation.copyFile(src, trg);
767 for (int index = 1; index < vFiles.size(); index++) {
768 String oldFile = vFiles.get(index);
769 String newFile = "";
770 if (oldFile.indexOf(Tools.getFilePathOnly(src)) > -1) {
771 //
772 // The file is not include header
773 //
774 newFile = oldFile.replace(Tools.getFilePathOnly(src), Tools.getFilePathOnly(trg));
775 } else if (oldFile.indexOf(Tools.getFilePathOnly(oldPackagePath)) > -1) {
776 //
777 // The file is include header
778 //
779 newFile = oldFile.replace(Tools.getFilePathOnly(oldPackagePath),
780 Tools.getFilePathOnly(newPackagePath));
781 }
782
783 FileOperation.copyFile(oldFile, newFile);
784 }
785
786 //
787 // Create new msa file
788 //
789 ModuleSurfaceArea msa = null;
790 msa = OpenFile.openMsaFile(src);
791
792 //
793 // Update to memory
794 //
795 msa.getMsaHeader().setModuleName(newId.getName());
796 msa.getMsaHeader().setGuidValue(newId.getGuid());
797 msa.getMsaHeader().setVersion(newId.getVersion());
798
799 //
800 // Update <Cloned> Section
801 //
802 updateModuleClonedId(msa, oldId);
803
804 //
805 // Save to file
806 //
807 SaveFile.saveMsaFile(trg, msa);
808
809 //
810 // Update to platformId
811 //
812 this.setMid(new ModuleIdentification(newId,
813 packages.elementAt(this.jComboBoxExistingPackage.getSelectedIndex())));
814
815 //
816 // Open belonging package
817 //
818 PackageSurfaceArea psa = PackageSurfaceArea.Factory.newInstance();
819 psa = OpenFile.openSpdFile(mid.getPackageId().getPath());
820
821 //
822 // Update the db file
823 //
824 wt.addModuleToPackage(mid, psa);
825
826 //
827 // Update GlobalData
828 //
829 GlobalData.vModuleList.addElement(mid);
830 GlobalData.openingModuleList.insertToOpeningModuleList(mid, msa);
831
832 this.returnType = DataType.RETURN_TYPE_MODULE_SURFACE_AREA;
833 }
834
835 //
836 // Clone Package Surface Area
837 //
838 if (mode == DataType.RETURN_TYPE_PACKAGE_SURFACE_AREA) {
839 //
840 // Get target path from source path
841 //
842 trg = this.getPackagePath();
843 newId.setPath(trg);
844 vFiles = wt.getAllFilesPathOfPakcage(src);
845
846 //
847 // First copy all files to new directory
848 //
849 FileOperation.copyFile(src, trg);
850 for (int index = 1; index < vFiles.size(); index++) {
851 String oldFile = vFiles.get(index);
852 String newFile = vFiles.get(index).replace(Tools.getFilePathOnly(src), Tools.getFilePathOnly(trg));
853 FileOperation.copyFile(oldFile, newFile);
854 }
855
856 //
857 // Create new spd file
858 //
859 PackageSurfaceArea spd = null;
860 spd = OpenFile.openSpdFile(src);
861
862 //
863 // Update to memory
864 //
865 spd.getSpdHeader().setPackageName(newId.getName());
866 spd.getSpdHeader().setGuidValue(newId.getGuid());
867 spd.getSpdHeader().setVersion(newId.getVersion());
868
869 //
870 // Update <Cloned> Section
871 //
872 updatePackageClonedId(spd, oldId);
873
874 //
875 // Save to file
876 //
877 SaveFile.saveSpdFile(trg, spd);
878
879 //
880 // Update to platformId
881 //
882 this.setPid(new PackageIdentification(newId));
883
884 //
885 // Update the db file
886 //
887 wt.addPackageToDatabase(pid);
888
889 //
890 // Update GlobalData
891 //
892 GlobalData.vPackageList.addElement(pid);
893 GlobalData.openingPackageList.insertToOpeningPackageList(pid, spd);
894
895 //
896 // Add all cloned modules
897 //
898 Vector<String> modulePaths = GlobalData.getAllModulesOfPackage(pid.getPath());
899 String modulePath = null;
900 ModuleSurfaceArea msa = null;
901
902 for (int indexJ = 0; indexJ < modulePaths.size(); indexJ++) {
903 try {
904 modulePath = modulePaths.get(indexJ);
905 msa = OpenFile.openMsaFile(modulePath);
906 } catch (IOException e) {
907 Log.err("Open Module Surface Area " + modulePath, e.getMessage());
908 continue;
909 } catch (XmlException e) {
910 Log.err("Open Module Surface Area " + modulePath, e.getMessage());
911 continue;
912 } catch (Exception e) {
913 Log.err("Open Module Surface Area " + modulePath, "Invalid file type");
914 continue;
915 }
916 Identification id = Tools.getId(modulePath, msa);
917 mid = new ModuleIdentification(id, pid);
918 GlobalData.vModuleList.addElement(mid);
919 GlobalData.openingModuleList.insertToOpeningModuleList(mid, msa);
920 }
921
922 this.returnType = DataType.RETURN_TYPE_PACKAGE_SURFACE_AREA;
923 }
924
925 //
926 // Clone Platform Surface Area
927 //
928 if (mode == DataType.RETURN_TYPE_PLATFORM_SURFACE_AREA) {
929 PlatformSurfaceArea fpd = null;
930 fpd = OpenFile.openFpdFile(src);
931
932 //
933 // Update to memory
934 //
935 fpd.getPlatformHeader().setPlatformName(newId.getName());
936 fpd.getPlatformHeader().setGuidValue(newId.getGuid());
937 fpd.getPlatformHeader().setVersion(newId.getVersion());
938
939 //
940 // Update Cloned From element
941 //
942 updatePlatformClonedId(fpd, oldId);
943
944 //
945 // Save to file
946 //
947 SaveFile.saveFpdFile(trg, fpd);
948
949 //
950 // Update to platformId
951 //
952 this.setFid(new PlatformIdentification(newId));
953
954 //
955 // Update the db file
956 //
957 wt.addPlatformToDatabase(fid);
958
959 //
960 // Update GlobalData
961 //
962 GlobalData.vPlatformList.addElement(fid);
963 GlobalData.openingPlatformList.insertToOpeningPlatformList(fid, fpd);
964
965 this.returnType = DataType.RETURN_TYPE_PLATFORM_SURFACE_AREA;
966 }
967 vFiles = null;
968 }
969
970 /**
971 Get the path of selected package
972
973 @return String The path of selected package
974
975 **/
976 private String getSelectPackagePath() {
977 return Tools.getFilePathOnly(packages.elementAt(this.jComboBoxExistingPackage.getSelectedIndex()).getPath());
978 }
979
980 /**
981 Get the path of source module
982 Since the path of source module is relative, make it up to full path.
983
984 @return String The full path of source module
985
986 **/
987 private String getModulePath() {
988 String trg = this.jTextFieldFilePath.getText();
989 trg = Tools.addPathExt(trg, mode);
990 trg = Tools.addFileSeparator(getSelectPackagePath()) + trg;
991 Tools.convertPathToCurrentOsType(trg);
992 return trg;
993 }
994
995 /**
996 Get the path of source package
997 Since the path of source package is relative, make it up to full path.
998
999 @return String The full path of source package
1000
1001 **/
1002 private String getPackagePath() {
1003 String trg = this.jTextFieldFilePath.getText();
1004 trg = Tools.addPathExt(trg, mode);
1005 trg = Tools.addFileSeparator(Workspace.getCurrentWorkspace()) + trg;
1006 trg = Tools.convertPathToCurrentOsType(trg);
1007 return trg;
1008 }
1009
1010 /**
1011 Set msa file's <Cloned> section via given identification
1012
1013 @param msa ModuleSurfaceArea for clone target
1014 @param id Identification of clone source
1015
1016 **/
1017 private void updateModuleClonedId(ModuleSurfaceArea msa, Identification id) {
1018 //
1019 // Get PlatformDefinitions First
1020 //
1021 ModuleDefinitions pd = null;
1022 if (msa.getModuleDefinitions() == null) {
1023 pd = ModuleDefinitions.Factory.newInstance();
1024 msa.addNewModuleDefinitions();
1025 } else {
1026 pd = msa.getModuleDefinitions();
1027 }
1028
1029 //
1030 // Get ClonedFrom then
1031 //
1032 ModuleDefinitions.ClonedFrom cf = null;
1033 BigInteger count = new BigInteger("-1");
1034 if (pd.getClonedFrom() == null) {
1035 cf = ModuleDefinitions.ClonedFrom.Factory.newInstance();
1036 } else {
1037 cf = pd.getClonedFrom();
1038 if (cf != null) {
1039 for (int index = 0; index < cf.getClonedList().size(); index++) {
1040 if (cf.getClonedList().get(index).getId() != null) {
1041 count = count.max(cf.getClonedList().get(index).getId());
1042 }
1043 }
1044 }
1045 }
1046
1047 //
1048 // Set new Cloned item
1049 //
1050 ModuleDefinitions.ClonedFrom.Cloned c = ModuleDefinitions.ClonedFrom.Cloned.Factory.newInstance();
1051 c.setModuleGuid(id.getGuid());
1052 c.setModuleVersion(id.getVersion());
1053 c.setPackageGuid(wt.getPackageIdByModuleId(oldId).getGuid());
1054 c.setPackageVersion(wt.getPackageIdByModuleId(oldId).getVersion());
1055 c.setId(count.add(new BigInteger("1")));
1056 String guid = wt.getModuleFarGuid(oldId);
1057 if (guid != null && !guid.equals("")) {
1058 c.setFarGuid(guid);
1059 }
1060
1061 cf.addNewCloned();
1062 cf.setClonedArray(cf.getClonedList().size() - 1, c);
1063 pd.addNewClonedFrom();
1064 pd.setClonedFrom(cf);
1065 msa.setModuleDefinitions(pd);
1066 }
1067
1068 /**
1069 Set spd file's <Cloned> section via given identification
1070
1071 @param spd PackageSurfaceArea for clone target
1072 @param id Identification of clone source
1073
1074 **/
1075 private void updatePackageClonedId(PackageSurfaceArea spd, Identification id) {
1076 //
1077 // Get PlatformDefinitions First
1078 //
1079 PackageDefinitions pd = null;
1080 if (spd.getPackageDefinitions() == null) {
1081 pd = PackageDefinitions.Factory.newInstance();
1082 spd.addNewPackageDefinitions();
1083 } else {
1084 pd = spd.getPackageDefinitions();
1085 }
1086
1087 //
1088 // Get ClonedFrom then
1089 //
1090 PackageDefinitions.ClonedFrom cf = null;
1091 BigInteger count = new BigInteger("-1");
1092 if (pd.getClonedFrom() == null) {
1093 cf = PackageDefinitions.ClonedFrom.Factory.newInstance();
1094 } else {
1095 cf = pd.getClonedFrom();
1096 if (cf != null) {
1097 for (int index = 0; index < cf.getClonedList().size(); index++) {
1098 if (cf.getClonedList().get(index).getId() != null) {
1099 count = count.max(cf.getClonedList().get(index).getId());
1100 }
1101 }
1102 }
1103 }
1104
1105 //
1106 // Set new Cloned item
1107 //
1108 PackageDefinitions.ClonedFrom.Cloned c = PackageDefinitions.ClonedFrom.Cloned.Factory.newInstance();
1109 c.setPackageGuid(id.getGuid());
1110 c.setPackageVersion(id.getVersion());
1111 c.setId(count.add(new BigInteger("1")));
1112 String guid = wt.getPackageFarGuid(oldId);
1113 if (guid != null && !guid.equals("")) {
1114 c.setFarGuid(guid);
1115 }
1116
1117 cf.addNewCloned();
1118 cf.setClonedArray(cf.getClonedList().size() - 1, c);
1119 pd.addNewClonedFrom();
1120 pd.setClonedFrom(cf);
1121 spd.setPackageDefinitions(pd);
1122 }
1123
1124 /**
1125 Set fpd file's <Cloned> section via given identification
1126
1127 @param fpd PlatformSurfaceArea for clone target
1128 @param id Identification of clone source
1129
1130 **/
1131 private void updatePlatformClonedId(PlatformSurfaceArea fpd, Identification id) {
1132 //
1133 // Get PlatformDefinitions First
1134 //
1135 PlatformDefinitions pd = null;
1136 if (fpd.getPlatformDefinitions() == null) {
1137 pd = PlatformDefinitions.Factory.newInstance();
1138 fpd.addNewPlatformDefinitions();
1139 } else {
1140 pd = fpd.getPlatformDefinitions();
1141 }
1142
1143 //
1144 // Get ClonedFrom then
1145 //
1146 PlatformDefinitions.ClonedFrom cf = null;
1147 BigInteger count = new BigInteger("-1");
1148 if (pd.getClonedFrom() == null) {
1149 cf = PlatformDefinitions.ClonedFrom.Factory.newInstance();
1150 } else {
1151 cf = pd.getClonedFrom();
1152 if (cf != null) {
1153 for (int index = 0; index < cf.getClonedList().size(); index++) {
1154 if (cf.getClonedList().get(index).getId() != null) {
1155 count = count.max(cf.getClonedList().get(index).getId());
1156 }
1157 }
1158 }
1159 }
1160
1161 //
1162 // Set new Cloned item
1163 //
1164 PlatformDefinitions.ClonedFrom.Cloned c = PlatformDefinitions.ClonedFrom.Cloned.Factory.newInstance();
1165 c.setPlatformGuid(id.getGuid());
1166 c.setPlatformVersion(id.getVersion());
1167 c.setId(count.add(new BigInteger("1")));
1168 String guid = wt.getPlatformFarGuid(oldId);
1169 if (guid != null && !guid.equals("")) {
1170 c.setFarGuid(guid);
1171 }
1172
1173 cf.addNewCloned();
1174 cf.setClonedArray(cf.getClonedList().size() - 1, c);
1175 pd.addNewClonedFrom();
1176 pd.setClonedFrom(cf);
1177 fpd.setPlatformDefinitions(pd);
1178 }
1179
1180 /**
1181 Get PlatformIdentification
1182
1183 @return PlatformIdentification
1184
1185 **/
1186 public PlatformIdentification getFid() {
1187 return fid;
1188 }
1189
1190 /**
1191 Set PlatformIdentification
1192
1193 @param fid PlatformIdentification
1194
1195 **/
1196 public void setFid(PlatformIdentification fid) {
1197 this.fid = fid;
1198 }
1199
1200 /**
1201 Get ModuleIdentification
1202
1203 @return ModuleIdentification
1204
1205 **/
1206 public ModuleIdentification getMid() {
1207 return mid;
1208 }
1209
1210 /**
1211 Set ModuleIdentification
1212
1213 @param mid ModuleIdentification
1214
1215 **/
1216 public void setMid(ModuleIdentification mid) {
1217 this.mid = mid;
1218 }
1219
1220 /**
1221 Get PackageIdentification
1222
1223 @return PackageIdentification
1224
1225 **/
1226 public PackageIdentification getPid() {
1227 return pid;
1228 }
1229
1230 /**
1231 Set PackageIdentification
1232
1233 @param pid PackageIdentification
1234
1235 **/
1236 public void setPid(PackageIdentification pid) {
1237 this.pid = pid;
1238 }
1239 }