Skip to main content
summaryrefslogtreecommitdiffstats
blob: 425f669c7b4d0495c551d150c655c0109be9948a (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
/*******************************************************************************
 * Copyright (c) 2008 Martin Lippert and others.
 * 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:
 *   Matthew Webster           initial implementation
 *   Martin Lippert            supplementing mechanism reworked     
 *   Heiko Seeberger           Enhancements for service dynamics     
 *******************************************************************************/

package org.eclipse.equinox.service.weaving;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Dictionary;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.eclipse.equinox.weaving.hooks.AbstractAspectJHook;
import org.eclipse.equinox.weaving.hooks.Supplementer;
import org.eclipse.osgi.util.ManifestElement;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.BundleException;
import org.osgi.framework.Constants;
import org.osgi.service.packageadmin.PackageAdmin;

public class SupplementerRegistry {

    //knibb
    /**
     * Manifest header (named "Supplement-Bundle") identifying the
     * names (and optionally, version numbers) of any bundles supplemented by
     * this bundle. All supplemented bundles will have all the exported packages
     * of this bundle added to their imports list
     * 
     * <p>
     * The attribute value may be retrieved from the <code>Dictionary</code>
     * object returned by the <code>Bundle.getHeaders</code> method.
     */
    public static final String SUPPLEMENT_BUNDLE = "Eclipse-SupplementBundle"; //$NON-NLS-1$

    /**
     * Manifest header (named &quot;Supplement-Exporter&quot;) identifying the
     * names (and optionally, version numbers) of the packages that the bundle
     * supplements. All exporters of one of these packages will have the
     * exported packages of this bundle added to their imports list.
     * 
     * <p>
     * The attribute value may be retrieved from the <code>Dictionary</code>
     * object returned by the <code>Bundle.getHeaders</code> method.
     */
    public static final String SUPPLEMENT_EXPORTER = "Eclipse-SupplementExporter"; //$NON-NLS-1$

    /**
     * Manifest header (named &quot;Supplement-Importer&quot;) identifying the
     * names (and optionally, version numbers) of the packages that the bundle
     * supplements. All importers of one of these packages will have the
     * exported packages of this bundle added to their imports in addition.
     * 
     * <p>
     * The attribute value may be retrieved from the <code>Dictionary</code>
     * object returned by the <code>Bundle.getHeaders</code> method.
     */
    public static final String SUPPLEMENT_IMPORTER = "Eclipse-SupplementImporter"; //$NON-NLS-1$

    private BundleContext context;

    private final Set dontWeaveTheseBundles; // elements of type String (symbolic name of bundle)

    private PackageAdmin packageAdmin;

    private final Map supplementers; // keys of type String (symbolic name of supplementer bundle), values of type Supplementer

    public SupplementerRegistry() {
        this.supplementers = new HashMap();
        this.dontWeaveTheseBundles = new HashSet();

        this.dontWeaveTheseBundles.add("org.eclipse.osgi");
        this.dontWeaveTheseBundles.add("org.eclipse.update.configurator");
        this.dontWeaveTheseBundles.add("org.eclipse.core.runtime");
        this.dontWeaveTheseBundles.add("org.eclipse.equinox.common");
        this.dontWeaveTheseBundles.add("org.eclipse.equinox.weaving.hook");
        this.dontWeaveTheseBundles.add("org.eclipse.equinox.weaving.aspectj");
        this.dontWeaveTheseBundles.add("org.eclipse.equinox.weaving.caching");
        this.dontWeaveTheseBundles
                .add("org.eclipse.equinox.weaving.caching.j9");
        this.dontWeaveTheseBundles.add("org.aspectj.runtime");
        this.dontWeaveTheseBundles.add("org.aspectj.weaver");
        this.dontWeaveTheseBundles
                .add("org.eclipse.equinox.simpleconfigurator");
    }

    public void addSupplementedBundle(final Bundle supplementedBundle,
            final List supplementers) {
        for (final Iterator iterator = supplementers.iterator(); iterator
                .hasNext();) {
            final String supplementersName = (String) iterator.next();
            if (this.supplementers.containsKey(supplementersName)) {
                final Supplementer supplementer = (Supplementer) this.supplementers
                        .get(supplementersName);
                supplementer.addSupplementedBundle(supplementedBundle);
            }
        }
    }

    public void addSupplementer(final Bundle bundle) {
        final Dictionary manifest = bundle.getHeaders();
        try {
            // First analyze which supplementers already exists for this bundle
            final ManifestElement[] imports = ManifestElement.parseHeader(
                    Constants.IMPORT_PACKAGE, (String) manifest
                            .get(Constants.IMPORT_PACKAGE));
            final ManifestElement[] exports = ManifestElement.parseHeader(
                    Constants.EXPORT_PACKAGE, (String) manifest
                            .get(Constants.EXPORT_PACKAGE));
            final List supplementers = getSupplementers(bundle
                    .getSymbolicName(), imports, exports);
            if (supplementers.size() > 0) {
                this.addSupplementedBundle(bundle, supplementers);
            }

            // Second analyze if this bundle itself is a supplementer
            final ManifestElement[] supplementBundle = ManifestElement
                    .parseHeader(SUPPLEMENT_BUNDLE, (String) manifest
                            .get(SUPPLEMENT_BUNDLE));
            final ManifestElement[] supplementImporter = ManifestElement
                    .parseHeader(SUPPLEMENT_IMPORTER, (String) manifest
                            .get(SUPPLEMENT_IMPORTER));
            final ManifestElement[] supplementExporter = ManifestElement
                    .parseHeader(SUPPLEMENT_EXPORTER, (String) manifest
                            .get(SUPPLEMENT_EXPORTER));

            if (supplementBundle != null || supplementImporter != null
                    || supplementExporter != null) {
                final Supplementer newSupplementer = new Supplementer(bundle,
                        supplementBundle, supplementImporter,
                        supplementExporter);

                this.supplementers.put(bundle.getSymbolicName(),
                        newSupplementer);
                resupplementInstalledBundles(newSupplementer);
            }
        } catch (final BundleException e) {
        }
    }

    public Set getSupplementedBundles() {
        final Set supplementedBundles = new HashSet();
        final Iterator supplementersIterator = supplementers.values()
                .iterator();
        while (supplementersIterator.hasNext()) {
            final Supplementer supplementer = (Supplementer) supplementersIterator
                    .next();
            supplementedBundles.addAll(Arrays.asList(supplementer
                    .getSupplementedBundles()));
        }
        return supplementedBundles;
    }

    public Bundle[] getSupplementers(final Bundle bundle) {
        List result = Collections.EMPTY_LIST;

        if (supplementers.size() > 0) {
            result = new ArrayList();
            for (final Iterator i = supplementers.values().iterator(); i
                    .hasNext();) {
                final Supplementer supplementer = (Supplementer) i.next();
                if (supplementer.isSupplemented(bundle)) {
                    result.add(supplementer.getSupplementerBundle());
                }
            }
        }

        return (Bundle[]) result.toArray(new Bundle[result.size()]);
    }

    public List getSupplementers(final String symbolicName,
            final ManifestElement[] imports, final ManifestElement[] exports) {
        List result = Collections.EMPTY_LIST;

        if (supplementers.size() > 0
                && !this.dontWeaveTheseBundles.contains(symbolicName)) {
            result = new LinkedList();
            for (final Iterator i = supplementers.values().iterator(); i
                    .hasNext();) {
                final Supplementer supplementer = (Supplementer) i.next();
                if (isSupplementerMatching(symbolicName, imports, exports,
                        supplementer)) {
                    result.add(supplementer.getSymbolicName());
                }
            }
        }

        return result;
    }

    public void removeSupplementedBundle(final Bundle bundle) {
        for (final Iterator iterator = this.supplementers.values().iterator(); iterator
                .hasNext();) {
            final Supplementer supplementer = (Supplementer) iterator.next();
            supplementer.removeSupplementedBundle(bundle);
        }
    }

    public void removeSupplementer(final Bundle bundle) {
        // if this bundle is itself supplemented by others, remove the bundle from those lists
        removeSupplementedBundle(bundle);

        // if this bundle supplements other bundles, remove this supplementer and update the other bundles
        if (supplementers.containsKey(bundle.getSymbolicName())) {
            final Supplementer supplementer = (Supplementer) supplementers
                    .get(bundle.getSymbolicName());
            supplementers.remove(bundle.getSymbolicName());
            if (AbstractAspectJHook.verbose)
                System.err
                        .println("[org.aspectj.osgi] info removing supplementer "
                                + bundle.getSymbolicName());

            final Bundle[] supplementedBundles = supplementer
                    .getSupplementedBundles();
            for (int i = 0; i < supplementedBundles.length; i++) {
                final Bundle supplementedBundle = supplementedBundles[i];
                if (supplementedBundle != null) {
                    updateInstalledBundle(supplementedBundle);
                }
            }
        }
    }

    public void setBundleContext(final BundleContext context) {
        this.context = context;
    }

    public void setPackageAdmin(final PackageAdmin packageAdmin) {
        this.packageAdmin = packageAdmin;
    }

    public void updateInstalledBundle(final Bundle bundle) {
        if (AbstractAspectJHook.verbose)
            System.err
                    .println("[org.aspectj.osgi] info triggering update for re-supplementing "
                            + bundle.getSymbolicName());

        try {
            final int initialstate = (bundle.getState() | (Bundle.ACTIVE | Bundle.STARTING));
            // TODO Why stop? Shouldn't start again?
            if (initialstate != 0
                    && packageAdmin != null
                    && packageAdmin.getBundleType(bundle) != PackageAdmin.BUNDLE_TYPE_FRAGMENT)
                bundle.stop(Bundle.STOP_TRANSIENT);
            bundle.update();
        } catch (final BundleException e) {
            e.printStackTrace();
        }
    }

    private boolean isSupplementerMatching(final String symbolicName,
            final ManifestElement[] imports, final ManifestElement[] exports,
            final Supplementer supplementer) {
        final String supplementerName = supplementer.getSymbolicName();
        if (!supplementerName.equals(symbolicName)) {
            if (supplementer.matchSupplementer(symbolicName)
                    || (imports != null && supplementer
                            .matchesSupplementImporter(imports))
                    || (exports != null && supplementer
                            .matchesSupplementExporter(exports))) {
                return true;
            }
        }
        return false;
    }

    private void resupplementInstalledBundles(final Supplementer supplementer) {
        final Bundle[] installedBundles = context.getBundles();

        for (int i = 0; i < installedBundles.length; i++) {
            try {
                final Bundle bundle = installedBundles[i];

                if (bundle.getSymbolicName().equals(
                        supplementer.getSymbolicName())) {
                    continue;
                }

                if (dontWeaveTheseBundles.contains(bundle.getSymbolicName())) {
                    continue;
                }

                final Dictionary manifest = bundle.getHeaders();
                final ManifestElement[] imports = ManifestElement.parseHeader(
                        Constants.IMPORT_PACKAGE, (String) manifest
                                .get(Constants.IMPORT_PACKAGE));
                final ManifestElement[] exports = ManifestElement.parseHeader(
                        Constants.EXPORT_PACKAGE, (String) manifest
                                .get(Constants.EXPORT_PACKAGE));

                if (isSupplementerMatching(bundle.getSymbolicName(), imports,
                        exports, supplementer)) {
                    boolean alreadyRequired = false;
                    final ManifestElement[] requires = ManifestElement
                            .parseHeader(Constants.REQUIRE_BUNDLE,
                                    (String) manifest
                                            .get(Constants.REQUIRE_BUNDLE));
                    if (requires != null) {
                        for (int j = 0; j < requires.length; j++) {
                            if (requires[j].getValue().equals(
                                    supplementer.getSymbolicName())) {
                                alreadyRequired = true;
                            }
                        }
                    }

                    if (!alreadyRequired) {
                        updateInstalledBundle(bundle);
                    }
                }

            } catch (final BundleException e) {
                e.printStackTrace();
            }
        }
    }

}

Back to the top