#!/usr/bin/python2.7

#

# 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 (c) 2007, 2015, Oracle and/or its affiliates. All rights reserved.

#

from __future__ import print_function

# 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 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 path for static and other web content.

CONTENT_PATH_DEFAULT = "/usr/share/lib/pkg"

# cherrypy has a max_request_body_size parameter that determines whether the

# server should abort requests with REQUEST_ENTITY_TOO_LARGE when the request

# body is larger than the specified size (in bytes).  The maximum size supported

# by cherrypy is 2048 * 1024 * 1024 - 1 (just short of 2048MB), but the default

# here is purposefully conservative.

MAX_REQUEST_BODY_SIZE = 512 * 1024 * 1024

# The default host/port(s) to serve data from.

HOST_DEFAULT = "0.0.0.0"

PORT_DEFAULT = 80

SSL_PORT_DEFAULT = 443

# The minimum number of threads allowed.

THREADS_MIN = 1

# The default number of threads to start.

THREADS_DEFAULT = 60

# The maximum number of threads that can be started.

THREADS_MAX = 5000

# 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

import getopt

import gettext

import locale

import logging

import os

import os.path

import OpenSSL.crypto as crypto

import shlex

import subprocess

import sys

import tempfile

from imp import reload

from six.moves.urllib.parse import urlparse, urlunparse

try:

        import cherrypy

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

        # comparison requires same type, therefore list conversion is needed

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

                raise ImportError

except ImportError:

        sys.exit(2)

import cherrypy.process.servers

from cherrypy.process.plugins import Daemonizer

from pkg.misc import msg, emsg, setlocale

from pkg.client.debugvalues import DebugValues

import pkg

import pkg.client.api_errors as api_errors

import pkg.config as cfg

import pkg.portable.util as os_util

import pkg.search_errors as search_errors

import pkg.server.depot as ds

import pkg.server.repository as sr

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=None, retcode=2, full=False):

        """Optionally emit a usage message and then exit using the specified

        exit code."""

        if text:

                emsg(text)

        if not full:

                # The full usage message isn't desired.

                emsg(_("Try `pkg.depotd --help or -?' for more "

                    "information."))

                sys.exit(retcode)

        print("""\

Usage: /usr/lib/pkg.depotd [-a address] [-d inst_root] [-p port] [-s threads]

           [-t socket_timeout] [--cfg] [--content-root]

           [--disable-ops op[/1][,...]] [--debug feature_list]

           [--image-root dir] [--log-access dest] [--log-errors dest]

           [--mirror] [--nasty] [--nasty-sleep] [--proxy-base url]

           [--readonly] [--ssl-cert-file] [--ssl-dialog] [--ssl-key-file]

           [--sort-file-max-size size] [--writable-root dir]

        -a address      The IP address on which to listen for connections.  The

                        default value is 0.0.0.0 (INADDR_ANY) which will listen

                        on all active interfaces.  To listen on all active IPv6

                        interfaces, use '::'.

        -d inst_root    The file system path at which the server should find its

                        repository data.  Required unless PKG_REPO has been set

                        in the environment.

        -p port         The port number on which the instance should listen for

                        incoming package requests.  The default value is 80 if

                        ssl certificate and key information has not been

                        provided; otherwise, the default value is 443.

        -s threads      The number of threads that will be started to serve

                        requests.  The default value is 10.

        -t timeout      The maximum number of seconds the server should wait for

                        a response from a client before closing a connection.

                        The default value is 60.

        --cfg           The pathname of the file to use when reading and writing

                        depot configuration data, or a fully qualified service

                        fault management resource identifier (FMRI) of the SMF

                        service or instance to read configuration data from.

        --content-root  The file system path to the directory containing the

                        the static and other web content used by the depot's

                        browser user interface.  The default value is

                        '/usr/share/lib/pkg'.

        --disable-ops   A comma separated list of operations that the depot

                        should not configure.  If, for example, you wanted

                        to omit loading search v1, 'search/1' should be

                        provided as an argument, or to disable all search

                        operations, simply 'search'.

        --debug         The name of a debug feature to enable; or a whitespace

                        or comma separated list of features to enable.

                        Possible values are: headers, hash=sha1+sha256,

                        hash=sha256, hash=sha1+sha512_256, hash=sha512_256

        --image-root    The path to the image whose file information will be

                        used as a cache for file data.

        --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.

        --mirror        Package mirror mode; publishing and metadata operations

                        disallowed.  Cannot be used with --readonly or

                        --rebuild.

        --nasty         Instruct the server to misbehave.  At random intervals

                        it will time-out, send bad responses, hang up on

                        clients, and generally be hostile.  The option

                        takes a value (1 to 100) for how nasty the server

                        should be.

        --nasty-sleep   In nasty mode (see --nasty), how many seconds to

                        randomly sleep when a random sleep occurs.

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

                        redirects and content.

        --readonly      Read-only operation; modifying operations disallowed.

                        Cannot be used with --mirror or --rebuild.

        --ssl-cert-file The absolute pathname to a PEM-encoded Certificate file.

                        This option must be used with --ssl-key-file.  Usage of

                        this option will cause the depot to only respond to SSL

                        requests on the provided port.

        --ssl-dialog    Specifies what method should be used to obtain the

                        passphrase needed to decrypt the file specified by

                        --ssl-key-file.  Supported values are: builtin,

                        exec:/path/to/program, smf, or an SMF FMRI.  The

                        default value is builtin.  If smf is specified, an

                        SMF FMRI must be provided using the --cfg option.

        --ssl-key-file  The absolute pathname to a PEM-encoded Private Key file.

                        This option must be used with --ssl-cert-file.  Usage of

                        this option will cause the depot to only respond to SSL

                        requests on the provided port.

        --sort-file-max-size

                        The maximum size of the indexer sort file. Used to

                        limit the amount of RAM the depot uses for indexing,

                        or increase it for speed.

        --writable-root The path to a directory to which the program has write

                        access.  Used with --readonly to allow server to

                        create needed files, such as search indices, without

                        needing write access to the package information.

Options:

        --help or -?

Environment:

        PKG_REPO                Used as default inst_root if -d not provided.

        PKG_DEPOT_CONTENT       Used as default content_root if --content-root

                                not provided.""")

        sys.exit(retcode)

class OptionError(Exception):

        """Option exception. """

        def __init__(self, *args):

                Exception.__init__(self, *args)

if __name__ == "__main__":

        setlocale(locale.LC_ALL, "")

        gettext.install("pkg", "/usr/share/locale",

            codeset=locale.getpreferredencoding())

        add_content = False

        exit_ready = False

        rebuild = False

        reindex = False

        nasty = False

        # Track initial configuration values.

        ivalues = { "pkg": {}, "nasty": {} }

        if "PKG_REPO" in os.environ:

                ivalues["pkg"]["inst_root"] = os.environ["PKG_REPO"]

        try:

                content_root = os.environ["PKG_DEPOT_CONTENT"]

                ivalues["pkg"]["content_root"] = content_root

        except KeyError:

                try:

                        content_root = os.path.join(os.environ['PKG_HOME'],

                            'share/lib/pkg')

                        ivalues["pkg"]["content_root"] = content_root

                except KeyError:

                        pass

        opt = None

        addresses = set()

        debug_features = []

        disable_ops = []

        repo_props = {}

        socket_path = ""

        user_cfg = None

        try:

                long_opts = ["add-content", "cfg=", "cfg-file=",

                    "content-root=", "debug=", "disable-ops=", "exit-ready",

                    "help", "image-root=", "log-access=", "log-errors=",

                    "llmirror", "mirror", "nasty=", "nasty-sleep=",

                    "proxy-base=", "readonly", "rebuild", "refresh-index",

                    "set-property=", "ssl-cert-file=", "ssl-dialog=",

                    "ssl-key-file=", "sort-file-max-size=", "writable-root="]

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

                    long_opts)

                show_usage = False

                for opt, arg in opts:

                        if opt == "-a":

                                addresses.add(arg)

                        elif opt == "-n":

                                sys.exit(0)

                        elif opt == "-d":

                                ivalues["pkg"]["inst_root"] = arg

                        elif opt == "-p":

                                ivalues["pkg"]["port"] = arg

                        elif opt == "-s":

                                threads = int(arg)

                                if threads < THREADS_MIN:

                                        raise OptionError(

                                            "minimum value is {0:d}".format(

                                            THREADS_MIN))

                                if threads > THREADS_MAX:

                                        raise OptionError(

                                            "maximum value is {0:d}".format(

                                            THREADS_MAX))

                                ivalues["pkg"]["threads"] = threads

                        elif opt == "-t":

                                ivalues["pkg"]["socket_timeout"] = arg

                        elif opt == "--add-content":

                                add_content = True

                        elif opt == "--cfg":

                                user_cfg  = arg

                        elif opt == "--cfg-file":

                                ivalues["pkg"]["cfg_file"] = arg

                        elif opt == "--content-root":

                                ivalues["pkg"]["content_root"] = arg

                        elif opt == "--debug":

                                if arg is None or arg == "":

                                        continue

                                # A list of features can be specified using a

                                # "," or any whitespace character as separators.

                                if "," in arg:

                                        features = arg.split(",")

                                else:

                                        features = arg.split()

                                debug_features.extend(features)

                                # We also allow key=value debug flags, which

                                # get set in pkg.client.debugvalues

                                for feature in features:

                                        try:

                                                key, val = feature.split("=", 1)

                                                DebugValues.set_value(key, val)

                                        except (AttributeError, ValueError):

                                                pass

                        elif opt == "--disable-ops":

                                if arg is None or arg == "":

                                        raise OptionError(

                                            "An argument must be specified.")

                                disableops = arg.split(",")

                                for s in disableops:

                                        if "/" in s:

                                                op, ver = s.rsplit("/", 1)

                                        else:

                                                op = s

                                                ver = "*"

                                        if op not in \

                                            ds.DepotHTTP.REPO_OPS_DEFAULT:

                                                raise OptionError(

                                                    "Invalid operation "

                                                    "'{0}'.".format(s))

                                        disable_ops.append(s)

                        elif opt == "--exit-ready":

                                exit_ready = True

                        elif opt == "--image-root":

                                ivalues["pkg"]["image_root"] = arg

                        elif opt.startswith("--log-"):

                                prop = "log_{0}".format(opt.lstrip("--log-"))

                                ivalues["pkg"][prop] = arg

                        elif opt in ("--help", "-?"):

                                show_usage = True

                        elif opt == "--mirror":

                                ivalues["pkg"]["mirror"] = True

                        elif opt == "--llmirror":

                                ivalues["pkg"]["mirror"] = True

                                ivalues["pkg"]["ll_mirror"] = True

                                ivalues["pkg"]["readonly"] = True

                        elif opt == "--nasty":

                                # ValueError is caught by caller.

                                nasty_value = int(arg)

                                if (nasty_value > 100 or nasty_value < 1):

                                        raise OptionError("Invalid value "

                                            "for nasty option.\n Please "

                                            "choose a value between 1 and 100.")

                                nasty = True

                                ivalues["nasty"]["nasty_level"] = nasty_value

                        elif opt == "--nasty-sleep":

                                # ValueError is caught by caller.

                                sleep_value = int(arg)

                                ivalues["nasty"]["nasty_sleep"] = sleep_value

                        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(arg,

                                    "http", allow_fragments=0)

                                if not netloc:

                                        raise OptionError("Unable to "

                                            "determine the hostname from "

                                            "the provided URL; please use a "

                                            "fully qualified URL.")

                                scheme = scheme.lower()

                                if scheme not in ("http", "https"):

                                        raise OptionError("Invalid URL; http "

                                            "and https are the only supported "

                                            "schemes.")

                                # Rebuild the url with the sanitized components.

                                ivalues["pkg"]["proxy_base"] = \

                                    urlunparse((scheme, netloc, path,

                                    params, query, fragment))

                        elif opt == "--readonly":

                                ivalues["pkg"]["readonly"] = True

                        elif opt == "--rebuild":

                                rebuild = True

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

                                # Note: This argument is for internal use

                                # only.

                                #

                                # 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

                                exit_ready = True

                        elif opt == "--set-property":

                                try:

                                        prop, p_value = arg.split("=", 1)

                                        p_sec, p_name = prop.split(".", 1)

                                except ValueError:

                                        usage(_("property arguments must be of "

                                            "the form '<section.property>="

                                            "<value>'."))

                                repo_props.setdefault(p_sec, {})

                                repo_props[p_sec][p_name] = p_value

                        elif opt == "--ssl-cert-file":

                                if arg == "none" or arg == "":

                                        # Assume this is an override to clear

                                        # the value.

                                        arg = ""

                                elif not os.path.isabs(arg):

                                        raise OptionError("The path to "

                                           "the Certificate file must be "

                                           "absolute.")

                                elif not os.path.exists(arg):

                                        raise OptionError("The specified "

                                            "file does not exist.")

                                elif not os.path.isfile(arg):

                                        raise OptionError("The specified "

                                            "pathname is not a file.")

                                ivalues["pkg"]["ssl_cert_file"] = arg

                        elif opt == "--ssl-key-file":

                                if arg == "none" or arg == "":

                                        # Assume this is an override to clear

                                        # the value.

                                        arg = ""

                                elif not os.path.isabs(arg):

                                        raise OptionError("The path to "

                                           "the Private Key file must be "

                                           "absolute.")

                                elif not os.path.exists(arg):

                                        raise OptionError("The specified "

                                            "file does not exist.")

                                elif not os.path.isfile(arg):

                                        raise OptionError("The specified "

                                            "pathname is not a file.")

                                ivalues["pkg"]["ssl_key_file"] = arg