001/*
002 * (C) Copyright 2006-2012 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nuxeo - initial API and implementation
018 *
019 */
020package org.nuxeo.connect.client.we;
021
022import java.util.List;
023
024import javax.ws.rs.GET;
025import javax.ws.rs.POST;
026import javax.ws.rs.Path;
027import javax.ws.rs.PathParam;
028import javax.ws.rs.Produces;
029import javax.ws.rs.QueryParam;
030import javax.ws.rs.core.Response;
031
032import org.apache.commons.logging.Log;
033import org.apache.commons.logging.LogFactory;
034import org.nuxeo.connect.client.vindoz.InstallAfterRestart;
035import org.nuxeo.connect.data.DownloadablePackage;
036import org.nuxeo.connect.packages.PackageManager;
037import org.nuxeo.connect.update.LocalPackage;
038import org.nuxeo.connect.update.Package;
039import org.nuxeo.connect.update.PackageException;
040import org.nuxeo.connect.update.PackageUpdateService;
041import org.nuxeo.connect.update.ValidationStatus;
042import org.nuxeo.connect.update.task.Task;
043import org.nuxeo.connect.update.task.standalone.UninstallTask;
044import org.nuxeo.ecm.admin.NuxeoCtlManager;
045import org.nuxeo.ecm.admin.runtime.PlatformVersionHelper;
046import org.nuxeo.ecm.webengine.model.WebObject;
047import org.nuxeo.ecm.webengine.model.impl.DefaultObject;
048import org.nuxeo.runtime.api.Framework;
049
050/**
051 * Provides REST bindings for {@link Package} install management.
052 *
053 * @author <a href="mailto:[email protected]">Thierry Delprat</a>
054 */
055@WebObject(type = "uninstallHandler")
056public class UninstallHandler extends DefaultObject {
057
058    protected static final Log log = LogFactory.getLog(UninstallHandler.class);
059
060    @GET
061    @Produces("text/html")
062    @Path(value = "start/{pkgId}")
063    public Object startUninstall(@PathParam("pkgId") String pkgId, @QueryParam("source") String source,
064            @QueryParam("filterOnPlatform") Boolean filterOnPlatform) {
065        try {
066            PackageUpdateService pus = Framework.getService(PackageUpdateService.class);
067            LocalPackage pkg = pus.getPackage(pkgId);
068            Task uninstallTask = pkg.getUninstallTask();
069            ValidationStatus status = uninstallTask.validate();
070            if (status.hasErrors()) {
071                return getView("canNotUninstall").arg("status", status).arg("pkg", pkg).arg("source", source);
072            }
073            PackageManager pm = Framework.getService(PackageManager.class);
074            List<DownloadablePackage> pkgToRemove = pm.getUninstallDependencies(pkg,
075                    getTargetPlatform(filterOnPlatform));
076            if (pkgToRemove.size() > 0) {
077                return getView("displayDependencies").arg("pkg", pkg).arg("pkgToRemove", pkgToRemove).arg("source",
078                        source);
079            }
080            return getView("startUninstall").arg("status", status)
081                                            .arg("uninstallTask", uninstallTask)
082                                            .arg("pkg", pkg)
083                                            .arg("source", source);
084        } catch (PackageException e) {
085            log.error("Error during first step of installation", e);
086            return getView("uninstallError").arg("e", e);
087        }
088    }
089
090    /**
091     * @param filterOnPlatform
092     * @return
093     */
094    private String getTargetPlatform(Boolean filterOnPlatform) {
095        if (filterOnPlatform != Boolean.TRUE) {
096            return null;
097        }
098        return PlatformVersionHelper.getPlatformFilter();
099    }
100
101    @GET
102    @Produces("text/html")
103    @Path(value = "run/{pkgId}")
104    public Object doUninstall(@PathParam("pkgId") String pkgId, @QueryParam("source") String source,
105            @QueryParam("filterOnPlatform") Boolean filterOnPlatform) {
106        PackageUpdateService pus = Framework.getService(PackageUpdateService.class);
107        try {
108            LocalPackage pkg = pus.getPackage(pkgId);
109            PackageManager pm = Framework.getService(PackageManager.class);
110            List<DownloadablePackage> pkgToRemove = pm.getUninstallDependencies(pkg,
111                    getTargetPlatform(filterOnPlatform));
112            boolean restartRequired = InstallAfterRestart.isNeededForPackage(pkg);
113            if (!restartRequired) {
114                for (DownloadablePackage rpkg : pkgToRemove) {
115                    if (InstallAfterRestart.isNeededForPackage(rpkg)) {
116                        restartRequired = true;
117                        break;
118                    }
119                }
120            }
121            if (restartRequired) {
122                InstallAfterRestart.addPackageForUnInstallation(pkg.getName());
123                return getView("uninstallOnRestart").arg("pkg", pkg).arg("source", source);
124            } else {
125                log.debug("Uninstalling: " + pkgToRemove);
126                Task uninstallTask;
127                for (DownloadablePackage rpkg : pkgToRemove) {
128                    LocalPackage localPackage = pus.getPackage(rpkg.getId());
129                    performUninstall(localPackage);
130                }
131                uninstallTask = performUninstall(pkg);
132                return getView("uninstallDone").arg("uninstallTask", uninstallTask).arg("pkg", pkg).arg("source",
133                        source);
134            }
135        } catch (PackageException e) {
136            log.error("Error during uninstall of " + pkgId, e);
137            return getView("uninstallError").arg("e", e).arg("source", source);
138        }
139    }
140
141    /**
142     * Run UninstallTask of given local package
143     *
144     * @since 5.6
145     * @param localPackage Package to uninstall
146     * @return {@link UninstallTask} of {@code localPackage}
147     * @throws PackageException If uninstall fails. A rollback is done before the exception is raised.
148     */
149    protected Task performUninstall(LocalPackage localPackage) throws PackageException {
150        log.info("Uninstalling " + localPackage.getId());
151        Task uninstallTask = localPackage.getUninstallTask();
152        try {
153            uninstallTask.run(null);
154        } catch (PackageException e) {
155            log.error("Error during uninstall of " + localPackage.getId(), e);
156            uninstallTask.rollback();
157            throw e;
158        }
159        return uninstallTask;
160    }
161
162    @POST
163    @Path("restart")
164    public Object restartServer() {
165        NuxeoCtlManager.restart();
166        // TODO create a page that waits for the server to restart
167        return Response.ok().build();
168    }
169
170}