# -*- coding: iso-8859-1 -*-
"""a csv logger"""
# Copyright (C) 2000-2004  Bastian Kleineidam
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

import time
import csv
import os

import linkcheck.logger
import linkcheck.configuration


class CSVLogger (linkcheck.logger.Logger):
    """ CSV output. CSV consists of one line per entry. Entries are
    separated by a semicolon.
    """
    def __init__ (self, **args):
        """store default separator and (os dependent) line terminator"""
        super(CSVLogger, self).__init__(**args)
        self.init_fileoutput(args)
        self.separator = args['separator']

    def comment (self, s, **args):
        """Print CSV comment."""
        self.write(u"# ")
        self.writeln(s=s, **args)

    def start_output (self):
        """print checking start info as csv comment"""
        super(CSVLogger, self).start_output()
        if self.fd is None:
            return
        self.starttime = time.time()
        if self.has_field("intro"):
            self.comment(_("created by %s at %s") % \
                         (linkcheck.configuration.AppName,
                          linkcheck.strformat.strtime(self.starttime)))
            self.comment(_("Get the newest version at %(url)s") % \
                         {'url': linkcheck.configuration.Url})
            self.comment(_("Write comments and bugs to %(email)s") % \
                         {'email': linkcheck.configuration.Email})
            self.check_date()
            self.comment(_("Format of the entries:"))
            self.comment(u"urlname;")
            self.comment(u"recursionlevel;")
            self.comment(u"parentname;")
            self.comment(u"baseref;")
            self.comment(u"result;")
            self.comment(u"warningstring;")
            self.comment(u"infostring;")
            self.comment(u"valid;")
            self.comment(u"url;")
            self.comment(u"line;")
            self.comment(u"column;")
            self.comment(u"name;")
            self.comment(u"dltime;")
            self.comment(u"dlsize;")
            self.comment(u"checktime;")
            self.comment(u"cached;")
            self.flush()
        self.writer = csv.writer(self.fd, dialect='excel',
                        delimiter=self.separator, lineterminator=os.linesep)

    def new_url (self, url_data):
        """print csv formatted url check info"""
        if self.fd is None:
            return
        row = []
        for s in [url_data.base_url, url_data.recursion_level,
               url_data.parent_url or "", url_data.base_ref or "",
               url_data.result,
               os.linesep.join(url_data.warning),
               os.linesep.join(url_data.info),
               url_data.valid, url_data.url or "",
               url_data.line, url_data.column,
               url_data.name, url_data.dltime,
               url_data.dlsize, url_data.checktime,
               url_data.cached]:
            if isinstance(s, unicode):
                row.append(s.encode(self.output_encoding, "ignore"))
            else:
                row.append(s)
        self.writer.writerow(row)
        self.flush()

    def end_output (self, linknumber=-1):
        """print end of checking info as csv comment"""
        if self.fd is None:
            return
        self.stoptime = time.time()
        if self.has_field("outro"):
            duration = self.stoptime - self.starttime
            self.comment(_("Stopped checking at %s (%s)") % \
                         (linkcheck.strformat.strtime(self.stoptime),
                          linkcheck.strformat.strduration(duration)))
            self.flush()
        if self.close_fd:
            self.fd.close()
        self.fd = None