Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 25a6dfa10e9a6d44766063072732a7e98589f9a1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
/*******************************************************************************
 * Copyright (c) 2008-2010 Sonatype, Inc.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *      Sonatype, Inc. - initial API and implementation
 *******************************************************************************/

package org.eclipse.m2e.editor.pom;

import static org.eclipse.m2e.editor.pom.FormUtils.isEmpty;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IMarker;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.emf.common.command.Command;
import org.eclipse.emf.common.command.CompoundCommand;
import org.eclipse.emf.common.notify.Adapter;
import org.eclipse.emf.common.notify.Notification;
import org.eclipse.emf.common.notify.Notifier;
import org.eclipse.emf.ecore.EAttribute;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.emf.edit.command.RemoveCommand;
import org.eclipse.emf.edit.command.SetCommand;
import org.eclipse.emf.edit.domain.EditingDomain;
import org.eclipse.jface.action.Action;
import org.eclipse.jface.action.IToolBarManager;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.dialogs.IMessageProvider;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.m2e.core.MavenPlugin;
import org.eclipse.m2e.core.actions.OpenPomAction;
import org.eclipse.m2e.core.core.IMavenConstants;
import org.eclipse.m2e.core.core.MavenLogger;
import org.eclipse.m2e.core.project.IMavenProjectFacade;
import org.eclipse.m2e.core.project.MavenProjectManager;
import org.eclipse.m2e.core.ui.dialogs.InputHistory;
import org.eclipse.m2e.editor.MavenEditorImages;
import org.eclipse.m2e.editor.internal.Messages;
import org.eclipse.m2e.model.edit.pom.Model;
import org.eclipse.m2e.model.edit.pom.Parent;
import org.eclipse.m2e.model.edit.pom.PomPackage;
import org.eclipse.swt.custom.CCombo;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.Text;
import org.eclipse.ui.forms.IManagedForm;
import org.eclipse.ui.forms.editor.FormPage;
import org.eclipse.ui.forms.widgets.ScrolledForm;


/**
 * This class provides basic page editor functionality (event listeners, readonly, etc)
 * 
 * @author Anton Kraev
 * @author Eugene Kuleshov
 */
public abstract class MavenPomEditorPage extends FormPage implements Adapter {

  // parent editor
  protected final MavenPomEditor pomEditor;

  // model
  protected Model model;

  // Notifier target
  protected Notifier target;

  // are we already updating model
  protected boolean updatingModel;

  // have we loaded data?
  private boolean dataLoaded;

  private InputHistory inputHistory;
  
  protected static PomPackage POM_PACKAGE = PomPackage.eINSTANCE;

  protected Map<Object, List<ModifyListener>> modifyListeners = new HashMap<Object, List<ModifyListener>>();

  public MavenPomEditorPage(MavenPomEditor pomEditor, String id, String title) {
    super(pomEditor, id, title);
    this.pomEditor = pomEditor;
    this.inputHistory = new InputHistory(id);
  }
  
  public MavenPomEditor getPomEditor() {
    return pomEditor;
  }

  @Override
  protected void createFormContent(IManagedForm managedForm) {
    ScrolledForm form = managedForm.getForm();
    IToolBarManager toolBarManager = form.getToolBarManager();

//    toolBarManager.add(pomEditor.showAdvancedTabsAction);
    
    toolBarManager.add(new Action(Messages.MavenPomEditorPage_action_open, MavenEditorImages.PARENT_POM) {
      public void run() {
        // XXX listen to parent modification and accordingly enable/disable action
        final Parent parent = model.getParent();
        if(parent!=null && !isEmpty(parent.getGroupId()) && !isEmpty(parent.getArtifactId()) && !isEmpty(parent.getVersion())) {
          new Job(Messages.MavenPomEditorPage_job_opening) {
            protected IStatus run(IProgressMonitor monitor) {
              OpenPomAction.openEditor(parent.getGroupId(), parent.getArtifactId(), parent.getVersion(), monitor);
              return Status.OK_STATUS;
            }
          }.schedule();
        }
      }
    });
    
    
    toolBarManager.add(new Action(Messages.MavenPomEditorPage_actio_refresh, MavenEditorImages.REFRESH) {
      public void run() {
        pomEditor.reload();
      }
    });
    
    form.updateToolBar();

    // compatibility proxy to support Eclipse 3.2
    FormUtils.decorateHeader(managedForm.getToolkit(), form.getForm());
    
    inputHistory.load();
  }
  
  public void setActive(boolean active) {
    super.setActive(active);
    doLoadData(active);
    
    boolean readOnly = pomEditor.checkReadOnly();
    FormUtils.setReadonly((Composite) getPartControl(), readOnly);
  }

  public boolean isReadOnly() {
    return pomEditor.isReadOnly();
  }
  
  private void doLoadData(boolean active) {
    if(active && !dataLoaded) {
      dataLoaded = true;
//      new Job("Loading pom.xml") {
//        protected IStatus run(IProgressMonitor monitor) {
          try {
            model = pomEditor.readProjectDocument();
            if(model != null) {
              if (getPartControl() != null) {
                getPartControl().getDisplay().asyncExec(new Runnable() {
                  public void run() {
                    updatingModel = true;
                    try {
                      loadData();
                      registerListeners();
                    } catch(Throwable e) {
                      MavenLogger.log("Error loading data", e); //$NON-NLS-1$
                    } finally {
                      updatingModel = false;
                    }
                  }
                });
              }
            }
            
            IFile pomFile = pomEditor.getPomFile();
            if(pomFile!=null) {
              IMarker[] markers = pomFile.findMarkers(IMavenConstants.MARKER_ID, true, IResource.DEPTH_ZERO);
              if(markers != null && markers.length > 0) {
                int severity = markers[0].getAttribute(IMarker.SEVERITY, IMarker.SEVERITY_INFO) == IMarker.SEVERITY_WARNING ? IMessageProvider.WARNING : IMessageProvider.ERROR;
                setErrorMessage(markers[0].getAttribute(IMarker.MESSAGE, Messages.MavenPomEditorPage_error_unknown), severity);
              } else {
                setErrorMessage(null, IMessageProvider.NONE);
              }
            }
            
          } catch(final CoreException ex) {
            MavenLogger.log(ex);
            final String msg = ex.getMessage();
            setErrorMessage(msg, IMessageProvider.ERROR);
          }

    }
  }

  public void setErrorMessage(final String msg, final int severity) {
    if(getPartControl()!=null && !getPartControl().isDisposed()) {
      getPartControl().getDisplay().asyncExec(new Runnable() {
        public void run() {
          if (!getManagedForm().getForm().isDisposed()) {
            
            FormUtils.setMessage(getManagedForm().getForm(), msg, severity);
          }
        }
      });
    }
  }

  public Notifier getTarget() {
    return target;
  }

  public boolean isAdapterForType(Object type) {
    return false;
  }
  
  public void reload() {
    deRegisterListeners();
    boolean oldDataLoaded = dataLoaded;
    dataLoaded = false;
    doLoadData(oldDataLoaded);
  }

  public synchronized void notifyChanged(Notification notification) {
    if(updatingModel) {
      return;
    }
    
    updatingModel = true;
    try {
      switch(notification.getEventType()) {
        //TODO: fine-grained notification?
        case Notification.ADD:
        case Notification.MOVE:
        case Notification.REMOVE:
        case Notification.SET:
        case Notification.UNSET:
        case Notification.ADD_MANY: //this is for properties (clear/addAll is used for any properties update)
        case Notification.REMOVE_MANY:  
          if (getManagedForm() != null)
            updateView(notification);
          break;
          
        default:
          break;
          
        // case Notification.ADD_MANY:
        // case Notification.REMOVE_MANY:
      }

    } catch(Exception ex) {
      MavenLogger.log("Can't update view", ex); //$NON-NLS-1$
    } finally {
      updatingModel = false;
    }
    
    registerListeners();
  }

  public void dispose() {
    inputHistory.save();
    
    deRegisterListeners();
    
    for(Map.Entry<Object, List<ModifyListener>> e : modifyListeners.entrySet()) {
      Object control = e.getKey();
      for(ModifyListener listener : e.getValue()) {
        if(control instanceof Text) {
          Text textControl = (Text) control;
          if(!textControl.isDisposed()) {
            textControl.removeModifyListener(listener);
          }
        } else if(control instanceof Combo) {
          Combo comboControl = (Combo) control;
          if(!comboControl.isDisposed()) {
            comboControl.removeModifyListener(listener);
          }
        } else if(control instanceof CCombo) {
          CCombo comboControl = (CCombo) control;
          if(!comboControl.isDisposed()) {
            comboControl.removeModifyListener(listener);
          }
        } else if(control instanceof Combo) {
          Button buttonControl = (Button) control;
          if(!buttonControl.isDisposed()) {
            buttonControl.removeSelectionListener((SelectionListener) listener);
          }
        }
      }
    }
    
    super.dispose();
  }

  public void setTarget(Notifier newTarget) {
    this.target = newTarget;
  }

  public Model getModel() {
    return model;
  }

  public EditingDomain getEditingDomain() {
    return pomEditor.getEditingDomain();
  }
  
  public abstract void loadData();

  public abstract void updateView(Notification notification);

  public void registerListeners() {
    if(model!=null) {
      doRegister(model);
      
      for(Iterator<?> it = model.eAllContents(); it.hasNext();) {
        Object next = it.next();
        if (next instanceof EObject)
          doRegister((EObject) next);
      }
    }
  }

  private void doRegister(EObject object) {
    if (!object.eAdapters().contains(this)) {
      object.eAdapters().add(this);
    }
  }

  public void deRegisterListeners() {
    if(model!=null) {
      model.eAdapters().remove(this);
      for(Iterator<?> it = model.eAllContents(); it.hasNext(); ) {
        Object next = it.next();
        if(next instanceof EObject) {
          EObject object = (EObject) next;
          object.eAdapters().remove(this);
        }
      }
    }
  }

  public <T> void setModifyListener(final Text textControl, ValueProvider<T> owner, EStructuralFeature feature,
      String defaultValue) {
    if(textControl!=null && !textControl.isDisposed()) {
      List<ModifyListener> listeners = getModifyListeners(textControl);
      for(ModifyListener listener : listeners) {
        textControl.removeModifyListener(listener);
      }
      listeners.clear();
      ModifyListener listener = setModifyListener(new TextAdapter() {
        public String getText() {
          return textControl.getText();
        }
        public void addModifyListener(ModifyListener listener) {
          textControl.addModifyListener(listener);
        }
      }, owner, feature, defaultValue);
      listeners.add(listener);
    }
  }

  public <T> void setModifyListener(final Combo control, ValueProvider<T> owner, EStructuralFeature feature) {
    if(control!=null && !control.isDisposed()) {
      List<ModifyListener> listeners = getModifyListeners(control);
      for(ModifyListener listener : listeners) {
        control.removeModifyListener(listener);
      }
      listeners.clear();
      ModifyListener listener = setModifyListener(new TextAdapter() {
        public String getText() {
          return control.getText();
        }
        public void addModifyListener(ModifyListener listener) {
          control.addModifyListener(listener);
        }
      }, owner, feature, null);
      listeners.add(listener);
    }
  }

  public <T> void setModifyListener(final CCombo control, ValueProvider<T> owner, EStructuralFeature feature,
      String defaultValue) {
    if(control!=null && !control.isDisposed()) {
      List<ModifyListener> listeners = getModifyListeners(control);
      for(ModifyListener listener : listeners) {
        control.removeModifyListener(listener);
      }
      listeners.clear();
      ModifyListener listener = setModifyListener(new TextAdapter() {
        public String getText() {
          return control.getText();
        }
        public void addModifyListener(ModifyListener listener) {
          control.addModifyListener(listener);
        }
      }, owner, feature, defaultValue);
      listeners.add(listener);
    }
  }
  
  private <T> ModifyListener setModifyListener(final TextAdapter adapter, final ValueProvider<T> provider,
      final EStructuralFeature feature, final String defaultValue) {
    ModifyListener listener = new ModifyListener() {
      public void modifyText(ModifyEvent e) {
        T owner = provider.getValue();
        CompoundCommand compoundCommand = new CompoundCommand();
        if(owner==null && !provider.isEmpty()) {
          owner = provider.create(getEditingDomain(), compoundCommand);
        }
        
        Command command;
        if(adapter.getText().equals(defaultValue) || isEmpty(adapter.getText())) {
          command = SetCommand.create(getEditingDomain(), owner, feature, SetCommand.UNSET_VALUE);
        } else {
          command = SetCommand.create(getEditingDomain(), owner, feature, adapter.getText());
        }
        compoundCommand.append(command);
        //MNGECLIPSE-1854
        //the semantics of isEmpty() is probably not entirely correct for this context
        // as it only takes the fields shown in ui into account, but there could be others, not
        // managed by this valueprovider
        if (provider.isEmpty() && owner != null) {
            //in a way this stuff shall be recursive and remove everything that is empty all the way up..
           command = RemoveCommand.create(getEditingDomain(), owner);
           compoundCommand.append(command);
        }        
        getEditingDomain().getCommandStack().execute(compoundCommand);
        registerListeners();
      }
    };
    adapter.addModifyListener(listener);
    return listener;
  }
  
  public <T> void setModifyListener(final Button control, final ValueProvider<T> provider,
      final EStructuralFeature feature, final String defaultValue) {
    if(control!=null && !control.isDisposed()) {
      List<ModifyListener> listeners = getModifyListeners(control);
      for(ModifyListener listener : listeners) {
        control.removeSelectionListener((SelectionListener) listener);
      }
  
      listeners.clear();

      class ButtonModifyListener extends SelectionAdapter implements ModifyListener {
        public void widgetSelected(SelectionEvent e) {
          T owner = provider.getValue();
          if(owner == null && !provider.isEmpty()) {
            CompoundCommand compoundCommand = new CompoundCommand();
            provider.create(getEditingDomain(), compoundCommand);
            getEditingDomain().getCommandStack().execute(compoundCommand);
            owner = provider.getValue();
          }
  
          String value = control.getSelection() ? "true" : "false";
          Command command = SetCommand.create(getEditingDomain(), owner, feature, //
              defaultValue.equals(value) ? null : value);
          getEditingDomain().getCommandStack().execute(command);
          registerListeners();
        }
  
        public void modifyText(ModifyEvent e) {
          widgetSelected(null);
        }
      };
  
      ButtonModifyListener listener = new ButtonModifyListener();
      control.addSelectionListener(listener);
  
      listeners.add(listener);
    }
  }

  public void removeNotifyListener(Text control) {
    List<ModifyListener> listeners = getModifyListeners(control);
    for(ModifyListener listener : listeners) {
      if(!control.isDisposed()) {
        control.removeModifyListener(listener);
      }
    }
    listeners.clear();
  }

  public void removeNotifyListener(CCombo control) {
    List<ModifyListener> listeners = getModifyListeners(control);
    for(ModifyListener listener : listeners) {
      if(!control.isDisposed()) {
        control.removeModifyListener(listener);
      }
    }
    listeners.clear();
  }

  public void removeNotifyListener(Combo control) {
    List<ModifyListener> listeners = getModifyListeners(control);
    for(ModifyListener listener : listeners) {
      if(!control.isDisposed()) {
        control.removeModifyListener(listener);
      }
    }
    listeners.clear();
  }

  public void removeNotifyListener(Button button) {
    List<ModifyListener> listeners = getModifyListeners(button);
    for(ModifyListener listener : listeners) {
      if(!button.isDisposed()) {
        button.removeSelectionListener((SelectionAdapter) listener);
      }
    }
    listeners.clear();
  }

  private List<ModifyListener> getModifyListeners(Object control) {
    List<ModifyListener> listeners = modifyListeners.get(control);
    if (listeners == null) {
      listeners = new ArrayList<ModifyListener>();
      modifyListeners.put(control, listeners);
    }
    return listeners;
  }
  
  public IMavenProjectFacade findModuleProject(String moduleName) {
    IFile pomFile = pomEditor.getPomFile();
    if(pomFile != null) {
      return findModuleProject(pomFile, moduleName);
    }
    return null;
  }

  private IMavenProjectFacade findModuleProject(IFile pomFile, String module) {
    IPath modulePath = pomFile.getParent().getLocation();
    if (modulePath == null) return null;
    modulePath = modulePath.append(module);
    //it's possible to have the pom file name in the module path..
    if (!modulePath.lastSegment().endsWith("pom.xml")) { //$NON-NLS-1$
      modulePath = modulePath.append("pom.xml"); //$NON-NLS-1$
    }
    MavenProjectManager projectManager = MavenPlugin.getDefault().getMavenProjectManager();
    IMavenProjectFacade[] facades = projectManager.getProjects();
    for(int i = 0; i < facades.length; i++ ) {
      if(facades[i].getPom().getLocation().equals(modulePath)) {
        return facades[i];
      }
    }
    return null;
  }
  
  public IFile findModuleFile(String moduleName) {
    IFile pomFile = pomEditor.getPomFile();
    if(pomFile!=null) {
      IPath modulePath = pomFile.getParent().getLocation();
      if (modulePath == null) return null;
      modulePath = modulePath.append(moduleName);
      //it's possible to have the pom file name in the module path..
      if (!modulePath.lastSegment().endsWith("pom.xml")) { //$NON-NLS-1$
        modulePath = modulePath.append("pom.xml"); //$NON-NLS-1$
      }
      IFile file = ResourcesPlugin.getWorkspace().getRoot().getFileForLocation(modulePath);
      return file;
    }
    return null;
  }
  
  public void initPopupMenu(Viewer viewer, String id) {
    MenuManager menuMgr = new MenuManager("#PopupMenu-" + id); //$NON-NLS-1$
    menuMgr.setRemoveAllWhenShown(true);
    
    Menu menu = menuMgr.createContextMenu(viewer.getControl());
  
    viewer.getControl().setMenu(menu);
    
    getEditorSite().registerContextMenu(MavenPomEditor.EDITOR_ID + id, menuMgr, viewer, false);
  }

  /*
   * returns added/removed/updated EObject from notification (convenience method for detail forms)
   */
  public static Object getFromNotification(Notification notification) {
    if(notification.getFeature() != null && !(notification.getFeature() instanceof EAttribute)) {
      // for structuralFeatures, return new value (for insert/delete)
      return notification.getNewValue();
    } else {
      // for attributes, return the notifier as it contains all new attributes (attribute modified)
      return notification.getNotifier();
    }
  }

  /**
   * Adapter for Text, Combo and CCombo widgets 
   */
  public interface TextAdapter {
    String getText();
    void addModifyListener(ModifyListener listener);
  }

  public IProject getProject() {
    IFile pomFile = pomEditor.getPomFile();
    return pomFile != null? pomFile.getProject(): null;
  }

  protected void addToHistory(Control control) {
    inputHistory.add(control);
  }
}

Back to the top