20N/A

0N/A

50N/A

50N/A

382N/AREPO_PATH_DEFAULT = "/var/pkg/repo"

589N/ACONTENT_PATH_DEFAULT = "/usr/share/lib/pkg"

965N/AMAX_REQUEST_BODY_SIZE = 128 * 1024 * 1024

382N/APORT_DEFAULT = 80

812N/ASSL_PORT_DEFAULT = 443

382N/ATHREADS_MIN = 1

382N/ATHREADS_DEFAULT = 10

1433N/ATHREADS_MAX = 500

382N/ASOCKET_TIMEOUT_DEFAULT = 60

382N/AREADONLY_DEFAULT = False

382N/AREBUILD_DEFAULT = False

429N/AREINDEX_DEFAULT = False

461N/AMIRROR_DEFAULT = False

382N/A

26N/Aimport getopt

689N/Aimport gettext

689N/Aimport locale

466N/Aimport logging

0N/Aimport os

468N/Aimport os.path

812N/Aimport OpenSSL.crypto as crypto

812N/Aimport subprocess

52N/Aimport sys

812N/Aimport tempfile

451N/Aimport urlparse

0N/A

382N/Atry:

382N/A import cherrypy

382N/A version = cherrypy.__version__.split('.')

452N/A if map(int, version) < [3, 1, 0]:

382N/A raise ImportError

452N/A elif map(int, version) >= [3, 2, 0]:

382N/A raise ImportError

382N/Aexcept ImportError:

751N/A print >> sys.stderr, """cherrypy 3.1.0 or greater (but less than """ \

751N/A """3.2.0) is required to use this program."""

382N/A sys.exit(2)

22N/A

812N/Afrom pkg.misc import port_available, msg, emsg, setlocale

1431N/Aimport pkg.client.api_errors as api_errors

1477N/Aimport pkg.indexer as indexer

873N/Aimport pkg.portable.util as os_util

812N/Aimport pkg.search_errors as search_errors

1431N/Aimport pkg.server.depot as ds

873N/Aimport pkg.server.depotresponse as dr

1431N/Aimport pkg.server.repository as sr

428N/Aimport pkg.server.repositoryconfig as rc

466N/A

1431N/A

466N/Aclass LogSink(object):

466N/A """This is a dummy object that we can use to discard log entries

23N/A

466N/A def write(self, *args, **kwargs):

466N/A """Discard the bits."""

466N/A pass

466N/A

466N/A def flush(self, *args, **kwargs):

466N/A """Discard the bits."""

466N/A pass

466N/A

1431N/A

466N/Adef usage(text):

466N/A if text:

466N/A emsg(text)

466N/A

26N/A print """\

135N/A sys.exit(2)

14N/A

382N/Aclass OptionError(Exception):

429N/A """Option exception. """

14N/A

404N/A def __init__(self, *args):

404N/A Exception.__init__(self, *args)

30N/A

382N/Aif __name__ == "__main__":

30N/A

791N/A setlocale(locale.LC_ALL, "")

689N/A gettext.install("pkg", "/usr/share/locale")

689N/A

858N/A debug_features = {

858N/A "headers": False,

858N/A }

1431N/A disable_ops = {}

382N/A port = PORT_DEFAULT

812N/A port_provided = False

382N/A threads = THREADS_DEFAULT

382N/A socket_timeout = SOCKET_TIMEOUT_DEFAULT

382N/A readonly = READONLY_DEFAULT

382N/A rebuild = REBUILD_DEFAULT

429N/A reindex = REINDEX_DEFAULT

451N/A proxy_base = None

461N/A mirror = MIRROR_DEFAULT

1191N/A nasty = False

1191N/A nasty_value = 0

797N/A repo_config_file = None

1477N/A sort_file_max_size = indexer.SORT_FILE_MAX_SIZE

812N/A ssl_cert_file = None

812N/A ssl_key_file = None

812N/A ssl_dialog = "builtin"

975N/A writable_root = None

258N/A

382N/A if "PKG_REPO" in os.environ:

382N/A repo_path = os.environ["PKG_REPO"]

382N/A else:

382N/A repo_path = REPO_PATH_DEFAULT

30N/A

589N/A try:

589N/A content_root = os.environ["PKG_DEPOT_CONTENT"]

589N/A except KeyError:

589N/A try:

589N/A content_root = os.path.join(os.environ['PKG_HOME'],

589N/A 'share/lib/pkg')

589N/A except KeyError:

589N/A content_root = CONTENT_PATH_DEFAULT

589N/A

466N/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 log_routes = {

466N/A "access": "none",

466N/A "errors": "stderr"

466N/A }

466N/A log_opts = ["--log-%s" % log_type for log_type in log_routes]

466N/A

466N/A # If stdout is a tty, then send access output there by default instead

466N/A # of discarding it.

466N/A if os.isatty(sys.stdout.fileno()):

466N/A log_routes["access"] = "stdout"

466N/A

466N/A opt = None

1431N/A repo_props = {}

54N/A try:

1431N/A long_opts = ["cfg-file=", "content-root=", "debug=",

1431N/A "disable-ops=", "mirror", "nasty=", "set-property=",

1431N/A "proxy-base=", "readonly", "rebuild", "refresh-index",

1431N/A "ssl-cert-file=", "ssl-dialog=", "ssl-key-file=",

1475N/A "sort-file-max-size=", "writable-root="]

1475N/A

466N/A for opt in log_opts:

466N/A long_opts.append("%s=" % opt.lstrip('--'))

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

466N/A long_opts)

135N/A for opt, arg in opts:

135N/A if opt == "-n":

135N/A sys.exit(0)

135N/A elif opt == "-d":

382N/A repo_path = arg

135N/A elif opt == "-p":

135N/A port = int(arg)

812N/A port_provided = True

382N/A elif opt == "-s":

382N/A threads = int(arg)

382N/A if threads < THREADS_MIN:

382N/A raise OptionError, \

382N/A "minimum value is %d" % THREADS_MIN

382N/A if threads > THREADS_MAX:

382N/A raise OptionError, \

382N/A "maximum value is %d" % THREADS_MAX

382N/A elif opt == "-t":

382N/A socket_timeout = int(arg)

812N/A elif opt == "--cfg-file":

812N/A repo_config_file = os.path.abspath(arg)

589N/A elif opt == "--content-root":

589N/A if arg == "":

589N/A raise OptionError, "You must specify " \

589N/A "a directory path."

589N/A content_root = arg

858N/A elif opt == "--debug":

858N/A if arg is None or arg == "":

858N/A raise OptionError, \

858N/A "A debug feature must be specified."

858N/A

858N/A # A list of features can be specified using a

858N/A # "," or any whitespace character as separators.

858N/A if "," in arg:

858N/A features = arg.split(",")

858N/A else:

858N/A features = arg.split()

858N/A

858N/A for f in features:

858N/A if f not in debug_features:

858N/A raise OptionError, \

858N/A "Invalid debug feature: " \

858N/A "%s." % f

858N/A debug_features[f] = True

1431N/A elif opt == "--disable-ops":

1431N/A if arg is None or arg == "":

1431N/A raise OptionError, \

1431N/A "An argument must be specified."

1431N/A

1431N/A disableops = arg.split(",")

1431N/A for s in disableops:

1431N/A if "/" in s:

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

1431N/A else:

1431N/A op = s

1431N/A ver = "*"

1431N/A

1431N/A if op not in \

1431N/A ds.DepotHTTP.REPO_OPS_DEFAULT:

1431N/A raise OptionError(

1431N/A "Invalid operation "

1431N/A "'%s'." % s)

1431N/A

1431N/A disable_ops.setdefault(op, [])

1431N/A disable_ops[op].append(ver)

466N/A elif opt in log_opts:

466N/A if arg is None or arg == "":

466N/A raise OptionError, \

466N/A "You must specify a log " \

466N/A "destination."

466N/A log_routes[opt.lstrip("--log-")] = arg

589N/A elif opt == "--mirror":

589N/A mirror = True

1191N/A elif opt == "--nasty":

1191N/A value_err = None

1191N/A try:

1191N/A nasty_value = int(arg)

1191N/A except ValueError, e:

1191N/A value_err = e

1191N/A

1191N/A if value_err or (nasty_value > 100 or

1191N/A nasty_value < 1):

1191N/A raise OptionError, "Invalid value " \

1191N/A "for nasty option.\n Please " \

1191N/A "choose a value between 1 and 100."

1191N/A nasty = True

1431N/A elif opt == "--set-property":

1431N/A try:

1431N/A prop, p_value = arg.split("=", 1)

1431N/A p_sec, p_name = prop.split(".", 1)

1431N/A except ValueError:

1431N/A usage(_("property arguments must be of "

1431N/A "the form '<section.property>="

1431N/A "<value>'."))

1431N/A repo_props.setdefault(p_sec, {})

1431N/A repo_props[p_sec][p_name] = p_value

589N/A elif opt == "--proxy-base":

589N/A # Attempt to decompose the url provided into

589N/A # its base parts. This is done so we can

589N/A # remove any scheme information since we

589N/A # don't need it.

589N/A scheme, netloc, path, params, query, \

589N/A fragment = urlparse.urlparse(arg,

765N/A "http", allow_fragments=0)

765N/A

765N/A if not netloc:

765N/A raise OptionError, "Unable to " \

765N/A "determine the hostname from " \

765N/A "the provided URL; please use a " \

765N/A "fully qualified URL."

589N/A

765N/A scheme = scheme.lower()

765N/A if scheme not in ("http", "https"):

765N/A raise OptionError, "Invalid URL; http " \

765N/A "and https are the only supported " \

765N/A "schemes."

765N/A

765N/A # Rebuild the url with the sanitized components.

873N/A proxy_base = urlparse.urlunparse((scheme,

873N/A netloc, path, params, query, fragment))

135N/A elif opt == "--readonly":

382N/A readonly = True

157N/A elif opt == "--rebuild":

382N/A rebuild = True

429N/A elif opt == "--refresh-index":

429N/A # Note: This argument is for internal use

429N/A # only. It's used when pkg.depotd is reexecing

429N/A # itself and needs to know that's the case.

429N/A # This flag is purposefully omitted in usage.

429N/A # The supported way to forcefully reindex is to

429N/A # kill any pkg.depot using that directory,

429N/A # remove the index directory, and restart the

429N/A # pkg.depot process. The index will be rebuilt

429N/A # automatically on startup.

429N/A reindex = True

812N/A elif opt == "--ssl-cert-file":

812N/A if arg == "none":

812N/A continue

812N/A

812N/A ssl_cert_file = arg

812N/A if not os.path.isabs(ssl_cert_file):

812N/A raise OptionError, "The path to " \

812N/A "the Certificate file must be " \

812N/A "absolute."

812N/A elif not os.path.exists(ssl_cert_file):

812N/A raise OptionError, "The specified " \

812N/A "file does not exist."

812N/A elif not os.path.isfile(ssl_cert_file):

812N/A raise OptionError, "The specified " \

812N/A "pathname is not a file."

812N/A elif opt == "--ssl-key-file":

812N/A if arg == "none":

812N/A continue

812N/A

812N/A ssl_key_file = arg

812N/A if not os.path.isabs(ssl_key_file):

812N/A raise OptionError, "The path to " \

812N/A "the Private Key file must be " \

812N/A "absolute."

812N/A elif not os.path.exists(ssl_key_file):

812N/A raise OptionError, "The specified " \

812N/A "file does not exist."

812N/A elif not os.path.isfile(ssl_key_file):

812N/A raise OptionError, "The specified " \

812N/A "pathname is not a file."

812N/A elif opt == "--ssl-dialog":

812N/A if arg != "builtin" and not \

812N/A arg.startswith("exec:/") and not \

812N/A arg.startswith("smf:"):

812N/A raise OptionError, "Invalid value " \

812N/A "specified. Expected: builtin, " \

812N/A "exec:/path/to/program, or " \

812N/A "smf:fmri."

812N/A

812N/A f = arg

812N/A if f.startswith("exec:"):

812N/A if os_util.get_canonical_os_type() != \

812N/A "unix":

873N/A # Don't allow a somewhat

873N/A # insecure authentication method

873N/A # on some platforms.

873N/A raise OptionError, "exec is " \

873N/A "not a supported dialog " \

873N/A "type for this operating " \

873N/A "system."

812N/A

812N/A f = os.path.abspath(f.split(

812N/A "exec:")[1])

812N/A

812N/A if not os.path.isfile(f):

812N/A raise OptionError, "Invalid " \

812N/A "file path specified for " \

812N/A "exec."

812N/A

812N/A f = "exec:%s" % f

812N/A

812N/A ssl_dialog = f

1475N/A elif opt == "--sort-file-max-size":

1475N/A if arg == "":

1475N/A raise OptionError, "You must specify " \

1475N/A "a maximum sort file size."

1475N/A sort_file_max_size = arg

975N/A elif opt == "--writable-root":

975N/A if arg == "":

975N/A raise OptionError, "You must specify " \

975N/A "a directory path."

975N/A writable_root = arg

873N/A except getopt.GetoptError, _e:

873N/A usage("pkg.depotd: %s" % _e.msg)

873N/A except OptionError, _e:

873N/A usage("pkg.depotd: option: %s -- %s" % (opt, _e))

382N/A except (ArithmeticError, ValueError):

466N/A usage("pkg.depotd: illegal option value: %s specified " \

466N/A "for option: %s" % (arg, opt))

451N/A

445N/A if rebuild and reindex:

466N/A usage("--refresh-index cannot be used with --rebuild")

461N/A if rebuild and (readonly or mirror):

466N/A usage("--readonly and --mirror cannot be used with --rebuild")

1020N/A if reindex and mirror:

1020N/A usage("--mirror cannot be used with --refresh-index")

1020N/A if reindex and readonly and not writable_root:

1020N/A usage("--readonly can only be used with --refresh-index if "

1020N/A "--writable-root is used")

451N/A

812N/A if (ssl_cert_file and not ssl_key_file) or (ssl_key_file and not

812N/A ssl_cert_file):

812N/A usage("The --ssl-cert-file and --ssl-key-file options must "

812N/A "must both be provided when using either option.")

812N/A elif ssl_cert_file and ssl_key_file and not port_provided:

812N/A # If they didn't already specify a particular port, use the

812N/A # default SSL port instead.

812N/A port = SSL_PORT_DEFAULT

812N/A

429N/A # If the program is going to reindex, the port is irrelevant since

429N/A # the program will not bind to a port.

429N/A if not reindex:

429N/A available, msg = port_available(None, port)

429N/A if not available:

429N/A print "pkg.depotd: unable to bind to the specified " \

429N/A "port: %d. Reason: %s" % (port, msg)

429N/A sys.exit(1)

612N/A else:

612N/A # Not applicable for reindexing operations.

612N/A content_root = None

386N/A

812N/A key_data = None

812N/A if not reindex and ssl_cert_file and ssl_key_file and \

812N/A ssl_dialog != "builtin":

812N/A cmdline = None

812N/A def get_ssl_passphrase(*ignored):

812N/A p = None

812N/A try:

812N/A p = subprocess.Popen(cmdline, shell=True,

812N/A stdout=subprocess.PIPE,

812N/A stderr=None)

812N/A p.wait()

873N/A except Exception, __e:

812N/A print "pkg.depotd: an error occurred while " \

812N/A "executing [%s]; unable to obtain the " \

812N/A "passphrase needed to decrypt the SSL" \

873N/A "private key file: %s" % (cmdline, __e)

812N/A sys.exit(1)

812N/A return p.stdout.read().strip("\n")

812N/A

812N/A if ssl_dialog.startswith("exec:"):

812N/A cmdline = "%s %s %d" % (ssl_dialog.split("exec:")[1],

812N/A "''", port)

812N/A elif ssl_dialog.startswith("smf:"):

812N/A cmdline = "/usr/bin/svcprop -p " \

812N/A "pkg_secure/ssl_key_passphrase %s" % (

812N/A ssl_dialog.split("smf:")[1])

812N/A

812N/A # The key file requires decryption, but the user has requested

812N/A # exec-based authentication, so it will have to be decoded first

812N/A # to an un-named temporary file.

812N/A try:

812N/A key_file = file(ssl_key_file, "rb")

812N/A pkey = crypto.load_privatekey(crypto.FILETYPE_PEM,

812N/A key_file.read(), get_ssl_passphrase)

812N/A

812N/A key_data = tempfile.TemporaryFile()

812N/A key_data.write(crypto.dump_privatekey(

812N/A crypto.FILETYPE_PEM, pkey))

812N/A key_data.seek(0)

873N/A except EnvironmentError, _e:

812N/A print "pkg.depotd: unable to read the SSL private " \

873N/A "key file: %s" % _e

812N/A sys.exit(1)

873N/A except crypto.Error, _e:

812N/A print "pkg.depotd: authentication or cryptography " \

812N/A "failure while attempting to decode\nthe SSL " \

873N/A "private key file: %s" % _e

812N/A sys.exit(1)

812N/A else:

812N/A # Redirect the server to the decrypted key file.

812N/A ssl_key_file = "/dev/fd/%d" % key_data.fileno()

812N/A

452N/A # Setup our global configuration.

466N/A gconf = {

858N/A "checker.on": True,

382N/A "environment": "production",

466N/A "log.screen": False,

965N/A "server.max_request_body_size": MAX_REQUEST_BODY_SIZE,

858N/A "server.shutdown_timeout": 0,

452N/A "server.socket_host": "0.0.0.0",

382N/A "server.socket_port": port,

858N/A "server.socket_timeout": socket_timeout,

858N/A "server.ssl_certificate": ssl_cert_file,

858N/A "server.ssl_private_key": ssl_key_file,

382N/A "server.thread_pool": threads,

742N/A "tools.log_headers.on": True,

858N/A "tools.encode.on": True

466N/A }

466N/A

858N/A if debug_features["headers"]:

858N/A # Despite its name, this only logs headers when there is an

858N/A # error; it's redundant with the debug feature enabled.

858N/A gconf["tools.log_headers.on"] = False

858N/A

858N/A # Causes the headers of every request to be logged to the error

858N/A # log; even if an exception occurs.

858N/A gconf["tools.log_headers_always.on"] = True

858N/A cherrypy.tools.log_headers_always = cherrypy.Tool(

858N/A "on_start_resource",

858N/A cherrypy.lib.cptools.log_request_headers)

858N/A

466N/A log_type_map = {

466N/A "errors": {

466N/A "param": "log.error_file",

466N/A "attr": "error_log"

466N/A },

466N/A "access": {

466N/A "param": "log.access_file",

466N/A "attr": "access_log"

466N/A }

466N/A }

466N/A

466N/A for log_type in log_type_map:

466N/A dest = log_routes[log_type]

466N/A if dest in ("stdout", "stderr", "none"):

466N/A if dest == "none":

466N/A h = logging.StreamHandler(LogSink())

466N/A else:

466N/A h = logging.StreamHandler(eval("sys.%s" % \

466N/A dest))

466N/A

466N/A h.setLevel(logging.DEBUG)

466N/A h.setFormatter(cherrypy._cplogging.logfmt)

466N/A log_obj = eval("cherrypy.log.%s" % \

466N/A log_type_map[log_type]["attr"])

466N/A log_obj.addHandler(h)

466N/A # Since we've replaced cherrypy's log handler with our

466N/A # own, we don't want the output directed to a file.

466N/A dest = ""

466N/A gconf[log_type_map[log_type]["param"]] = dest

382N/A

612N/A cherrypy.config.update(gconf)

612N/A

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

612N/A # remaining preparation.

1431N/A

1431N/A # Initialize repository state.

1431N/A fork_allowed = not reindex

1431N/A try:

1431N/A repo = sr.Repository(auto_create=not readonly,

1431N/A cfgpathname=repo_config_file, fork_allowed=fork_allowed,

1431N/A log_obj=cherrypy, mirror=mirror, properties=repo_props,

1431N/A read_only=readonly, repo_root=repo_path,

1475N/A sort_file_max_size=sort_file_max_size,

1431N/A writable_root=writable_root)

1431N/A except sr.RepositoryError, _e:

1431N/A emsg("pkg.depotd: %s" % _e)

1431N/A sys.exit(1)

1431N/A except rc.RequiredPropertyValueError, _e:

1431N/A emsg("pkg.depotd: repository configuration error: %s" % _e)

1431N/A emsg("Please use the --set-property option to provide a value, "

1431N/A "or update the cfg_cache file for the repository to "

1431N/A "correct this.")

1431N/A sys.exit(1)

1431N/A except rc.PropertyError, _e:

1431N/A emsg("pkg.depotd: repository configuration error: %s" % _e)

1431N/A sys.exit(1)

1431N/A except (search_errors.IndexingException,

1431N/A api_errors.PermissionsException), _e:

1431N/A emsg(str(_e), "INDEX")

1431N/A sys.exit(1)

1431N/A

612N/A if reindex:

1431N/A # Initializing the repository above updated search indices

1431N/A # as needed; nothing left to do, so exit.

1431N/A sys.exit(0)

1431N/A

1431N/A if nasty:

1431N/A repo.cfg.set_nasty(nasty_value)

1431N/A

1431N/A if rebuild:

617N/A try:

1431N/A repo.rebuild()

1431N/A except sr.RepositoryError, e:

1431N/A emsg(str(e), "REBUILD")

1431N/A sys.exit(1)

975N/A except (search_errors.IndexingException,

1431N/A api_errors.PermissionsException), e:

1431N/A emsg(str(e), "INDEX")

617N/A sys.exit(1)

1431N/A

1431N/A # Next, initialize depot.

1431N/A if nasty:

1431N/A depot = ds.NastyDepotHTTP(repo, content_root,

1431N/A disable_ops=disable_ops)

1431N/A else:

1431N/A depot = ds.DepotHTTP(repo, content_root,

1431N/A disable_ops=disable_ops)

612N/A

451N/A # Now build our site configuration.

382N/A conf = {

452N/A "/": {

452N/A # We have to override cherrypy's default response_class so that

452N/A # we have access to the write() callable to stream data

452N/A # directly to the client.

873N/A "wsgi.response_class": dr.DepotResponse,

452N/A },

382N/A "/robots.txt": {

382N/A "tools.staticfile.on": True,

1431N/A "tools.staticfile.filename": os.path.join(depot.web_root,

382N/A "robots.txt")

382N/A },

382N/A }

145N/A

451N/A if proxy_base:

451N/A # This changes the base URL for our server, and is primarily

451N/A # intended to allow our depot process to operate behind Apache

451N/A # or some other webserver process.

451N/A #

451N/A # Visit the following URL for more information:

451N/A # http://cherrypy.org/wiki/BuiltinTools#tools.proxy

451N/A proxy_conf = {

451N/A "tools.proxy.on": True,

451N/A "tools.proxy.local": "",

451N/A "tools.proxy.base": proxy_base

451N/A }

451N/A

451N/A # Now merge or add our proxy configuration information into the

451N/A # existing configuration.

451N/A for entry in proxy_conf:

451N/A conf["/"][entry] = proxy_conf[entry]

451N/A

814N/A try:

1431N/A root = cherrypy.Application(depot)

466N/A cherrypy.quickstart(root, config=conf)

873N/A except Exception, _e:

812N/A emsg("pkg.depotd: unknown error starting depot server, " \

812N/A "illegal option value specified?")

873N/A emsg(_e)

812N/A sys.exit(1)