Source code: org/esau/ptarmigan/impl/filter/ASXFilter.java

   /* $Header: /cvsroot/ptarmigan/ptarmigan/src/java/org/esau/ptarmigan/impl/filter/ASXFilter.java,v 1.2 2002/09/16 04:05:07 reedesau Exp $ */
   
   package org.esau.ptarmigan.impl.filter;
   
   import org.xml.sax.Attributes;
   import org.xml.sax.SAXException;
   
   import org.apache.commons.logging.Log;
   import org.apache.commons.logging.LogFactory;
  
  /**
   * ASXFilter -- transforms ASX playlist to ptarmigan playlist
   * <p>
   *  Example source:
   * <pre>
   *   &lt;ASX version="3.0"&gt;
   *       &lt;ABSTRACT&gt;This is a sample asx file used as playlist&lt;/ABSTRACT&gt;
   *       &lt;TITLE&gt;Windows Media Playlist Demo&lt;/TITLE&gt;
   *       &lt;AUTHOR&gt;Reed Esau&lt;/AUTHOR&gt;
   *       &lt;COPYRIGHT&gt;2002 Reed Esau&lt;/COPYRIGHT&gt;
   *       &lt;ENTRY&gt;
   *               &lt;REF href="File1.asf" /&gt;
   *               &lt;ABSTRACT&gt;Link to a local file on the same folder&lt;/ABSTRACT&gt;
   *       &lt;/ENTRY&gt;
   *       &lt;ENTRY&gt;
   *               &lt;REF href="mms://media.phm.lu/File2.asf" /&gt;
   *               &lt;ABSTRACT&gt;a file streamed from a media server on the network&lt;/ABSTRACT&gt;
   *       &lt;/ENTRY&gt;
   *       &lt;ENTRY&gt;
   *               &lt;REF href="File3.mp3" /&gt;
   *               &lt;ABSTRACT&gt;ASX can support any file type supported by WMP&lt;/ABSTRACT&gt;
   *       &lt;/ENTRY&gt;
   *       &lt;ENTRY&gt;
   *               &lt;REF href="File4.avi" /&gt;
   *               &lt;ABSTRACT&gt;you can even mix audio files and video files in the same ASX&lt;/ABSTRACT&gt;
   *       &lt;/ENTRY&gt;
   *   &lt;/ASX&gt;
   * </pre>
   * The equivalent XSLT would appear thus:
   * <pre>
   *   &lt;xsl:template match="/ASX"&gt;
   *       &lt;pl:playlist&gt;
   *           &lt;pl:properties&gt;
   *               &lt;pl:title&gt;&lt;xsl:value-of select='TITLE'/&gt;&lt;/pl:title&gt;
   *               &lt;pl:author&gt;&lt;xsl:value-of select='AUTHOR'/&gt;&lt;/pl:author&gt;
   *               &lt;pl:copyright&gt;&lt;xsl:value-of select='COPYRIGHT'/&gt;&lt;/pl:copyright&gt;
   *               &lt;pl:summary&gt;&lt;xsl:value-of select='ABSTRACT'/&gt;&lt;/pl:summary&gt;
   *               &lt;pl:entry-count&gt;&lt;xsl:value-of select='count(ENTRY)'/&gt;&lt;/pl:entry-count&gt;
   *           &lt;/pl:properties&gt;
   *           &lt;xsl:if test="$include_entries = 'true'"&gt;
   *               &lt;xsl:apply-templates select="ENTRY"/&gt;
   *           &lt;/xsl:if&gt;
   *       &lt;/pl:playlist&gt;
   *   &lt;/xsl:template&gt;
   *
   *   &lt;xsl:template match="ENTRY"&gt;
   *       &lt;pl:entry&gt;
   *           &lt;pl:path&gt;&lt;xsl:value-of select='REF/@href'/&gt;&lt;/pl:path&gt;
   *           &lt;pl:title&gt;&lt;xsl:value-of select='ABSTRACT'/&gt;&lt;/pl:title&gt;
   *       &lt;/pl:entry&gt;
   *   &lt;/xsl:template&gt;
   * </pre>
   * TODO: recursively scan all playlists found.
   *
   * @author Reed Esau
   * @version $Revision: 1.2 $ $Date: 2002/09/16 04:05:07 $
   */
  public final class ASXFilter extends XMLPlaylistFilter {
  
      public ASXFilter() throws SAXException {
      }
  
      /** is the text file an XML file with that dodgy ASX marker?
       *
       * Note: ASX files may not start with "<?xml"
       * */
      public boolean isMatch(String sniff_chars) {
          log.debug("sniffing for <ASX");
          return sniff_chars.indexOf("<ASX") >= 0;
      }
  
      /** from the asx 'structure' */
      static final String ASX                = "ASX";
      static final String ASX_TITLE          = "TITLE";
      static final String ASX_AUTHOR         = "AUTHOR";
      static final String ASX_COPYRIGHT      = "COPYRIGHT";
      static final String ASX_ABSTRACT       = "ABSTRACT";
      static final String ASX_ENTRY          = "ENTRY";
      static final String ASX_ENTRY_REF      = "REF";
      static final String ASX_ENTRY_REF_HREF = "href";
      static final String ASX_ENTRY_ABSTRACT = "ABSTRACT";     // same as ASX_ABSTRACT
  
      /**
       * Filter a start element event.
       */
      public void startElement(String uri, String local_name, String qName, Attributes atts) throws SAXException {
  
          //log.debug("startelement: local_name=" + local_name);
  
         if (ASX_ENTRY.equals(local_name)) {
             setInEntry(true);
         }
         else if (ASX_ENTRY_REF.equals(local_name) && atts.getLength() > 0) {
             setEntryPath( atts.getValue(ASX_ENTRY_REF_HREF) );
         }
         else if (ASX.equals(local_name)) {
 
             m_media_properties.setMimeType("video/x-ms-asf");
 
             startPlaylist();
         }
     }
 
     /**
      * Filter an end element event.
      */
     public void endElement(String uri, String local_name, String qName) throws SAXException {
 
         //log.debug("ENDELEMENT: local_name=" + local_name);
 
         if (ASX_ABSTRACT.equals(local_name)) {
             if (getInEntry())
                 setEntryTitle( getChars() );
             else
                 setSummary( getChars() );
         }
         else if (ASX_ENTRY.equals(local_name)) {
             if ( getIsPropsDone() == false)
                 writeProperties();
 
             writeEntry();
 
             setInEntry(false);
         }
         else if (ASX_TITLE.equals(local_name)) {
             setTitle( getChars() );
         }
         else if (ASX_AUTHOR.equals(local_name)) {
             setAuthor( getChars() );
         }
         else if (ASX_COPYRIGHT.equals(local_name)) {
             setCopyright( getChars() );
         }
         else if (ASX.equals(local_name)) {
             endPlaylist();
         }
     }
 
 
     /**
      * logging object
      */
     static Log log = LogFactory.getLog(ASXFilter.class);
 }
 
 /*
 PTARMIGAN MODIFIED BSD LICENSE
 
 Copyright (c) 2002, Reed Esau (reed.esau@pobox.com) All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are
 met:
 
 Redistributions of source code must retain the above copyright notice,
 this list of conditions and the following disclaimer.
 
 Redistributions in binary form must reproduce the above copyright notice,
 this list of conditions and the following disclaimer in the documentation
 and/or other materials provided with the distribution.
 
 Neither the name of the Ptarmigan Project
 (http://ptarmigan.sourceforge.net) nor the names of its contributors may
 be used to endorse or promote products derived from this software without
 specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 */