#!/usr/bin/python2.4

#

# CDDL HEADER START

#

# The contents of this file are subject to the terms of the

# Common Development and Distribution License (the "License").

# You may not use this file except in compliance with the License.

#

# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE

# or http://www.opensolaris.org/os/licensing.

# See the License for the specific language governing permissions

# and limitations under the License.

#

# When distributing Covered Code, include this CDDL HEADER in each

# file and include the License file at usr/src/OPENSOLARIS.LICENSE.

# If applicable, add the following below this CDDL HEADER, with the

# fields enclosed by brackets "[]" replaced with your own identifying

# information: Portions Copyright [yyyy] [name of copyright owner]

#

# CDDL HEADER END

#

# Copyright 2008 Sun Microsystems, Inc.  All rights reserved.

# Use is subject to license terms.

#

# pkg.depotd - package repository daemon

# XXX The prototype pkg.depotd combines both the version management server that

# answers to pkgsend(1) sessions and the HTTP file server that answers to the

# various GET operations that a pkg(1) client makes.  This split is expected to

# be made more explicit, by constraining the pkg(1) operations such that they

# can be served as a typical HTTP/HTTPS session.  Thus, pkg.depotd will reduce

# to a special purpose HTTP/HTTPS server explicitly for the version management

# operations, and must manipulate the various state files--catalogs, in

# particular--such that the pkg(1) pull client can operately accurately with

# only a basic HTTP/HTTPS server in place.

# XXX We should support simple "last-modified" operations via HEAD queries.

# XXX Although we pushed the evaluation of next-version, etc. to the pull

# client, we should probably provide a query API to do same on the server, for

# dumb clients (like a notification service).

# The default authority for the depot.

AUTH_DEFAULT = "opensolaris.org"

# The default repository path.

REPO_PATH_DEFAULT = "/var/pkg/repo"

# The default port to serve data from.

PORT_DEFAULT = 80

# The minimum number of threads allowed.

THREADS_MIN = 1

# The default number of threads to start.

THREADS_DEFAULT = 10

# The maximum number of threads that can be started.

THREADS_MAX = 100

# The default server socket timeout in seconds. We want this to be longer than

# the normal default of 10 seconds to accommodate clients with poor quality

# connections.

SOCKET_TIMEOUT_DEFAULT = 60

# Whether modify operations should be allowed.

READONLY_DEFAULT = False

# Whether the repository catalog should be rebuilt on startup.

REBUILD_DEFAULT = False

# Whether the indexes should be rebuilt

REINDEX_DEFAULT = False

# Not in mirror mode by default

MIRROR_DEFAULT = False

import getopt

import logging

import os

import sys

import urlparse

try:

        import cherrypy

        version = cherrypy.__version__.split('.')

        if map(int, version) < [3, 1, 0]:

                raise ImportError

        elif map(int, version) >= [3, 2, 0]:

                raise ImportError

except ImportError:

        print """cherrypy 3.1.0 or greater (but less than 3.2.0) is """ \

            """required to use this program."""

        sys.exit(2)

import pkg.server.face as face

import pkg.server.config as config

import pkg.server.depot as depot

import pkg.server.repository as repo

import pkg.server.repositoryconfig as rc

from pkg.misc import port_available, msg, emsg

class LogSink(object):

        """This is a dummy object that we can use to discard log entries

        without relying on non-portable interfaces such as /dev/null."""

        def write(self, *args, **kwargs):

                """Discard the bits."""

                pass

        def flush(self, *args, **kwargs):

                """Discard the bits."""

                pass

def usage(text):

        if text:

                emsg(text)

        print """\

Usage: /usr/lib/pkg.depotd [--readonly] [--rebuild] [--mirror] [--proxy-base url]

           [--log-access dest] [--log-errors dest] [-d repo_dir] [-p port]

           [-s threads] [-t socket_timeout]

        --readonly      Read-only operation; modifying operations disallowed

        --rebuild       Re-build the catalog from pkgs in depot

                        Cannot be used with --readonly or --mirror

        --mirror        Content mirror mode. Publishing and metadata operations

                        disabled

        --proxy-base    The url to use as the base for generating internal

                        redirects and content.

        --log-access    The destination for any access related information

                        logged by the depot process.  Possible values are:

                        stderr, stdout, none, or an absolute pathname.  The

                        default value is stdout if stdout is a tty; otherwise

                        the default value is none.

        --log-errors    The destination for any errors or other information

                        logged by the depot process.  Possible values are:

                        stderr, stdout, none, or an absolute pathname.  The

                        default value is stderr.

"""

        sys.exit(2)

class OptionError(Exception):

        """Option exception. """

        def __init__(self, *args):

                Exception.__init__(self, *args)

if __name__ == "__main__":

        port = PORT_DEFAULT

        threads = THREADS_DEFAULT

        socket_timeout = SOCKET_TIMEOUT_DEFAULT

        readonly = READONLY_DEFAULT

        rebuild = REBUILD_DEFAULT

        reindex = REINDEX_DEFAULT

        proxy_base = None

        mirror = MIRROR_DEFAULT

        if "PKG_REPO" in os.environ:

                repo_path = os.environ["PKG_REPO"]

        else:

                repo_path = REPO_PATH_DEFAULT

        # By default, if the destination for a particular log type is not

        # specified, this is where we will send the output.

        log_routes = {

            "access": "none",

            "errors": "stderr"

        }

        log_opts = ["--log-%s" % log_type for log_type in log_routes]

        # If stdout is a tty, then send access output there by default instead

        # of discarding it.

        if os.isatty(sys.stdout.fileno()):

                log_routes["access"] = "stdout"

        opt = None

        try:

                long_opts = ["readonly", "rebuild", "mirror", "refresh-index",

                    "proxy-base="]

                for opt in log_opts:

                        long_opts.append("%s=" % opt.lstrip('--'))

                opts, pargs = getopt.getopt(sys.argv[1:], "d:np:s:t:",

                    long_opts)

                for opt, arg in opts:

                        if opt == "-n":

                                sys.exit(0)

                        elif opt == "-d":

                                repo_path = arg

                        elif opt == "-p":

                                port = int(arg)

                        elif opt == "-s":

                                threads = int(arg)

                                if threads < THREADS_MIN:

                                        raise OptionError, \

                                            "minimum value is %d" % THREADS_MIN

                                if threads > THREADS_MAX:

                                        raise OptionError, \

                                            "maximum value is %d" % THREADS_MAX

                        elif opt == "-t":

                                socket_timeout = int(arg)

                        elif opt in log_opts:

                                if arg is None or arg == "":

                                        raise OptionError, \

                                            "You must specify a log " \

                                            "destination."

                                log_routes[opt.lstrip("--log-")] = arg

                        elif opt == "--readonly":

                                readonly = True

                        elif opt == "--rebuild":

                                rebuild = True

                        elif opt == "--refresh-index":

                                # Note: This argument is for internal use

                                # only. It's used when pkg.depotd is reexecing

                                # itself and needs to know that's the case.

                                # This flag is purposefully omitted in usage.

                                # The supported way to forcefully reindex is to

                                # kill any pkg.depot using that directory,

                                # remove the index directory, and restart the

                                # pkg.depot process. The index will be rebuilt

                                # automatically on startup.

                                reindex = True

                        elif opt == "--proxy-base":

                                # Attempt to decompose the url provided into

                                # its base parts.  This is done so we can

                                # remove any scheme information since we

                                # don't need it.

                                scheme, netloc, path, params, query, \

                                    fragment = urlparse.urlparse(arg,

                                    allow_fragments=0)

                                # Rebuild the url without the scheme and

                                # remove the leading // urlunparse adds.

                                proxy_base = urlparse.urlunparse(("", netloc,

                                    path, params, query, fragment)

                                    ).lstrip("//")

                        elif opt == "--mirror":

                                mirror = True

        except getopt.GetoptError, e:

                usage("pkg.depotd: %s" % e.msg)

        except OptionError, e:

                usage("pkg.depotd: option: %s -- %s" % (opt, e))

        except (ArithmeticError, ValueError):

                usage("pkg.depotd: illegal option value: %s specified " \

                    "for option: %s" % (arg, opt))

        if rebuild and reindex:

                usage("--refresh-index cannot be used with --rebuild")

        if rebuild and (readonly or mirror):

                usage("--readonly and --mirror cannot be used with --rebuild")

        if reindex and (readonly or mirror):

                usage("--readonly and --mirror cannot be used with " \

                    "--refresh-index")

        # If the program is going to reindex, the port is irrelevant since

        # the program will not bind to a port.

        if not reindex:

                available, msg = port_available(None, port)

                if not available:

                        print "pkg.depotd: unable to bind to the specified " \

                            "port: %d. Reason: %s" % (port, msg)

                        sys.exit(1)

        try:

                face.set_content_root(os.environ["PKG_DEPOT_CONTENT"])

        except KeyError:

                pass

        if rebuild:

                scfg.destroy_catalog()

        if readonly:

                scfg.set_read_only()

        if mirror:

                scfg.set_mirror()

        try:

                scfg.init_dirs()

        except EnvironmentError, e:

                print "pkg.depotd: an error occurred while trying to " \

                    "initialize the depot repository directory " \

                    "structures:\n%s" % e

                sys.exit(1)

        # Setup our global configuration.

        # Global cherrypy configuration

        gconf = {

            "environment": "production",

            "checker.on": True,

            "log.screen": False,

            "server.socket_host": "0.0.0.0",

            "server.socket_port": port,

            "server.thread_pool": threads,

            "server.socket_timeout": socket_timeout,

            "tools.log_headers.on": True

        }

        log_type_map = {

            "errors": {

                "param": "log.error_file",

                "attr": "error_log"

            },

            "access": {

                "param": "log.access_file",

                "attr": "access_log"

            }

        }

        for log_type in log_type_map:

                dest = log_routes[log_type]

                if dest in ("stdout", "stderr", "none"):

                        if dest == "none":

                                h = logging.StreamHandler(LogSink())

                        else:

                                h = logging.StreamHandler(eval("sys.%s" % \

                                    dest))

                        h.setLevel(logging.DEBUG)

                        h.setFormatter(cherrypy._cplogging.logfmt)

                        log_obj = eval("cherrypy.log.%s" % \

                            log_type_map[log_type]["attr"])

                        log_obj.addHandler(h)

                        # Since we've replaced cherrypy's log handler with our

                        # own, we don't want the output directed to a file.

                        dest = ""

                gconf[log_type_map[log_type]["param"]] = dest

        # Now build our site configuration.

        conf = {

            "/": {

                # We have to override cherrypy's default response_class so that

                # we have access to the write() callable to stream data

                # directly to the client.

                "wsgi.response_class": depot.DepotResponse,

            },

            "/robots.txt": {

                "tools.staticfile.on": True,

                "tools.staticfile.filename": os.path.join(face.content_root,

                    "robots.txt")

            },

            "/static": {

                "tools.staticdir.on": True,

                "tools.staticdir.root": face.content_root,

                "tools.staticdir.dir": ""

            }

        }

        if proxy_base:

                # This changes the base URL for our server, and is primarily

                # intended to allow our depot process to operate behind Apache

                # or some other webserver process.

                #

                # Visit the following URL for more information:

                #    http://cherrypy.org/wiki/BuiltinTools#tools.proxy

                proxy_conf = {

                        "tools.proxy.on": True,

                        "tools.proxy.local": "",

                        "tools.proxy.base": proxy_base

                }

                if "/" not in conf:

                        conf["/"] = {}

                # Now merge or add our proxy configuration information into the

                # existing configuration.

                for entry in proxy_conf:

                        conf["/"][entry] = proxy_conf[entry]

        cherrypy.config.update(gconf)

        # Now that our logging, etc. has been setup, it's safe to perform any

        # remaining preparation.

        if reindex:

                scfg.acquire_catalog(rebuild=False)

                scfg.catalog.run_update_index()

                sys.exit(0)

        scfg.acquire_in_flight()

        scfg.acquire_catalog()

        try:

                root = cherrypy.Application(repo.Repository(scfg))

        except rc.InvalidAttributeValueError, e:

                emsg("pkg.depotd: repository.conf error: %s" % e)

                sys.exit(1)

        try:

                cherrypy.quickstart(root, config=conf)

        except:

                usage("pkg.depotd: unknown error starting depot, illegal " \

                    "option value specified?")