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.runtime.PlatformVersionHelper; 045import org.nuxeo.ecm.webengine.WebException; 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:td@nuxeo.com">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.getLocalService(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.getLocalService(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).arg("uninstallTask", uninstallTask).arg("pkg", pkg).arg( 081 "source", source); 082 } catch (PackageException e) { 083 log.error("Error during first step of installation", e); 084 return getView("uninstallError").arg("e", e); 085 } 086 } 087 088 /** 089 * @param filterOnPlatform 090 * @return 091 */ 092 private String getTargetPlatform(Boolean filterOnPlatform) { 093 if (filterOnPlatform != Boolean.TRUE) { 094 return null; 095 } 096 return PlatformVersionHelper.getPlatformFilter(); 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.getLocalService(PackageUpdateService.class); 105 try { 106 LocalPackage pkg = pus.getPackage(pkgId); 107 PackageManager pm = Framework.getLocalService(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).arg("pkg", pkg).arg("source", 131 source); 132 } 133 } catch (PackageException e) { 134 log.error("Error during uninstall of " + pkgId, e); 135 return getView("uninstallError").arg("e", e).arg("source", source); 136 } 137 } 138 139 /** 140 * Run UninstallTask of given local package 141 * 142 * @since 5.6 143 * @param localPackage Package to uninstall 144 * @return {@link UninstallTask} of {@code localPackage} 145 * @throws PackageException If uninstall fails. A rollback is done before the exception is raised. 146 */ 147 protected Task performUninstall(LocalPackage localPackage) throws PackageException { 148 log.info("Uninstalling " + localPackage.getId()); 149 Task uninstallTask = localPackage.getUninstallTask(); 150 try { 151 uninstallTask.run(null); 152 } catch (PackageException e) { 153 log.error("Error during uninstall of " + localPackage.getId(), e); 154 uninstallTask.rollback(); 155 throw e; 156 } 157 return uninstallTask; 158 } 159 160 @POST 161 @Path("restart") 162 public Object restartServer() { 163 PackageUpdateService pus = Framework.getLocalService(PackageUpdateService.class); 164 try { 165 pus.restart(); 166 } catch (PackageException e) { 167 throw WebException.wrap(e); 168 } 169 // TODO create a page that waits for the server to restart 170 return Response.ok().build(); 171 } 172 173}