<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[12839] CalendarServer/trunk/calendarserver/tap/cfgchild.py</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/12839">12839</a></dd>
<dt>Author</dt> <dd>sagen@apple.com</dd>
<dt>Date</dt> <dd>2014-03-07 09:52:36 -0800 (Fri, 07 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Unused module</pre>
<h3>Removed Paths</h3>
<ul>
<li><a href="#CalendarServertrunkcalendarservertapcfgchildpy">CalendarServer/trunk/calendarserver/tap/cfgchild.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunkcalendarservertapcfgchildpy"></a>
<div class="delfile"><h4>Deleted: CalendarServer/trunk/calendarserver/tap/cfgchild.py (12838 => 12839)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/calendarserver/tap/cfgchild.py 2014-03-07 17:52:13 UTC (rev 12838)
+++ CalendarServer/trunk/calendarserver/tap/cfgchild.py 2014-03-07 17:52:36 UTC (rev 12839)
</span><span class="lines">@@ -1,203 +0,0 @@
</span><del>-##
-# Copyright (c) 2005-2014 Apple Inc. All rights reserved.
-#
-# 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.
-##
-
-"""
-Tools for spawning general-purpose child processes that have a store derived
-from an existing configuration.
-"""
-
-__all__ = [
- # Only the spawner service is really interesting; the other parts are
- # internal implementation details which shouldn't be needed outside this
- # file.
- 'ConfiguredChildSpawner',
-]
-
-from calendarserver.tools.util import setupMemcached
-from twisted.python.reflect import namedAny, qual
-from twisted.internet.defer import inlineCallbacks, returnValue
-from twisted.protocols.amp import AMP, Command, String, Integer, Boolean
-from txdav.common.datastore.upgrade.migrate import (
- StoreSpawnerService, swapAMP
-)
-
-from calendarserver.tap.util import getDBPool, storeFromConfig
-
-class ConfigureChild(Command):
- """
- Configure a child process, most especially with all the information that it
- needs in order to construct a data store.
- """
-
- arguments = [
- # The name of the class to delegate to once configuration is complete.
- ("delegateTo", String()),
- ("pidFile", String()),
- ("logID", String()),
- ("configFile", String()),
-
- # computed value determined only in master, so needs to be propagated
- # to be correct.
- ("processCount", Integer()),
-
- ## only needed for request processing, and we're not using this
- ## facility for that work (yet)
- # ("inheritFDs", ListOf(Integer())),
- # ("inheritSSLFDs", ListOf(Integer())),
- # ("metaFD", String(optional=True)),
-
- ## shared connection pool!
- ("connectionPoolFD", Integer(optional=True)),
- ("withStore", Boolean()),
- ]
-
-
-
-class ChildConfigurator(AMP):
- """
- Protocol which can configure a child process.
- """
-
- def __init__(self, config=None):
- """
- Optionally accept a configuration for testing, but normally created in
- the subprocess configuration-free.
- """
- super(ChildConfigurator, self).__init__()
- if config is None:
- from twistedcaldav.config import config
- self.config = config
-
-
- @ConfigureChild.responder
- def conf(self, delegateTo, pidFile, logID, configFile, processCount,
- connectionPoolFD=None, withStore=True):
- """
- Load the current config file into this child process, create a store
- based on it, and delegate to the upgrade logic.
- """
- # Load the configuration file.
- self.config.load(configFile)
-
- # Adjust the child's configuration to add all the relevant options for
- # the store that won't be mentioned in the config file.
- changedConfig = dict(
- EnableCalDAV=True,
- EnableCardDAV=True,
- LogID=logID,
- PIDFile=pidFile,
- MultiProcess=dict(
- ProcessCount=processCount
- )
- )
- setupMemcached(self.config)
- if connectionPoolFD is not None:
- changedConfig.update(DBAMPFD=connectionPoolFD)
- self.config.updateDefaults(changedConfig)
-
- if withStore:
- # Construct and start database pool and store.
- pool, txnf = getDBPool(self.config)
- if pool is not None:
- from twisted.internet import reactor
- pool.startService()
- reactor.addSystemEventTrigger(
- "before", "shutdown", pool.stopService
- )
- delegateArg = storeFromConfig(self.config, txnf)
- else:
- delegateArg = self.config
- # Finally, construct the class we're supposed to delegate to.
- delegateClass = namedAny(delegateTo)
- swapAMP(self, delegateClass(delegateArg))
- return {}
-
-
-
-class ConfiguredChildSpawner(StoreSpawnerService):
- """
- L{StoreSpawnerService} that will load a full configuration into each child.
- """
-
- def __init__(self, maker, dispenser, config):
- """
- Create a L{ConfiguredChildSpawner}.
-
- @param maker: a L{CalDAVServiceMaker} instance that supplies the
- configuration.
-
- @param dispenser: a L{calendarserver.tap.ConnectionDispenser} or C{None}.
-
- @param config: the L{twistedcaldav.config.Config} to use to configure
- the subprocess.
- """
- super(ConfiguredChildSpawner, self).__init__()
- self.nextID = 0
- self.maker = maker
- self.dispenser = dispenser
- self.config = config
-
-
- def spawnWithConfig(self, config, here, there):
- """
- Spawn the child with a configuration.
- """
- return self._doSpawn(config, here, there, False)
-
-
- def spawnWithStore(self, here, there):
- """
- Spawn the child with a store based on a configuration.
- """
- return self._doSpawn(self.config, here, there, True)
-
-
- @inlineCallbacks
- def _doSpawn(self, config, here, there, withStore):
- """
- Common implementation of L{spawnWithStore} and L{spawnWithConfig}.
- """
- thisID = self.nextID
- self.nextID += 1
- if self.dispenser is not None:
- # NOTE: important and super subtle, 'poolskt' must not be GC'd
- # until the call to spawn (and hence spawnProcess) below; otherwise
- # that end of the socket will be closed and there will be nothing
- # to inherit.
- poolskt = self.dispenser.dispense()
- poolfd = poolskt.fileno()
- childFDs = {
- 0: "w", 1: "r", 2: "r", # behave like normal, but
- poolfd: poolfd # bonus FD
- }
- extra = dict(connectionPoolFD=poolfd)
- else:
- childFDs = None
- extra = {}
- controller = yield self.spawn(
- AMP(), ChildConfigurator, childFDs=childFDs
- )
- yield controller.callRemote(
- ConfigureChild,
- delegateTo=qual(there),
- pidFile="%s-migrator-%s" % (self.maker.tapname, thisID),
- logID="migrator-%s" % (thisID,),
- configFile=config.getProvider().getConfigFileName(),
- processCount=config.MultiProcess.ProcessCount,
- withStore=withStore,
- **extra
- )
- returnValue(swapAMP(controller, here))
</del></span></pre>
</div>
</div>
</body>
</html>