Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tag: v2.0.0.RC3
Fetching contributors…

Cannot retrieve contributors at this time

file 272 lines (233 sloc) 9.4 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
/*
* Copyright 2004-2005 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

import grails.util.GrailsUtil
import grails.util.Metadata
import grails.web.container.EmbeddableServer
import grails.web.container.EmbeddableServerFactory

import java.awt.event.ActionEvent
import java.awt.event.ActionListener
import java.net.ServerSocket

import org.codehaus.groovy.grails.cli.ScriptExitException
import org.codehaus.groovy.grails.cli.interactive.InteractiveMode
import org.codehaus.groovy.grails.compiler.GrailsProjectWatcher

/**
* Gant script that executes Grails using an embedded server.
*
* @author Graeme Rocher
*
* @since 0.4
*/

includeTargets << grailsScript("_GrailsPlugins")

SCHEME_HTTP = "http"
SCHEME_HTTPS = "https"

// Keep track of whether we're running in HTTPS mode in case we need
// to restart the server.
usingSecureServer = false

grailsServer = null
grailsContext = null
autoRecompile = System.getProperty("disable.auto.recompile") ? !(System.getProperty("disable.auto.recompile").toBoolean()) : true

// How often should recompilation occur while the application is running (in seconds)?
// Defaults to 3s.
recompileFrequency = System.getProperty("recompile.frequency")
recompileFrequency = recompileFrequency ? recompileFrequency.toInteger() : 3

shouldPackageTemplates = true

// This isn't used within this script but may come in handy for scripts
// that depend on this one.
ant.path(id: "grails.runtime.classpath", runtimeClasspath)

/**
* Runs the application in dev mode, i.e. with class-reloading.
*/
target(runApp: "Main implementation that executes a Grails application") {
    runInline(SCHEME_HTTP, serverHost, serverPort, serverPortHttps)
}

/**
* Runs the application in dev mode over HTTPS.
*/
target(runAppHttps: "Main implementation that executes a Grails application with an HTTPS listener") {
    runInline(SCHEME_HTTPS, serverHost, serverPort, serverPortHttps)
}

/**
* Runs the application using the WAR file directly.
*/
target (runWar : "Main implementation that executes a Grails application WAR") {
    runWar(SCHEME_HTTP, serverHost, serverPort, serverPortHttps)
}

/**
* Runs the application over HTTPS using the WAR file directly.
*/
target (runWarHttps : "Main implementation that executes a Grails application WAR") {
    runWar(SCHEME_HTTPS, serverHost, serverPort, serverPortHttps)
}

private EmbeddableServerFactory loadServerFactory() {
    def load = { name -> classLoader.loadClass(name).newInstance() }

    String defaultServer = "org.grails.plugins.tomcat.TomcatServerFactory"
    def containerClass = getPropertyValue("grails.server.factory", defaultServer)
    EmbeddableServerFactory serverFactory
    try {
        serverFactory = load(containerClass)
    }
    catch (ClassNotFoundException cnfe) {
        if (containerClass == defaultServer) {
            grailsConsole.error "WARNING: No default container found, installing Tomcat.."
            doInstallPlugin "tomcat", GrailsUtil.grailsVersion
            pluginSettings.clearCache()
            compilePlugins()
            loadPlugins()
            serverFactory = load(containerClass)
        }
    }
    catch (Throwable e) {
        grailsConsole.error e
        event("StatusFinal", ["Failed to load container [$containerClass]: ${e.message}"])
        exit(1)
    }
    return serverFactory
}

private runInline(scheme, host, httpPort, httpsPort) {
    EmbeddableServerFactory serverFactory = loadServerFactory()
    grailsServer = serverFactory.createInline("${basedir}/web-app", webXmlFile.absolutePath, serverContextPath, classLoader)
    runServer server: grailsServer, host:host, httpPort: httpPort, httpsPort: httpsPort, scheme:scheme
    startPluginScanner()
}

private runWar(scheme, host, httpPort, httpsPort) {
    EmbeddableServerFactory serverFactory = loadServerFactory()
    grailsServer = serverFactory.createForWAR(warName, serverContextPath)

    Metadata.getCurrent().put(Metadata.WAR_DEPLOYED, "true")
    runServer server:grailsServer, host:host, httpPort:httpPort, httpsPort: httpsPort, scheme: scheme
}

/**
* Runs the Server. You can pass these named arguments:
*
* server - The server instance to use (required).
* port - The network port the server is running on (used to display the URL) (required).
* scheme - The network scheme to display in the URL (optional; defaults to "http").
*/
runServer = { Map args ->
    try {
        event("StatusUpdate", ["Running Grails application"])
        def message = "Server running. Browse to http://${args.host ?: 'localhost'}:${args.httpPort}$serverContextPath"

        EmbeddableServer server = args["server"]
        if (server.hasProperty('eventListener')) {
            server.eventListener = this
        }
        if (server.hasProperty('grailsConfig')) {
            server.grailsConfig = config
        }

        profile("start server") {

            try { new ServerSocket(args.httpPort).close() }
            catch (IOException e) {
                event("StatusError", ["Server failed to start for port $args.httpPort: $e.message"])
                exit(1)
            }

            if (args.scheme == 'https') {

                try { new ServerSocket(args.httpsPort).close() }
                catch (IOException e) {
                    event("StatusError", ["Server failed to start for port $args.httpsPort: $e.message"])
                    exit(1)
                }

                usingSecureServer = true
                server.startSecure args.host, args.httpPort, args.httpsPort

                // Update the message to reflect the fact we are running HTTPS as well.
                message += " or https://${args.host ?: 'localhost'}:${args.httpsPort}$serverContextPath"
            }
            else {
                server.start args.host, args.httpPort
            }
        }
        event("StatusFinal", [message])

        boolean isWindows = System.getProperty("os.name").toLowerCase().indexOf("windows") != -1
        if (isWindows) {
            grailsConsole.reader.addTriggeredAction((char)3, new ActionListener() {
                void actionPerformed(ActionEvent e) {
                    stopServer()
                    exit(0)
                }
            })
        }
    }
    catch (Throwable t) {
        if (t instanceof ScriptExitException) throw t
        GrailsUtil.deepSanitize(t)
        if (!(t instanceof SocketException) && !(t.cause instanceof SocketException)) {
            grailsConsole.error t
        }
        event("StatusError", ["Server failed to start: $t"])
        exit(1)
    }
}

/**
* Starts the plugin scanner. Call this after starting the server if you
* want changes to artifacts automatically detected and loaded.
*/
target(startPluginScanner: "Starts the plugin manager's scanner that detects changes to artifacts.") {
    new GrailsProjectWatcher(projectCompiler, pluginManager).start()
}

target(stopPluginScanner: "Stops the plugin manager's scanner that detects changes to artifacts.") {
    // do nothing, here for compatibility
}

/**
* Keeps the server alive and checks for changes in domain classes or
* source files under "src". If any changes are detected, the servlet
* container is restarted.
*/
target(watchContext: "Watches the WEB-INF/classes directory for changes and restarts the server if necessary") {
    depends(classpath)

    if (InteractiveMode.current) {
        Thread.start {
            def im = InteractiveMode.current
            im.grailsServer = grailsServer
            im.run()
        }
    }

    keepServerAlive()
}

target(keepServerAlive: "Idles the script, ensuring that the server stays running.") {
    def keepRunning = true
    def killFile = new File("${basedir}/.kill-run-app")
    if (killFile.exists()) {
        grailsConsole.warning ".kill-run-app file exists - perhaps a previous server stop didn't work?. Deleting and continuing anyway."
        killFile.delete()
    }

    while (keepRunning) {
        sleep(recompileFrequency * 1000)

        // Check whether the kill file exists. This is a hack for the
        // functional tests so that we can stop the servers that are
        // started.
        if (killFile.exists()) {
            grailsConsole.updateStatus "Stopping server..."
            grailsServer.stop()
            killFile.delete()
            keepRunning = false
        }
    }
}

target(stopServer: "Stops the Grails servlet container") {
    if (grailsServer) {
        try {
            grailsServer.stop()
        }
        catch (Throwable e) {
            grailsConsole.error "Error stopping server: ${e.message}", e
        }

        try {
            stopPluginScanner()
        }
        catch (Throwable e) {
            grailsConsole.error "Error stopping plugin change scanner: ${e.message}", e
        }
    }
    event("StatusFinal", ["Server stopped"])
}
Something went wrong with that request. Please try again.