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.platform.PlatformId;
038import org.nuxeo.connect.update.LocalPackage;
039import org.nuxeo.connect.update.Package;
040import org.nuxeo.connect.update.PackageException;
041import org.nuxeo.connect.update.PackageUpdateService;
042import org.nuxeo.connect.update.ValidationStatus;
043import org.nuxeo.connect.update.task.Task;
044import org.nuxeo.connect.update.task.standalone.UninstallTask;
045import org.nuxeo.ecm.admin.NuxeoCtlManager;
046import org.nuxeo.ecm.admin.runtime.PlatformVersionHelper;
047import org.nuxeo.ecm.webengine.model.WebObject;
048import org.nuxeo.ecm.webengine.model.impl.DefaultObject;
049import org.nuxeo.runtime.api.Framework;
050
051/**
052 * Provides REST bindings for {@link Package} install management.
053 *
054 * @author <a href="mailto:td@nuxeo.com">Thierry Delprat</a>
055 */
056@WebObject(type = "uninstallHandler")
057public class UninstallHandler extends DefaultObject {
058
059    protected static final Log log = LogFactory.getLog(UninstallHandler.class);
060
061    @GET
062    @Produces("text/html")
063    @Path(value = "start/{pkgId}")
064    public Object startUninstall(@PathParam("pkgId") String pkgId, @QueryParam("source") String source,
065            @QueryParam("filterOnPlatform") Boolean filterOnPlatform) {
066        try {
067            PackageUpdateService pus = Framework.getService(PackageUpdateService.class);
068            LocalPackage pkg = pus.getPackage(pkgId);
069            Task uninstallTask = pkg.getUninstallTask();
070            ValidationStatus status = uninstallTask.validate();
071            if (status.hasErrors()) {
072                return getView("canNotUninstall").arg("status", status).arg("pkg", pkg).arg("source", source);
073            }
074            PackageManager pm = Framework.getService(PackageManager.class);
075            List<DownloadablePackage> pkgToRemove = pm.getUninstallDependencies(pkg,
076                    getTargetPlatform(filterOnPlatform));
077            if (pkgToRemove.size() > 0) {
078                return getView("displayDependencies").arg("pkg", pkg)
079                                                     .arg("pkgToRemove", pkgToRemove)
080                                                     .arg("source", source);
081            }
082            return getView("startUninstall").arg("status", status)
083                                            .arg("uninstallTask", uninstallTask)
084                                            .arg("pkg", pkg)
085                                            .arg("source", source);
086        } catch (PackageException e) {
087            log.error("Error during first step of installation", e);
088            return getView("uninstallError").arg("e", e);
089        }
090    }
091
092    private PlatformId getTargetPlatform(Boolean filterOnPlatform) {
093        if (filterOnPlatform != Boolean.TRUE) {
094            return null;
095        }
096        return PlatformVersionHelper.getPlatformId();
097    }
098
099    @GET
100    @Produces("text/html")
101    @Path(value = "run/{pkgId}")
102    public Object doUninstall(@PathParam("pkgId") String pkgId, @QueryParam("source") String source,
103            @QueryParam("filterOnPlatform") Boolean filterOnPlatform) {
104        PackageUpdateService pus = Framework.getService(PackageUpdateService.class);
105        try {
106            LocalPackage pkg = pus.getPackage(pkgId);
107            PackageManager pm = Framework.getService(PackageManager.class);
108            List<DownloadablePackage> pkgToRemove = pm.getUninstallDependencies(pkg,
109                    getTargetPlatform(filterOnPlatform));
110            boolean restartRequired = InstallAfterRestart.isNeededForPackage(pkg);
111            if (!restartRequired) {
112                for (DownloadablePackage rpkg : pkgToRemove) {
113                    if (InstallAfterRestart.isNeededForPackage(rpkg)) {
114                        restartRequired = true;
115                        break;
116                    }
117                }
118            }
119            if (restartRequired) {
120                InstallAfterRestart.addPackageForUnInstallation(pkg.getName());
121                return getView("uninstallOnRestart").arg("pkg", pkg).arg("source", source);
122            } else {
123                log.debug("Uninstalling: " + pkgToRemove);
124                Task uninstallTask;
125                for (DownloadablePackage rpkg : pkgToRemove) {
126                    LocalPackage localPackage = pus.getPackage(rpkg.getId());
127                    performUninstall(localPackage);
128                }
129                uninstallTask = performUninstall(pkg);
130                return getView("uninstallDone").arg("uninstallTask", uninstallTask)
131                                               .arg("pkg", pkg)
132                                               .arg("source", source);
133            }
134        } catch (PackageException e) {
135            log.error("Error during uninstall of " + pkgId, e);
136            return getView("uninstallError").arg("e", e).arg("source", source);
137        }
138    }
139
140    /**
141     * Run UninstallTask of given local package
142     *
143     * @since 5.6
144     * @param localPackage Package to uninstall
145     * @return {@link UninstallTask} of {@code localPackage}
146     * @throws PackageException If uninstall fails. A rollback is done before the exception is raised.
147     */
148    protected Task performUninstall(LocalPackage localPackage) throws PackageException {
149        log.info("Uninstalling " + localPackage.getId());
150        Task uninstallTask = localPackage.getUninstallTask();
151        try {
152            uninstallTask.run(null);
153        } catch (PackageException e) {
154            log.error("Error during uninstall of " + localPackage.getId(), e);
155            uninstallTask.rollback();
156            throw e;
157        }
158        return uninstallTask;
159    }
160
161    @POST
162    @Path("restart")
163    public Object restartServer() {
164        NuxeoCtlManager.restart();
165        // TODO create a page that waits for the server to restart
166        return Response.ok().build();
167    }
168
169}