| 1 |
/******************************************************************************* |
| 2 |
* Copyright (c) 2013, 2018 Red Hat, Inc. and others |
| 3 |
* |
| 4 |
* This program and the accompanying materials |
| 5 |
* are made available under the terms of the Eclipse Public License 2.0 |
| 6 |
* which accompanies this distribution, and is available at |
| 7 |
* https://www.eclipse.org/legal/epl-2.0/ |
| 8 |
* |
| 9 |
* SPDX-License-Identifier: EPL-2.0 |
| 10 |
* |
| 11 |
* Contributors: |
| 12 |
* Red Hat, Inc. - initial API and implementation |
| 13 |
*******************************************************************************/ |
| 14 |
package org.eclipse.equinox.p2.operations; |
| 15 |
|
| 16 |
import java.util.ArrayList; |
| 17 |
import java.util.List; |
| 18 |
import org.eclipse.core.runtime.*; |
| 19 |
import org.eclipse.core.runtime.jobs.Job; |
| 20 |
import org.eclipse.equinox.internal.p2.director.ProfileChangeRequest; |
| 21 |
import org.eclipse.equinox.internal.p2.operations.*; |
| 22 |
import org.eclipse.equinox.p2.metadata.IInstallableUnit; |
| 23 |
import org.eclipse.equinox.p2.metadata.Version; |
| 24 |
import org.eclipse.equinox.p2.planner.IPlanner; |
| 25 |
import org.eclipse.equinox.p2.planner.IProfileChangeRequest; |
| 26 |
|
| 27 |
/** |
| 28 |
* <p> |
| 29 |
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as |
| 30 |
* part of a work in progress. There is no guarantee that this API will |
| 31 |
* work or that it will remain the same. Please do not use this API without |
| 32 |
* consulting with the p2 team. |
| 33 |
* </p> |
| 34 |
* @noreference |
| 35 |
* @since 2.3 |
| 36 |
*/ |
| 37 |
public class RemediationOperation extends ProfileChangeOperation { |
| 38 |
|
| 39 |
private static int ZERO_WEIGHT = 0; |
| 40 |
private static int LOW_WEIGHT = 1; |
| 41 |
private static int MEDIUM_WEIGHT = 2; |
| 42 |
private static int HIGH_WEIGHT = 3; |
| 43 |
private List<Remedy> remedies; |
| 44 |
private Remedy bestSolutionChangingTheRequest; |
| 45 |
private Remedy bestSolutionChangingWhatIsInstalled; |
| 46 |
private Remedy currentRemedy; |
| 47 |
private RemedyConfig[] remedyConfigs; |
| 48 |
|
| 49 |
public RemedyConfig[] getRemedyConfigs() { |
| 50 |
return remedyConfigs; |
| 51 |
} |
| 52 |
|
| 53 |
public Remedy getCurrentRemedy() { |
| 54 |
return currentRemedy; |
| 55 |
} |
| 56 |
|
| 57 |
public void setCurrentRemedy(Remedy currentRemedy) { |
| 58 |
this.currentRemedy = currentRemedy; |
| 59 |
request = currentRemedy == null ? null : currentRemedy.getRequest(); |
| 60 |
} |
| 61 |
|
| 62 |
private IProfileChangeRequest originalRequest; |
| 63 |
|
| 64 |
public RemediationOperation(ProvisioningSession session, IProfileChangeRequest iProfileChangeRequest) { |
| 65 |
this(session, iProfileChangeRequest, RemedyConfig.getAllRemedyConfigs()); |
| 66 |
|
| 67 |
} |
| 68 |
|
| 69 |
public RemediationOperation(ProvisioningSession session, IProfileChangeRequest originalRequest, RemedyConfig[] remedyConfigs) { |
| 70 |
super(session); |
| 71 |
this.originalRequest = originalRequest; |
| 72 |
remedies = new ArrayList<>(); |
| 73 |
this.remedyConfigs = remedyConfigs; |
| 74 |
} |
| 75 |
|
| 76 |
public Remedy bestSolutionChangingTheRequest() { |
| 77 |
return bestSolutionChangingTheRequest; |
| 78 |
} |
| 79 |
|
| 80 |
public Remedy bestSolutionChangingWhatIsInstalled() { |
| 81 |
return bestSolutionChangingWhatIsInstalled; |
| 82 |
} |
| 83 |
|
| 84 |
public List<Remedy> getRemedies() { |
| 85 |
return remedies; |
| 86 |
} |
| 87 |
|
| 88 |
@Override |
| 89 |
protected void computeProfileChangeRequest(MultiStatus status, IProgressMonitor monitor) { |
| 90 |
SubMonitor sub = SubMonitor.convert(monitor, 1); |
| 91 |
if (currentRemedy != null) { |
| 92 |
request = currentRemedy.getRequest(); |
| 93 |
sub.worked(1); |
| 94 |
return; |
| 95 |
} |
| 96 |
try { |
| 97 |
status.add(computeAllRemediations(sub.newChild(1))); |
| 98 |
} catch (OperationCanceledException e) { |
| 99 |
status.add(Status.CANCEL_STATUS); |
| 100 |
} |
| 101 |
determineBestSolutions(); |
| 102 |
} |
| 103 |
|
| 104 |
private IStatus computeAllRemediations(IProgressMonitor monitor) { |
| 105 |
SubMonitor sub = SubMonitor.convert(monitor, remedyConfigs.length); |
| 106 |
sub.setTaskName(Messages.RemediationOperation_ProfileChangeRequestProgress); |
| 107 |
List<Remedy> tmpRemedies = new ArrayList<>(remedyConfigs.length); |
| 108 |
try { |
| 109 |
for (int i = 0; i < remedyConfigs.length; i++) { |
| 110 |
sub.subTask((i + 1) + " / " + remedyConfigs.length); //$NON-NLS-1$ |
| 111 |
if (sub.isCanceled()) |
| 112 |
return Status.CANCEL_STATUS; |
| 113 |
Remedy remedy = computeRemedy(remedyConfigs[i], sub.newChild(1, SubMonitor.SUPPRESS_ALL_LABELS)); |
| 114 |
if (remedy != null) { |
| 115 |
tmpRemedies.add(remedy); |
| 116 |
} |
| 117 |
} |
| 118 |
} finally { |
| 119 |
sub.done(); |
| 120 |
} |
| 121 |
remedies = tmpRemedies; |
| 122 |
return getResolutionResult(); |
| 123 |
} |
| 124 |
|
| 125 |
private void determineBestSolutions() { |
| 126 |
int beingInstalledWeight = 0; |
| 127 |
int installationWeight = 0; |
| 128 |
for (Remedy remedy : remedies) { |
| 129 |
if (remedy.getRequest() != null) { |
| 130 |
if (remedy.getBeingInstalledRelaxedWeight() > beingInstalledWeight && remedy.getInstallationRelaxedWeight() == 0) { |
| 131 |
bestSolutionChangingTheRequest = remedy; |
| 132 |
beingInstalledWeight = remedy.getBeingInstalledRelaxedWeight(); |
| 133 |
continue; |
| 134 |
} |
| 135 |
if (remedy.getInstallationRelaxedWeight() > installationWeight && remedy.getBeingInstalledRelaxedWeight() == 0) { |
| 136 |
bestSolutionChangingWhatIsInstalled = remedy; |
| 137 |
installationWeight = remedy.getInstallationRelaxedWeight(); |
| 138 |
continue; |
| 139 |
} |
| 140 |
} |
| 141 |
} |
| 142 |
} |
| 143 |
|
| 144 |
private Remedy computeRemedy(RemedyConfig configuration, IProgressMonitor monitor) { |
| 145 |
Remedy remedy = new Remedy(originalRequest); |
| 146 |
remedy.setConfig(configuration); |
| 147 |
IPlanner planner = session.getPlanner(); |
| 148 |
RequestFlexer av = new RequestFlexer(planner); |
| 149 |
av.setAllowDifferentVersion(configuration.allowDifferentVersion); |
| 150 |
av.setAllowInstalledElementChange(configuration.allowInstalledUpdate); |
| 151 |
av.setAllowInstalledElementRemoval(configuration.allowInstalledRemoval); |
| 152 |
av.setAllowPartialInstall(configuration.allowPartialInstall); |
| 153 |
av.setProvisioningContext(getProvisioningContext()); |
| 154 |
remedy.setRequest((ProfileChangeRequest) av.getChangeRequest(originalRequest, ((ProfileChangeRequest) originalRequest).getProfile(), monitor)); |
| 155 |
if (remedy.getRequest() == null) |
| 156 |
return null; |
| 157 |
|
| 158 |
if (configuration.allowInstalledUpdate && !configuration.allowInstalledRemoval) { |
| 159 |
remedy.setInstallationRelaxedWeight(HIGH_WEIGHT); |
| 160 |
} else if (!configuration.allowInstalledUpdate && configuration.allowInstalledRemoval) { |
| 161 |
remedy.setInstallationRelaxedWeight(MEDIUM_WEIGHT); |
| 162 |
} else if (configuration.allowInstalledUpdate && configuration.allowInstalledRemoval) { |
| 163 |
remedy.setInstallationRelaxedWeight(LOW_WEIGHT); |
| 164 |
} else |
| 165 |
remedy.setInstallationRelaxedWeight(ZERO_WEIGHT); |
| 166 |
|
| 167 |
if (configuration.allowDifferentVersion && !configuration.allowPartialInstall) { |
| 168 |
remedy.setBeingInstalledRelaxedWeight(HIGH_WEIGHT); |
| 169 |
} else if (!configuration.allowDifferentVersion && configuration.allowPartialInstall) { |
| 170 |
remedy.setBeingInstalledRelaxedWeight(MEDIUM_WEIGHT); |
| 171 |
} else if (configuration.allowDifferentVersion && configuration.allowPartialInstall) { |
| 172 |
remedy.setBeingInstalledRelaxedWeight(LOW_WEIGHT); |
| 173 |
} else { |
| 174 |
remedy.setBeingInstalledRelaxedWeight(ZERO_WEIGHT); |
| 175 |
} |
| 176 |
computeRemedyDetails(remedy); |
| 177 |
return remedy; |
| 178 |
} |
| 179 |
|
| 180 |
@Override |
| 181 |
protected String getResolveJobName() { |
| 182 |
return Messages.RemediationOperation_ResolveJobName; |
| 183 |
} |
| 184 |
|
| 185 |
@Override |
| 186 |
protected String getProvisioningJobName() { |
| 187 |
return Messages.RemediationOperation_RemediationJobName; |
| 188 |
} |
| 189 |
|
| 190 |
@Override |
| 191 |
public ProvisioningJob getProvisioningJob(IProgressMonitor monitor) { |
| 192 |
IStatus status = getResolutionResult(); |
| 193 |
if (status.getSeverity() != IStatus.CANCEL && status.getSeverity() != IStatus.ERROR) { |
| 194 |
if (job.getProvisioningPlan() != null) { |
| 195 |
ProfileModificationJob pJob = new ProfileModificationJob(getProvisioningJobName(), session, profileId, job.getProvisioningPlan(), job.getActualProvisioningContext()); |
| 196 |
pJob.setAdditionalProgressMonitor(monitor); |
| 197 |
return pJob; |
| 198 |
} |
| 199 |
} |
| 200 |
return null; |
| 201 |
} |
| 202 |
|
| 203 |
public ProfileChangeRequest getOriginalRequest() { |
| 204 |
return (ProfileChangeRequest) originalRequest; |
| 205 |
} |
| 206 |
|
| 207 |
@Override |
| 208 |
void makeResolveJob(final IProgressMonitor monitor) { |
| 209 |
// throw away any previous requests |
| 210 |
request = null; |
| 211 |
noChangeRequest = PlanAnalyzer.getProfileChangeAlteredStatus(); |
| 212 |
// the requestHolder is a hack to work around the fact that there is no public API |
| 213 |
// for the resolution job to get the request from the operation after it has been |
| 214 |
// computed. |
| 215 |
final ProfileChangeRequest[] requestHolder = new ProfileChangeRequest[1]; |
| 216 |
job = new RemediationResolutionJob(getResolveJobName(), session, profileId, request, getFirstPassProvisioningContext(), getSecondPassEvaluator(), noChangeRequest, mon -> { |
| 217 |
SubMonitor sub = SubMonitor.convert(mon, 2); |
| 218 |
// We only check for other jobs running if this job is *not* scheduled |
| 219 |
if (job.getState() == Job.NONE && session.hasScheduledOperationsFor(profileId)) { |
| 220 |
noChangeRequest.add(PlanAnalyzer.getStatus(IStatusCodes.OPERATION_ALREADY_IN_PROGRESS, null)); |
| 221 |
} else { |
| 222 |
sub.worked(1); |
| 223 |
computeProfileChangeRequest(noChangeRequest, sub.newChild(1)); |
| 224 |
requestHolder[0] = RemediationOperation.this.request; |
| 225 |
} |
| 226 |
}, requestHolder, this); |
| 227 |
} |
| 228 |
|
| 229 |
@Override |
| 230 |
public IStatus getResolutionResult() { |
| 231 |
if (currentRemedy != null) |
| 232 |
return super.getResolutionResult(); |
| 233 |
return remedies.size() > 0 ? Status.OK_STATUS : new Status(IStatus.ERROR, Constants.BUNDLE_ID, Messages.RemediationOperation_NoRemedyFound); |
| 234 |
} |
| 235 |
|
| 236 |
private void computeRemedyDetails(Remedy remedy) { |
| 237 |
ArrayList<String> updateIds = new ArrayList<>(); |
| 238 |
for (IInstallableUnit addedIU : remedy.getRequest().getAdditions()) { |
| 239 |
for (IInstallableUnit removedIU : remedy.getRequest().getRemovals()) { |
| 240 |
if (removedIU.getId().equals(addedIU.getId())) { |
| 241 |
createModificationRemedyDetail(addedIU, removedIU, remedy); |
| 242 |
updateIds.add(addedIU.getId()); |
| 243 |
break; |
| 244 |
} |
| 245 |
} |
| 246 |
if (!updateIds.contains(addedIU.getId())) { |
| 247 |
createAdditionRemedyDetail(addedIU, remedy); |
| 248 |
} |
| 249 |
} |
| 250 |
|
| 251 |
for (IInstallableUnit removedIU : remedy.getRequest().getRemovals()) { |
| 252 |
if (!updateIds.contains(removedIU.getId())) { |
| 253 |
createRemovalRemedyDetail(removedIU, remedy); |
| 254 |
} |
| 255 |
} |
| 256 |
|
| 257 |
for (IInstallableUnit addedIUinOriginalRequest : originalRequest.getAdditions()) { |
| 258 |
boolean found = false; |
| 259 |
for (IInstallableUnit addedIU : remedy.getRequest().getAdditions()) { |
| 260 |
if (addedIU.getId().equals(addedIUinOriginalRequest.getId())) { |
| 261 |
found = true; |
| 262 |
break; |
| 263 |
} |
| 264 |
} |
| 265 |
if (!found) { |
| 266 |
createNotAddedRemedyDetail(addedIUinOriginalRequest, remedy); |
| 267 |
found = false; |
| 268 |
} |
| 269 |
} |
| 270 |
} |
| 271 |
|
| 272 |
private void createNotAddedRemedyDetail(IInstallableUnit iu, Remedy remedy) { |
| 273 |
RemedyIUDetail iuDetail = new RemedyIUDetail(iu); |
| 274 |
iuDetail.setStatus(RemedyIUDetail.STATUS_NOT_ADDED); |
| 275 |
iuDetail.setRequestedVersion(iu.getVersion()); |
| 276 |
remedy.addRemedyIUDetail(iuDetail); |
| 277 |
} |
| 278 |
|
| 279 |
private void createRemovalRemedyDetail(IInstallableUnit iu, Remedy remedy) { |
| 280 |
RemedyIUDetail iuDetail = new RemedyIUDetail(iu); |
| 281 |
iuDetail.setStatus(RemedyIUDetail.STATUS_REMOVED); |
| 282 |
iuDetail.setInstalledVersion(iu.getVersion()); |
| 283 |
remedy.addRemedyIUDetail(iuDetail); |
| 284 |
} |
| 285 |
|
| 286 |
private void createAdditionRemedyDetail(IInstallableUnit iu, Remedy remedy) { |
| 287 |
RemedyIUDetail iuDetail = new RemedyIUDetail(iu); |
| 288 |
iuDetail.setStatus(RemedyIUDetail.STATUS_ADDED); |
| 289 |
iuDetail.setBeingInstalledVersion(iu.getVersion()); |
| 290 |
iuDetail.setRequestedVersion(searchInOriginalRequest(iu.getId())); |
| 291 |
remedy.addRemedyIUDetail(iuDetail); |
| 292 |
} |
| 293 |
|
| 294 |
private void createModificationRemedyDetail(IInstallableUnit beingInstalledIU, IInstallableUnit installedIU, Remedy remedy) { |
| 295 |
RemedyIUDetail iuDetail = new RemedyIUDetail(beingInstalledIU); |
| 296 |
iuDetail.setStatus(RemedyIUDetail.STATUS_CHANGED); |
| 297 |
iuDetail.setBeingInstalledVersion(beingInstalledIU.getVersion()); |
| 298 |
iuDetail.setInstalledVersion(installedIU.getVersion()); |
| 299 |
iuDetail.setRequestedVersion(searchInOriginalRequest(beingInstalledIU.getId())); |
| 300 |
remedy.addRemedyIUDetail(iuDetail); |
| 301 |
} |
| 302 |
|
| 303 |
private Version searchInOriginalRequest(String id) { |
| 304 |
for (IInstallableUnit iu : originalRequest.getAdditions()) { |
| 305 |
if (iu.getId() == id) |
| 306 |
return iu.getVersion(); |
| 307 |
} |
| 308 |
return null; |
| 309 |
} |
| 310 |
} |