"""
Base class for Scrapy commands
"""

from __future__ import with_statement

import os
import sys
from optparse import OptionGroup

import scrapy
from scrapy.conf import settings

class ScrapyCommand(object):

    requires_project = False

    def syntax(self):
        """
        Command syntax (preferably one-line). Do not include command name.
        """
        return ""

    def short_desc(self):
        """
        A short description of the command
        """
        return ""

    def long_desc(self):
        """A long description of the command. Return short description when not
        available. It cannot contain newlines, since contents will be formatted
        by optparser which removes newlines and wraps text.
        """
        return self.short_desc()

    def help(self):
        """An extensive help for the command. It will be shown when using the
        "help" command. It can contain newlines, since not post-formatting will
        be applied to its contents.
        """
        return self.long_desc()

    def add_options(self, parser):
        """
        Populate option parse with options available for this command
        """
        group = OptionGroup(parser, "Global Options")
        group.add_option("-h", "--help", action="store_true", dest="help", \
            help="print command help and options")
        group.add_option("--version", action="store_true", dest="version", \
            help="print Scrapy version and exit")
        group.add_option("--logfile", dest="logfile", metavar="FILE", \
            help="log file. if omitted stderr will be used")
        group.add_option("-L", "--loglevel", dest="loglevel", metavar="LEVEL", \
            default=None, \
            help="log level (default: %s)" % settings['LOGLEVEL'])
        group.add_option("--nolog", action="store_true", dest="nolog", \
            help="disable logging completely")
        group.add_option("--spider", dest="spider", default=None, \
            help="always use this spider when arguments are urls")
        group.add_option("--profile", dest="profile", metavar="FILE", default=None, \
            help="write python cProfile stats to FILE")
        group.add_option("--lsprof", dest="lsprof", metavar="FILE", default=None, \
            help="write lsprof profiling stats to FILE")
        group.add_option("--pidfile", dest="pidfile", metavar="FILE", \
            help="write process ID to FILE")
        group.add_option("--set", dest="set", action="append", default=[], \
            help="set/override setting (may be repeated)")
        group.add_option("--settings", dest="settings", metavar="MODULE",
            help="python path to the Scrapy project settings")
        parser.add_option_group(group)
        
    def process_options(self, args, opts):
        if opts.settings:
            settings.set_settings_module(opts.settings)

        for setting in opts.set:
            if '=' in setting:
                name, val = setting.split('=', 1)
                settings.overrides[name] = val
            else:
                sys.stderr.write("%s: invalid argument --set %s - proper format " \
                    "is --set SETTING=VALUE'\n" % (sys.argv[0], setting))
                sys.exit(2)

        if opts.version:
            print scrapy.__version__
            sys.exit()

        if opts.logfile:
            settings.overrides['LOG_ENABLED'] = True
            settings.overrides['LOG_FILE'] = opts.logfile

        if opts.loglevel:
            settings.overrides['LOG_ENABLED'] = True
            settings.overrides['LOG_LEVEL'] = opts.loglevel

        if opts.nolog:
            settings.overrides['LOG_ENABLED'] = False

        if opts.spider:
            from scrapy.spider import spiders
            spiders.force_domain = opts.spider

        if opts.pidfile:
            with open(opts.pidfile, "w") as f:
                f.write(str(os.getpid()))

    def run(self, args, opts):
        """
        Entry point for running commands
        """
        raise NotImplementedError