/*******************************************************************************
* Copyright (c) 2014, 2016 Red Hat.
* 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:
* Red Hat - Initial Contribution
*******************************************************************************/
package org.eclipse.linuxtools.internal.docker.core;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.linuxtools.docker.core.DockerException;
import org.eclipse.linuxtools.docker.core.DockerImagePullFailedException;
import org.eclipse.linuxtools.docker.core.IDockerConnection;
import org.eclipse.linuxtools.docker.core.IDockerProgressDetail;
import org.eclipse.linuxtools.docker.core.IDockerProgressHandler;
import org.eclipse.linuxtools.docker.core.IDockerProgressMessage;
public class DefaultImagePullProgressHandler implements IDockerProgressHandler {
private final static String IMAGE_DOWNLOAD_COMPLETE = "ImageDownloadComplete.msg"; //$NON-NLS-1$
private final static String IMAGE_DOWNLOADING_JOBNAME = "ImageDownloadingJobName.msg"; //$NON-NLS-1$
private final static String IMAGE_DOWNLOADING_IMAGE = "ImageDownloadingImage.msg"; //$NON-NLS-1$
private final static String IMAGE_DOWNLOADING = "ImageDownloading.msg"; //$NON-NLS-1$
private final static String IMAGE_VERIFYING_CHECKSUM = "ImageVerifyingChecksum.msg"; //$NON-NLS-1$
private final static String IMAGE_EXTRACTING_JOBNAME = "ImageExtractingJobName.msg"; //$NON-NLS-1$
private final static String IMAGE_EXTRACTING_IMAGE = "ImageExtractingImage.msg"; //$NON-NLS-1$
private final static String IMAGE_EXTRACTING = "ImageExtracting.msg"; //$NON-NLS-1$
private final static String IMAGE_PULLING = "ImagePulling.msg"; //$NON-NLS-1$
private final static String IMAGE_PULL_COMPLETE = "ImagePullComplete.msg"; //$NON-NLS-1$
private final static String IMAGE_DOWNLOADING_ALREADY_EXISTS = "ImageDownloadingAlreadyExists.msg"; //$NON-NLS-1$
private final static String IMAGE_DOWNLOADING_VERIFIED = "ImageDownloadingVerified.msg"; //$NON-NLS-1$
private String image;
private DockerConnection connection;
private Map<String, ProgressJob> progressJobs = new HashMap<>();
public DefaultImagePullProgressHandler(IDockerConnection connection, String image) {
this.image = image;
this.connection = (DockerConnection) connection;
}
@Override
public void processMessage(IDockerProgressMessage message)
throws DockerException {
if (message.error() != null) {
stopAllJobs();
throw new DockerImagePullFailedException(image, message.error());
}
String id = message.id();
if (id != null) {
ProgressJob p = progressJobs.get(id);
if (p == null) {
String status = message.status();
if (status.contains(DockerMessages.getString(IMAGE_PULLING))) {
// do nothing
} else if (status
.equals(DockerMessages.getString(IMAGE_DOWNLOAD_COMPLETE))
|| status.contains(DockerMessages
.getString(IMAGE_DOWNLOADING_ALREADY_EXISTS))
|| status.contains(DockerMessages
.getString(IMAGE_DOWNLOADING_VERIFIED))
|| status.contains(DockerMessages
.getString(IMAGE_VERIFYING_CHECKSUM))
|| status.equals(
DockerMessages.getString(IMAGE_PULL_COMPLETE))) {
// an image is fully loaded, update the image list
connection.getImages(true);
} else if (status
.startsWith(DockerMessages.getString(IMAGE_DOWNLOADING))) {
IDockerProgressDetail detail = message.progressDetail();
if (detail == null || detail.total() == 0) {
// We have a new extraction in progress with no
// details of what the total should be. Track it.
ProgressJob2 newJob = new ProgressJob2(
DockerMessages.getFormattedString(
IMAGE_DOWNLOADING_JOBNAME, image),
DockerMessages.getFormattedString(
IMAGE_DOWNLOADING_IMAGE, id));
// job.setUser(false) will show all pull job (one per
// image layer) in the progress
// view but not in multiple dialog
newJob.setUser(false);
newJob.setPriority(Job.LONG);
newJob.schedule();
progressJobs.put(id, newJob);
} else {
// We have a new download in progress and it
// provides us with a total so we can calculate
// percentage done. Track it.
ProgressJob newJob = new ProgressJob(
DockerMessages.getFormattedString(
IMAGE_DOWNLOADING_JOBNAME, image),
DockerMessages.getFormattedString(
IMAGE_DOWNLOADING_IMAGE, id));
// job.setUser(false) will show all pull job (one per
// image layer) in the progress
// view but not in multiple dialog
newJob.setUser(false);
newJob.setPriority(Job.LONG);
newJob.schedule();
progressJobs.put(id, newJob);
}
} else if (status.startsWith(
DockerMessages.getString(IMAGE_EXTRACTING))) {
IDockerProgressDetail detail = message.progressDetail();
if (detail == null || detail.total() == 0) {
// We have a new extraction in progress with no
// details of what the total should be. Track it.
ProgressJob2 newJob = new ProgressJob2(
DockerMessages.getFormattedString(
IMAGE_EXTRACTING_JOBNAME, image),
DockerMessages.getFormattedString(
IMAGE_EXTRACTING_IMAGE, id));
// job.setUser(false) will show all pull job (one per
// image layer) in the progress
// view but not in multiple dialog
newJob.setUser(false);
newJob.setPriority(Job.LONG);
newJob.schedule();
progressJobs.put(id, newJob);
} else {
// We have a new extraction in progress and it
// provides us with a total so we can calculate
// percentage done. Track it.
ProgressJob newJob = new ProgressJob(
DockerMessages.getFormattedString(
IMAGE_EXTRACTING_JOBNAME, image),
DockerMessages.getFormattedString(
IMAGE_EXTRACTING_IMAGE, id));
// job.setUser(false) will show all pull job (one per
// image
// layer) in the progress
// view but not in multiple dialog
newJob.setUser(false);
newJob.setPriority(Job.LONG);
newJob.schedule();
progressJobs.put(id, newJob);
}
}
} else {
String status = message.status();
if (status.equals(DockerMessages.getString(IMAGE_DOWNLOAD_COMPLETE))
|| status.contains(DockerMessages
.getString(IMAGE_DOWNLOADING_ALREADY_EXISTS))
|| status.contains(DockerMessages
.getString(IMAGE_DOWNLOADING_VERIFIED))
|| status.contains(DockerMessages
.getString(IMAGE_VERIFYING_CHECKSUM))
|| status.contains(DockerMessages
.getString(IMAGE_PULL_COMPLETE))) {
// Download or pull is complete for this id so set the job
// percentage 100 and
// remove the job from list. Removing the job allows
// extraction job to be
// created after a download is complete.
p.setPercentageDone(100);
progressJobs.put(id, null);
connection.getImages(true);
} else if (status
.startsWith(DockerMessages.getString(IMAGE_DOWNLOADING))) {
// Update download progress
IDockerProgressDetail detail = message.progressDetail();
if (detail != null) {
if (p instanceof ProgressJob2) {
((ProgressJob2) p)
.setStatusMessage(message.progress());
} else if (detail.current() > 0 && detail.total() > 0) {
long percentage = (detail.current() * 100)
/ detail.total();
p.setPercentageDone((int) percentage);
}
}
} else if (status.startsWith(
DockerMessages.getString(IMAGE_EXTRACTING))) {
// Update extracting progress
IDockerProgressDetail detail = message.progressDetail();
if (detail != null) {
if (p instanceof ProgressJob2) {
((ProgressJob2) p)
.setStatusMessage(message.progress());
} else if (detail.current() > 0 && detail.total() > 0) {
long percentage = (detail.current() * 100)
/ detail.total();
p.setPercentageDone((int) percentage);
}
}
}
}
}
}
private void stopAllJobs() {
for (ProgressJob j : progressJobs.values()) {
if (j != null) {
j.cancel();
}
}
}
}