# -*- coding: iso8859-1 -*-
#
# Copyright (C) 2006 CSIRO Australia
# All rights reserved.
#
# This software is licensed as described in the file COPYING, which
# you should have received as part of this distribution.
#
# This software consists of voluntary contributions made by many
# individuals. For exact contribution history, see the revision
# history and logs.
#
# Author: Conrad Parker <conrad@annodex.net>

import commands
import string

from anxvalidator.cmmlvalidate import cmml_types, cmml_errs, cmml_sloppy
from anxvalidator.oggzvalidate import ogg_types
from anxvalidator.pipeoutput import PipeOutput, pipe_limit

class About (object):

  def __init__(self):
    e = commands.getoutput ('oggz-validate --help-errors')
    self.oggz_errs = e.splitlines()

  def title (self):
    return 'Annodex media validation service: About'

  def __str__(self):
    def li(item):
      return '<li>' + item + '</li>'
    def li_code(item):
      return '<li><code>' + item + '</code></li>'

    def make_list (list, code=False, clear=True):
      if code:
        s = '<ul>' + string.join(map (li_code, list)) + '</ul>'
      else:
        s = '<ul>' + string.join(map (li, list)) + '</ul>'
      if clear:
        s += '<div class="clearfix"></div>'
      s += '<p/>'
      return s

    def make_x_type (type):
      (major, minor) = type.split ('/', 1)
      return major + '/x-' + minor

    s = '''
<h3>Overview</h3>
<p>
This service can be used to validate Web-accessible Ogg, CMML and Annodex
resources.
</p>
<h4>HTTP reporting</h4>
<p>
The following HTTP actions are reported:
</p>
<ul>
<li>Any HTTP redirections encountered while attempting to access the resource</li>
<li>In case of error, the status code of the HTTP response</li>
<li>The <code>Content-Type</code> HTTP response header as reported by the server</li>
<li>The value of the
<a href="http://www.annodex.net/uri/"><code>X-Accept-TimeURI</code></a>
HTTP header. For more information see the
<a href="http://www.annodex.net/specifications.html#uri">Time intervals in URIs Internet-Draft</a> section 6.1.
</li>
<li>
For Annodex resources (URLs returning Content-Type <code>*/annodex</code>),
an attempt will be made to retrieve and validate the associated CMML by
requesting the same URL with the additional HTTP request header
<code>Accept: text/x-cmml</code>. For more information, see the
<a href="http://www.annodex.net/specifications.html#annodex">Annodex
Internet-Draft</a> section 6.1.2.
</li>
</ul>
<div class="clearfix"></div>
'''
    
    s += '''
<h4 id="ogg">Ogg media validation</h4>
<p>
This service recognizes
<a href="http://www.xiph.org/ogg/">Ogg</a>
media resources of the following content types:
</p>
'''
    s += make_list (ogg_types, code=True, clear=False)

    s += make_list (map (make_x_type, ogg_types), code=True)

    s += '''
<p>
The following types of errors can be detected in Ogg framing:
</p>
'''
    s += make_list (self.oggz_errs)

    s += '''<p>
Please note that only the first %dKB of the media resource are retrieved.
Validation of media content is performed by
<a href="http://www.annodex.net/software/liboggz/">oggz-validate</a>.
</p>
''' % (pipe_limit/1024)

    s += '''
<h4 id="cmml">CMML Markup validation</h4>
<p>
This service recognizes
<a href="http://www.annodex.net/specifications.html#cmml">CMML</a>
resources of content type:
</p>
'''
    s += make_list (cmml_types, code=True, clear=False)

    s += make_list (map (make_x_type, cmml_types), code=True)

    s += '''
<p>
The following types of errors can be detected in CMML markup:
</p>
'''
    s += make_list (cmml_errs)

    s += '''
<p>
Additionally, the following warnings will be given for CMML markup:
</p>
'''
    s += make_list (cmml_sloppy)

    s += '''
<p>
Validation of CMML content is performed by
<a href="http://www.annodex.net/software/libcmml/">cmml-validate</a>.
</p>
'''

    s += '''
<h4 id="source">Source code</h4>
<p>
Source code for this service is available from:
<a href="http://svn.annodex.net/annodex-validator/trunk/"><address>http://svn.annodex.net/annodex-validator/trunk</address></a>
</p>
'''

    return s