depot.py revision 612
20N/A# The contents of this file are subject to the terms of the 20N/A# Common Development and Distribution License (the "License"). 20N/A# You may not use this file except in compliance with the License. 20N/A# See the License for the specific language governing permissions 20N/A# and limitations under the License. 20N/A# When distributing Covered Code, include this CDDL HEADER in each 20N/A# If applicable, add the following below this CDDL HEADER, with the 20N/A# fields enclosed by brackets "[]" replaced with your own identifying 20N/A# information: Portions Copyright [yyyy] [name of copyright owner] 3053N/A# Copyright 2008 Sun Microsystems, Inc. All rights reserved. 20N/A# Use is subject to license terms. 3143N/A# pkg.depotd - package repository daemon 0N/A# XXX The prototype pkg.depotd combines both the version management server that 50N/A# answers to pkgsend(1) sessions and the HTTP file server that answers to the 50N/A# various GET operations that a pkg(1) client makes. This split is expected to 50N/A# be made more explicit, by constraining the pkg(1) operations such that they 50N/A# can be served as a typical HTTP/HTTPS session. Thus, pkg.depotd will reduce 50N/A# to a special purpose HTTP/HTTPS server explicitly for the version management 50N/A# operations, and must manipulate the various state files--catalogs, in 50N/A# particular--such that the pkg(1) pull client can operately accurately with 50N/A# XXX We should support simple "last-modified" operations via HEAD queries. 50N/A# XXX Although we pushed the evaluation of next-version, etc. to the pull 50N/A# client, we should probably provide a query API to do same on the server, for 50N/A# dumb clients (like a notification service). 589N/A# The default authority for the depot. 965N/A# The default repository path. 965N/A# The default path for static and other web content. 2951N/A# The default port to serve data from. 1836N/A# The minimum number of threads allowed. 812N/A# The default number of threads to start. 382N/A# The maximum number of threads that can be started. 1963N/A# The default server socket timeout in seconds. We want this to be longer than 382N/A# the normal default of 10 seconds to accommodate clients with poor quality 382N/A# Whether modify operations should be allowed. 382N/A# Whether the repository catalog should be rebuilt on startup. 26N/A# Whether the indexes should be rebuilt 689N/A# Not in mirror mode by default 3143N/A print """cherrypy 3.1.0 or greater (but less than 3.2.0) is """ \
3143N/A """required to use this program.""" 1968N/A """This is a dummy object that we can use to discard log entries 873N/A without relying on non-portable interfaces such as /dev/null.""" 873N/A """Discard the bits.""" 466N/A """Discard the bits.""" 466N/A [-t socket_timeout] [--content-root] [--log-access dest] 466N/A [--log-errors dest] [--mirror] [--proxy-base url] [--readonly] 1633N/A --content-root The file system path to the directory containing the 1633N/A the static and other web content used by the depot's 1633N/A browser user interface. The default value is 466N/A --log-access The destination for any access related information 466N/A logged by the depot process. Possible values are: 466N/A stderr, stdout, none, or an absolute pathname. The 1633N/A default value is stdout if stdout is a tty; otherwise 1633N/A --log-errors The destination for any errors or other information 1633N/A logged by the depot process. Possible values are: 1633N/A stderr, stdout, none, or an absolute pathname. The 3143N/A --mirror Package mirror mode; publishing and metadata operations 2230N/A disallowed. Cannot be used with --readonly or 1633N/A --proxy-base The url to use as the base for generating internal 2816N/A --readonly Read-only operation; modifying operations disallowed. 2816N/A Cannot be used with --mirror or --rebuild. 1937N/A --rebuild Re-build the catalog from pkgs in depot. Cannot be 382N/A used with --mirror or --readonly. 2515N/A # By default, if the destination for a particular log type is not 466N/A # specified, this is where we will send the output. 466N/A # If stdout is a tty, then send access output there by default instead 1191N/A "readonly",
"rebuild",
"refresh-index"]
1633N/A "You must specify a log " \
3143N/A # Attempt to decompose the url provided into 1633N/A # its base parts. This is done so we can 14N/A # remove any scheme information since we 30N/A # Rebuild the url without the scheme and 382N/A # remove the leading // urlunparse adds. 1968N/A # Note: This argument is for internal use 1191N/A # only. It's used when pkg.depotd is reexecing 258N/A # itself and needs to know that's the case. 1968N/A # This flag is purposefully omitted in usage. 2816N/A # The supported way to forcefully reindex is to 382N/A # kill any pkg.depot using that directory, 1968N/A # remove the index directory, and restart the 30N/A # pkg.depot process. The index will be rebuilt 589N/A # automatically on startup. 1968N/A usage(
"pkg.depotd: illegal option value: %s specified " \
466N/A usage(
"--refresh-index cannot be used with --rebuild")
1968N/A usage(
"--readonly and --mirror cannot be used with --rebuild")
1431N/A usage(
"--readonly and --mirror cannot be used with " \
54N/A # If the program is going to reindex, the port is irrelevant since 1968N/A # the program will not bind to a port. 2816N/A print "pkg.depotd: unable to bind to the specified " \
2230N/A # Not applicable for reindexing operations. 382N/A print "pkg.depotd: an error occurred while trying to " \
382N/A "initialize the depot repository directory " \
382N/A # Setup our global configuration. 1968N/A # Global cherrypy configuration 1542N/A "environment":
"production",
812N/A "server.socket_host":
"0.0.0.0",
858N/A "param":
"log.error_file",
858N/A "param":
"log.access_file",
1431N/A # Since we've replaced cherrypy's log handler with our 1431N/A # own, we don't want the output directed to a file. 1431N/A # Now that our logging, etc. has been setup, it's safe to perform any 2515N/A # Now build our site configuration. 1968N/A # We have to override cherrypy's default response_class so that 1633N/A # we have access to the write() callable to stream data 2816N/A # This changes the base URL for our server, and is primarily 2816N/A # intended to allow our depot process to operate behind Apache 2816N/A # or some other webserver process. 589N/A # Visit the following URL for more information: 589N/A "tools.proxy.local":
"",
765N/A # Now merge or add our proxy configuration information into the 765N/A # existing configuration. 382N/A usage(
"pkg.depotd: unknown error starting depot, illegal " \
429N/A "option value specified?")