/*
 *
 *  $Revision: 1333 $
 *  $Date: 2020-05-08 14:01:10 -0700 (Fri, 08 May 2020) $
 *  $URL: svn://fred.webarts.bc.ca/open/trunk/projects/WebARTS/ca/bc/webarts/widgets/tunes/TunesHelper.java $
 *
 *  Written by Tom Gutwin - WebARTS Design.
 *  http://www.webarts.bc.ca
 *  Copyright (C) 2016-2019 WebARTS Design, North Vancouver Canada
 *  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.
 */

package ca.bc.webarts.widgets.tunes;

import ca.bc.webarts.widgets.Util;
import ca.bc.webarts.tools.MusicBrainzRestRequester;

import java.io.File;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Locale;
import java.util.StringTokenizer ;
import java.util.Vector;
import java.text.NumberFormat;

import javax.json.*;
import javax.json.stream.JsonGenerator;
import javax.json.stream.JsonParser;

import javax.servlet.http.HttpSession;

//NEWlast.fm api using 2.0 API
//import de.umass.lastfm.Authenticator;
import de.umass.lastfm.Caller;
import de.umass.lastfm.Event;
//import de.umass.lastfm.;
import de.umass.lastfm.Session;
import de.umass.lastfm.Track;
import de.umass.lastfm.User;
import de.umass.lastfm.scrobble.ResponseStatus;
import de.umass.lastfm.scrobble.Scrobbler;
import de.umass.lastfm.scrobble.ScrobbleData;
import de.umass.lastfm.scrobble.ScrobbleResult;
import de.umass.lastfm.scrobble.Source;
import de.umass.lastfm.PaginatedResult;

/**
 *  A helper Bean for the WebARTS Tunes Web Application.
 *
 * @author    TGutwin
 */
public class TunesHelper
{
  /**  A holder for this clients System File Separator.  */
  public final static String SYSTEM_FILE_SEPERATOR = java.io.File.separator;

  /**  A holder for this clients System line termination separator.  */
  public final static String SYSTEM_LINE_SEPERATOR =
                                           System.getProperty("line.separator");
  public final static String DEFAULT_COLUMN_DELIMITOR = "|";

  public final static String LASTFM_USER_AGENT = "jOggPlayer";
  public final static String LASTFM_API_KEY = "93df6c849563eef04d7d48db5950d0c7"; //"${lastfm.key}";  // jOggPlayer Key
  public final static String LASTFM_API_KEY_SECRET = "aa622b7756440145b4405001305b9112"; //"${lastfm.secret}";  // jOggPlayer secret
  /** DEFAULT Last.FM username to use: admin .**/
  protected static final String LASTFM_DEFAULT_USERNAME = "tgutwin"; //"${lastfm.user}";
  /** DEFAULT Last.FM password to use: admin .**/
  protected static final String LASTFM_DEFAULT_PASSWORD = "~19AcrobatiC19~~~"; //"${lastfm.pass}";

  private String columnDelimitor = DEFAULT_COLUMN_DELIMITOR;
  private String webappRootPath_ = "/opt/jetty/baseDir/webapps";
  private static String webAppContext_ = "tunes";
  private String webappHomePath_ = webappRootPath_ + "/" + webAppContext_;
  public  static String webappHomeURLTLS_ = "https://fred.webarts.bc.ca:9443" + "/" + webAppContext_;
  public  static String webappHomeURL_ = "http://fred.webarts.bc.ca:81" + "/" + webAppContext_;
  private static String tunesSubPath_ = "tunes";
  private static String imagesSubPath_ = "images";
  private String lastFmUserID_ = LASTFM_DEFAULT_USERNAME;
  private String lastFmPassword_ = LASTFM_DEFAULT_PASSWORD;

  private boolean lastFmIsInit_ = false;
  private Caller lastFm_ = Caller.getInstance();
  private Session lastFmSession_ = null;
  private User lastFmUser_ = null;
  private PaginatedResult<Track> lastFmLovedTracks_ = null;
  private Vector<String> lastFmLovedTrackNames_ = null;
  private Vector<String> lastFmRecentSongs_ = null;

  long randLong = Math.round(Math.random()*10000000);
  String randStr = String.valueOf(randLong);

  public Vector <Artist> artists_ = new Vector <Artist>();


  /**  Constructor for the TunesHelper object. */
  public TunesHelper()
  {
    System.out.println("[ca.bc.webarts.widgets > TunesHelper()] " +
      (new java.util.Date()).toString());
  }// -- Constructor


  /**  Constructor for the TunesHelper object to allow custom root path, but uses the default context = 'tunes'. */
  public TunesHelper(String webappRootPath, String tunesSubPath, String webappHomeURL)
  {
    System.out.println("[ca.bc.webarts.widgets > TunesHelper("+webappRootPath+","+tunesSubPath+","+webappHomeURL+")] " +
      (new java.util.Date()).toString());

    tunesSubPath_ = tunesSubPath;
    setWebappHomeURL(webappHomeURL);
    setWebappRootPath(webappRootPath);
    setWebappHomePath();
  }// -- Constructor


  public static void main(String [] args)
  {
    final String methodName = "ca.bc.webarts.widgets.tunes.TunesHelper" + ": main()";

    String webappName = "tunes";
    String deployServerTLS = "https://fred.webarts.bc.ca:9443";
    String deployServer = "http://fred.webarts.bc.ca:81";
    String relativeWebappUrlStr = "/"+webappName;
    String webAppHome = "/opt/jetty/baseDir/webapps";

    String tunesSubdir = "tunes";
    String tunesDir = webAppHome + "/" + webappName;
    String webappUrlStr = deployServer + relativeWebappUrlStr;
    String webappTLSUrlStr = deployServerTLS + relativeWebappUrlStr;

    TunesHelper helper = new TunesHelper(webAppHome, tunesSubdir, webappUrlStr);
    if (helper!=null)
    {
      helper.parseTunesDir();
      Vector<Artist> artistVect = helper.getArtists();
      //java.util.Collections(artistVect);  // should already be sorted
      String[] artNames=helper.getArtistNames(true);
      String[] artNamesWithSpaces=helper.getArtistNames(false);
      int numArts =helper.getNumberOfArtists();
      int numAlbums =helper.getNumberOfAlbums();
      int numSongs =helper.getNumberOfSongs();

      Util.writeStringToFile(helper.toJsonString(), "."+SYSTEM_FILE_SEPERATOR+"tunesList.json"  );
    }
  }


  /** Parses the tunes dir and reads in all the artists_. **/
  public void parseTunesDir()
  {
      int numValidArtDirs = 0;
      File[] artistDirFiles = (new File(getTunesDirPath())).listFiles();
      boolean useMusicBrainz = getTunesDirPath().contains("testTunes");
      useMusicBrainz = true;  // now rely on the MB settings for useCacheOnly
      java.util.Arrays.sort(artistDirFiles);
      if(artistDirFiles!=null)
      {
        artists_ = new Vector <Artist>();
        try
        {
          for(File currFile : artistDirFiles)
            if(currFile.isDirectory()
               && currFile.canRead() )
            {
              // check if the artist dir has ANY album dirs, then add
              File[] subFiles = (new File(currFile.getAbsolutePath())).listFiles();
              boolean valid = false;
              try
              {
                for(int i=0; !valid&&i<subFiles.length; i++)
                {
                  if(subFiles[i].isDirectory()
                     && subFiles[i].canRead()
                     && subFiles[i].listFiles().length>0
                    ) valid= true;
                }
                if(valid)
                {
                  //System.out.print("\n    [ca.bc.webarts.widgets > TunesHelper.parseTunesDir() ");
                  //System.out.println(currFile.getAbsolutePath());
                  Artist art = new Artist(currFile.getAbsolutePath(), useMusicBrainz, numValidArtDirs++);
                  artists_.add(art);
                  // now mark last.fm loved songs using lastFmLovedTracks_
                  art.markLovedSongs(lastFmLovedTrackNames_);
                }
              }
              catch ( Exception ex)
              {
                System.out.println(" *!What The Fudge (parseTunesDir()) : "+ex.getMessage());
                ex.printStackTrace();
              }
            }
        }
        catch(Exception ex) { /* ignore error dirs */ }
        artists_.sort(Artist.ArtistComparatorIgnoreCase );
      }
  }


  public Vector<String> getlastFmLovedTrackNames() { return lastFmLovedTrackNames_;}


  /**
    * Set Method for class field 'lastFmUserID_'.
    *
    * @param lastFmUserID is the value to set this class field to.
    *
    **/
  public  void setLastFmUserID(String lastFmUserID)
  {
    this.lastFmUserID_ = lastFmUserID;
  }  // setLastFmUserID Method


  /**
    * Get Method for class field 'lastFmUserID_'.
    *
    * @return String - The value the class field 'lastFmUserID_'.
    *
    **/
  public String getLastFmUserID()
  {
    if(lastFmUserID_==null || "".equals(lastFmUserID_)) setLastFmUserID( LASTFM_DEFAULT_USERNAME);
    return lastFmUserID_;
  }  // getLastFmUserID Method


  /**
    * Set Method for class field 'lastFmPassword_'.
    *
    * @param lastFmPassword is the value to set this class field to.
    *
    **/
  public  void setLastFmPassword(String lastFmPassword)
  {
    this.lastFmPassword_ = lastFmPassword;
  }  // setLastFmPassword Method


  /**
    * Get Method for class field 'lastFmPassword_'.
    *
    * @return String - The value the class field 'lastFmPassword_'.
    *
    **/
  public String getLastFmPassword()
  {
    if(lastFmPassword_==null || "".equals(lastFmPassword_)) setLastFmPassword( LASTFM_DEFAULT_PASSWORD);
    return this.lastFmPassword_;
  }  // getLastFmPassword Method


  public boolean initLastFm(){ return initLastFm(false);}
  public boolean initLastFm(boolean reInit)
  {
    if(reInit || !lastFmIsInit_ )
    {
      System.out.println(" #last.fm initing...  ");
      lastFm_.setUserAgent(LASTFM_USER_AGENT); //tst
      lastFm_.setDebugMode(false);
      lastFmIsInit_ = true;

    }
    return lastFmIsInit_;
  }


  /**
    * Session keys have an infinite lifetime by default. so store it as a cookie to be re-used. You are recommended to store the key securely.
    * Users are able to revoke privileges for your application on their Last.fm settings screen, rendering session keys invalid. This method
    * uses an existing user session.
    *
    **/
  public boolean initLastFmUserSession(){return initLastFmUserSession(false, getLastFmUserID(), getLastFmPassword());}
  /**
    * Session keys have an infinite lifetime by default. so store it as a cookie to be re-used. You are recommended to store the key securely.
    * Users are able to revoke privileges for your application on their Last.fm settings screen, rendering session keys invalid.
    *
    * @param reInit true flags to re-inititalize a new session, false trys to restore an existing session 1st.
    **/
  public boolean initLastFmUserSession(boolean reInit){return initLastFmUserSession(reInit, getLastFmUserID(), getLastFmPassword());}
  /**
    * Session keys have an infinite lifetime by default. so store it as a cookie to be re-used. You are recommended to store the key securely.
    * Users are able to revoke privileges for your application on their Last.fm settings screen, rendering session keys invalid.
    *
    * @param reInit true flags to re-inititalize a new session, false trys to restore an existing session 1st.
    * @param u is the userID to login with
    * @param p is the password to login with
    **/
  public boolean initLastFmUserSession(boolean reInit, String u, String p)
  {
    de.umass.lastfm.Result lastResult = null;
    if(reInit || lastFmSession_==null || lastFmUser_==null)
    {
      System.out.println("\n !!!!!!" );
      System.out.println(" ]]"+(reInit?"RE-":"")+"init Last.FM session u="+ u+"  p="+p);
      initLastFm();
      lastFmSession_ = de.umass.lastfm.Authenticator.getMobileSession(u, p, LASTFM_API_KEY, LASTFM_API_KEY_SECRET);
      if(lastFmSession_!=null)
      {
        System.out.println("]]init Last.FM session Created?: "+ lastFmSession_);
        System.out.println("]]init Last.FM sessionKEY Created?: "+ retrieveLastFmSessionKey()+"\n");
        System.out.println("]]init Last.FM session Username =  "+ retrieveLastFmSessionUsername()+"\n");
        //lastFmUser_ = User.getInfo(lastFmSession_);
        lastFmUser_ = User.getInfo(u, LASTFM_API_KEY);
        System.out.println("]]init Last.FM USER Created? "+(lastFmUser_!=null));
        if (lastFmUser_!=null)
        {
          getLastFmLovedTrackNamesForUser(u);
        }
        else
        {
          lastResult = lastFm_.getLastResult();
          if(lastResult.getStatus()==de.umass.lastfm.Result.Status.valueOf("FAILED"))
            System.out.println("\n >!>!>! Last.FM ERROR USER NOT Created ("+lastResult.getErrorCode()+") "+lastResult.getErrorMessage()+"\n");
        }
      }
      else
        {
          lastResult = lastFm_.getLastResult();
          if(lastResult.getStatus()==de.umass.lastfm.Result.Status.valueOf("FAILED"))
            System.out.println("\n >!>!>! Last.FM ERROR sessionKEY NOT Created ("+lastResult.getErrorCode()+") "+lastResult.getErrorMessage()+"\n");
        }
    }
    else System.out.println(" ]] USING Existing LastFM Session ("+retrieveLastFmSessionKey()+")  & User="+retrieveLastFmSessionUsername());
    return (lastFmSession_!=null);  //&&!retrieveLastFmSessionUsername().equals(""));
  }


  /**
    * Restores an existing Session instance with the given session key.
    **/
  public boolean restoreLastFmUserSession(String sessionKey)
  {
    boolean retVal = false;
    de.umass.lastfm.Result lastResult = null;
    if(sessionKey!=null && !sessionKey.equals(""))
    {
      initLastFm();
      lastFmSession_ = Session.createSession(LASTFM_API_KEY, LASTFM_API_KEY_SECRET, sessionKey);
      System.out.println("\n]]restore Last.FM session Created "+ retrieveLastFmSessionKey() );
      System.out.println("\n]]restore Last.FM sessionUsername "+ retrieveLastFmSessionUsername() );
      if(lastFmSession_!=null)
      {
        lastFmUser_ = User.getInfo(lastFmSession_);
        lastResult = lastFm_.getLastResult();
        if(lastResult.getStatus()==de.umass.lastfm.Result.Status.valueOf("FAILED"))
          System.out.println("\n !>!>!> Last.FM ERROR USER NOT Created ("+lastResult.getErrorCode()+") "+lastResult.getErrorMessage()+"\n");
        if(lastFmUser_==null)
        {
          retVal = initLastFmUserSession(true, getLastFmUserID(), getLastFmPassword());
          //lastFmUser_ = User.getInfo(lastFmSession_);
          lastFmUser_ = User.getInfo(lastFmSession_.getUsername(), LASTFM_API_KEY);
        }
        System.out.println(" ]]restore Last.FM USER Created "+(lastFmUser_!=null));

        if(lastFmUser_!=null)
        {
          System.out.println(" ]] LastFmUsername="+lastFmUser_.getName()+" LastFmUserID="+lastFmUser_.getId());
          System.out.println(" ]] LastFmSessionUsername="+retrieveLastFmSessionUsername());
          setLastFmUserID(lastFmUser_.getName());
          setLastFmPassword(lastFmPassword_);
        }
        System.out.println(" ]]   TunesHelper.  lastFmUserID_"+lastFmUserID_+"   lastFmPassword_="+lastFmPassword_);
        System.out.println("   ]]   TunesHelper.  lastFmUser_==null = "+(lastFmUser_==null));
        System.out.println("   ]]   TunesHelper.  retrieveLastFmSessionUsername()==null = "+retrieveLastFmSessionUsername());
        if(lastFmUser_==null || retrieveLastFmSessionUsername()==null || retrieveLastFmSessionUsername().equals(""))
          retVal = initLastFmUserSession(true, getLastFmUserID(), getLastFmPassword());
        retVal = (lastFmUser_!=null&&!retrieveLastFmSessionUsername().equals("")); //(lastFm_.getLastResult()!=null?lastFm_.getLastResult().isSuccessful():false);
        if (lastFmUser_!=null)
        {
          retrieveLastFmLovedTrackNames();
        }
      }
      else
        {
          lastResult = lastFm_.getLastResult();
          if(lastResult.getStatus()==de.umass.lastfm.Result.Status.valueOf("FAILED"))
            System.out.println("\n !>!>!> Last.FM ERROR sessionKEY NOT Created ("+lastResult.getErrorCode()+") "+lastResult.getErrorMessage()+"\n");
        }
    }
    return retVal;
  }


  /** Queries this classes already defined LastFM user's Loved Tracks, and returns a Vector of their names AND assigns it to class var lastFmLovedTrackNames_. **/
  public Vector<String> retrieveLastFmLovedTrackNames()
  {
    return getLastFmLovedTrackNames(true);
  }
  /** Returns the class var lastFmLovedTrackNames_ directly without retrieving from this classes already defined LastFM user. **/
  public Vector<String> getLastFmLovedTrackNames()
  {
    return getLastFmLovedTrackNames(false);
  }
  /** Returns the class var lastFmLovedTrackNames_ with the option to retrieve them from this classes already defined LastFM user.
    *  If retrieved, it will also mark the class artists__ songs as Loved.
    **/
  public Vector<String> getLastFmLovedTrackNames(boolean retrieve)
  {
    de.umass.lastfm.Result lastResult = null;
    if (retrieve && lastFmUser_!=null)
    {
      System.out.println("]]getLastFmLovedTrackNames for Last.FM USER: "+retrieveLastFmSessionUsername());
      lastFmLovedTracks_ = lastFmUser_.getLovedTracks(getLastFmUserID(), LASTFM_API_KEY);
      int numPages = 0;
      if (lastFmLovedTracks_!=null)
      {
        numPages = lastFmLovedTracks_.getTotalPages();
        lastFmLovedTrackNames_ = new Vector<String>();
        for (int i=1; i<= numPages; i++)
        {
          lastFmLovedTracks_ = lastFmUser_.getLovedTracks(getLastFmUserID(), i, LASTFM_API_KEY);
          for (Track currTrack : lastFmLovedTracks_) lastFmLovedTrackNames_.addElement(currTrack.getName().trim());
          for (Artist art : artists_) art.markLovedSongs( lastFmLovedTrackNames_ );
        }
        //System.out.println("   ]] lastFmLovedTrackNames_ ("+ lastFmLovedTrackNames_.size() +") = \n" + lastFmLovedTrackNames_);
      }
      else System.out.println("\n >!>!>! Last.FM ERROR lastFmLovedTrackNames_ NOT Available \n");
    }
    else
    {
      lastResult = lastFm_.getLastResult();
      if(lastResult.getStatus()==de.umass.lastfm.Result.Status.valueOf("FAILED"))
        System.out.println("\n >!>!>! Last.FM ERROR USER NOT Created ("+lastResult.getErrorCode()+") "+lastResult.getErrorMessage()+"\n");
    }

    return lastFmLovedTrackNames_;
  }


  /** retrieves loved trackNames for the specified LastFM user. **/
  public Vector<String> getLastFmLovedTrackNamesForUser(String lastFmUsername)
  {
    Vector<String>  retVal = null;
    de.umass.lastfm.Result lastResult = null;
    if(lastFmUsername!=null && !"".equals(lastFmUsername))
    {
      User user = User.getInfo(lastFmUsername, LASTFM_API_KEY);
      System.out.println("]] Last.FM USER info retrieved? "+(user!=null));
      Vector<String> lovedTrackNames = null;

      if (user!=null)
      {
        System.out.println("]]getLastFmLovedTrackNamesForUser("+lastFmUsername+") for Last.FM USER: "+retrieveLastFmSessionUsername());
        PaginatedResult<Track> lovedTracks = null;
        lovedTracks = user.getLovedTracks(lastFmUsername, LASTFM_API_KEY);
        int numPages = 0;
        if (lovedTracks!=null)
        {
          numPages = lovedTracks.getTotalPages();
          lovedTrackNames = new Vector<String>();
          for (int i=1; i<= numPages; i++)
          {
            lovedTracks = user.getLovedTracks(lastFmUsername, i, LASTFM_API_KEY);
            for (Track currTrack : lovedTracks) lovedTrackNames.addElement(currTrack.getName().trim());
            if (lastFmUsername.equalsIgnoreCase(getLastFmUserID())) for (Artist art : artists_) art.markLovedSongs( lovedTrackNames );
          }
          //System.out.println("   ]] lovedTrackNames ("+ lovedTrackNames.size() +") = \n" + lovedTrackNames);
          retVal = lovedTrackNames;
        }
        else System.out.println("\n >!>!>! Last.FM ERROR lovedTrackNames NOT Available \n");
      }
      else
      {
        lastResult = lastFm_.getLastResult();
        if(lastResult.getStatus()==de.umass.lastfm.Result.Status.valueOf("FAILED"))
          System.out.println("\n >!>!>! Last.FM ERROR USER NOT Created ("+lastResult.getErrorCode()+") "+lastResult.getErrorMessage()+"\n");
      }
    }
    return retVal;
  }


  public Session getLastFmSession() { return lastFmSession_; }
  public String retrieveLastFmAPIKey() { return ( lastFmSession_!=null ? lastFmSession_.getApiKey():""); }
  public String retrieveLastFmSessionKey() { return ( lastFmSession_!=null ? lastFmSession_.getKey():""); }
  public String retrieveLastFmSessionUsername() { return ( lastFmSession_!=null ? (lastFmSession_.getUsername()==null ?LASTFM_DEFAULT_USERNAME:lastFmSession_.getUsername()):""); }
  public User getLastFmUser() { return lastFmUser_; }
  public User retrieveLastFmSessionUser() {
    User u = User.getInfo(lastFmSession_); if(u!=null) lastFmUser_ = u;
    System.out.println("]]init Last.FM USER Retrieved? "+(u!=null));
    return lastFmUser_;}
  public String retrieveLastFmUserId() { return ( lastFmUser_!=null?lastFmUser_.getId():""); }
  public String retrieveLastFmUserImageURL() { return ( lastFmUser_!=null?lastFmUser_.getImageURL():""); }
  public String retrieveLastFmUserUrl() { return ( lastFmUser_!=null?lastFmUser_.getUrl():""); }


  /*
  public boolean nowPlaying(String artistName, String trackName)
  { // OLD API
    boolean retVal = false;
    ScrobbleResult sr = Track.updateNowPlaying(artistName, trackName,  getLastFmSession());
    retVal = (sr.isSuccessful() && !sr.isIgnored());
    System.out.println("nowPlayimg OK? " + retVal);
    return retVal;
  }
    **/


  /*
  public boolean scrobble(String artistName, String trackName)
  {// OLD API
    boolean retVal = false;
    int now = (int) (System.currentTimeMillis() / 1000);
    ScrobbleResult sr = Track.scrobble(artistName, trackName, now, getLastFmSession());
    retVal = (sr.isSuccessful() && !sr.isIgnored());
    System.out.println("scrobbled OK? " + retVal);
    return retVal;
  }
  */


  /* calls the last.fm now playing method with a full set of Track data. */
  public void nowPlaying(String artist, String title, int playTime, int duration, String album, String albumArtist, int trackNum)
  {
    System.out.println("\nlastfmPlay with ScrobbleData Object");
    final String art = Util.capsToSpacesInString(artist).replace("_"," ").replace("  "," ").replace("  "," ").replace("54•40","54-40").trim();
    final String albArt = Util.capsToSpacesInString(albumArtist).replace("_"," ").replace("  "," ").replace("  "," ").replace("54•40","54-40").trim();
    final String alb = Util.capsToSpacesInString(album).replace("_"," ").replace("  "," ").replace("  "," ").replace("A & M","A&M").replace("A& M","A&M").replace("A &M","A&M").trim();
    final String trk = Util.capsToSpacesInString(title).replace("_"," ").replace("  "," ").replace("  "," ").trim();
    final ScrobbleData sd = new ScrobbleData(art, trk, playTime, duration, alb,  albArt, "", trackNum, "");
    // Run in separate thread.
    Thread lastfmThread =
      new Thread()
      {
        public void run()
        {
          ScrobbleResult result = Track.updateNowPlaying(sd, getLastFmSession());
          System.out.println("lastfmPlay sent ("+albArt+", "+art+", "+alb+", "+trk+") : " + (result.isSuccessful() && !result.isIgnored()));
        }
      };

    lastfmThread.start();

  }


  /* calls the last.fm now playing method with a basic set of Track data. */
  public void nowPlaying(String artist, String title)
  {
    System.out.println("\nlastfmPlay with basic artist/title");
    String art = Util.capsToSpacesInString(artist).replace("_"," ").replace("  "," ").replace("  "," ").replace("54•40","54-40").trim();
    String trk = Util.capsToSpacesInString(title).replace("  "," ").replace("  "," ").trim();
    // Run in separate thread.
    /*
    Thread lastfmThread =
      new Thread()
      {
        public void run()
        {
    */
          ScrobbleResult result = Track.updateNowPlaying(art, trk, getLastFmSession());
          System.out.println("lastfmPlay sent ("+art+", "+trk+") : " + (result.isSuccessful() && !result.isIgnored()));
    /*
        }
      };

    lastfmThread.start();
    */

  }


  /** Queries Last.fm and retrieves the number of time this track has been played by the logged in user.
  **/
  public int retrieveLastfmTrackPlayCount(Track trk)
  {
    int retVal = -1;
    if(trk!=null)
    {
      // getInfo WITH the username present has to be called to load the playcounts
      Track t = trk.getInfo(trk.getArtist(), trk.getName(), null, getLastFmUserID(), retrieveLastFmAPIKey() );
      if(t!=null) retVal = t.getUserPlaycount();
      if(t!=null && retVal==-1) retVal = t.getPlaycount();
    }
    return retVal;
  }


  public void scrobble(String artist, String title){ scrobble(artist, "",  title);}
  public void scrobble(String artist, String album, String title){ scrobble(artist, "",  album,  title);}
  public void scrobble(String artist, String albumArtist, String album, String title)
  {
    System.out.println("\nscrobble with basic artist/album/title");

    if(albumArtist==null || albumArtist.trim().equals("")) albumArtist = artist;
    if(albumArtist.toLowerCase().contains("various") ) albumArtist = "Various Artists";
    String art =    Util.capsToSpacesInString(artist).replace("  "," ").replace("  "," ").replace("54•40","54-40").replace("x &y","x&y").trim();
    String albArt = Util.capsToSpacesInString(albumArtist).replace("  "," ").replace("  "," ").replace("54•40","54-40").replace("x &y","x&y").trim();
    String alb = Util.capsToSpacesInString(album).replace("  "," ").replace("  "," ").replace("A & M","A&M").replace("A& M","A&M").replace("A &M","A&M").trim();
    String trk = Util.capsToSpacesInString(title).replace("  "," ").replace("  "," ").trim();
    // Run in separate thread.
    /*
    Thread lastfmThread =
      new Thread()
      {
        public void run()
        {
    */
          int now = (int) (System.currentTimeMillis() / 1000);
          de.umass.lastfm.scrobble.ScrobbleData sd = new de.umass.lastfm.scrobble.ScrobbleData(art, trk, now );

          if(alb!=null && !alb.trim().equals(""))
          {
            /* Why does thisone NOT work without an ignored msg?????  some of the meta-data like -1 ?? */
            //sd = new de.umass.lastfm.scrobble.ScrobbleData(art, trk, now, 0, alb, art, "", -1, "");

            sd.setAlbum(alb);
            if(!alb.equals(albArt)) sd.setAlbumArtist(albArt);

            //sd.setAlbum(playList.getSongAlbum(sel));
             //sd.setTrackNumber(playList.getTrackNumber(sel));
          }

          ScrobbleResult result = de.umass.lastfm.Track.scrobble(sd, getLastFmSession());

          if (result != null && result.isSuccessful() && !result.isIgnored()) System.out.println("Song Sumbitted ! " );
          else
          {
            /*
            Filtered Requests

            A scrobble or Now Playing request may be ignored if we detect bad meta data. This is not treated as an error condition, so if filtering takes place the response will have an "ok" status. The server will return an ignored message with an associated ignored code. This information is useful if the client wants to show information about why a track was not added to the user's profile.

            In the case of batch scrobble requests, each scrobble is filtered separately. So if only one scrobble has bad meta data and is ignored other scrobbles in the request will still be accepted.

            Possible ignored message codes:

                0. None (the request passed all filters).
                1. Filtered artist.
                2. Filtered track.
                3. Timestamp too far in the past.
                4. Timestamp too far in the future.
                5. Max daily scrobbles exceeded.

                */
            if (result.isIgnored())  System.out.println("Sumbmit was Ignored --> (" +result.getIgnoredMessageCode()+")"+result.getIgnoredMessage());
            else
            {
              System.out.println("ERROR Message --> " +result.getErrorMessage());
              System.out.println("   Result Error Code: "+result.getErrorCode() );
              System.out.println("   Result.toString(): \n"+result);
              System.out.println("\n\n   Error Codes:");
              System.out.println("       8 : Operation Failed - Server Error. Please try again later.");
              System.out.println("       6 : Invalid track name supplied");
              System.out.println("       2 : Invalid service - This service does not exist");
              System.out.println("       3 : Invalid Method - No method with that name in this package");
              System.out.println("       4 : Authentication Failed - You do not have permissions to access the service");
              System.out.println("       5 : Invalid format - This service doesn't exist in that format");
              System.out.println("       6 : Invalid parameters - Your request is missing a required parameter");
              System.out.println("       7 : Invalid resource specified");
              System.out.println("       8 : Operation failed - Something else went wrong");
              System.out.println("       9 : Invalid session key - Please re-authenticate");
              System.out.println("       10 : Invalid API key - You must be granted a valid key by last.fm");
              System.out.println("       11 : Service Offline - This service is temporarily offline. Try again later.");
              System.out.println("       13 : Invalid method signature supplied");
              System.out.println("       16 : There was a temporary error processing your request. Please try again");
              System.out.println("       26 : Suspended API key - Access for your account has been suspended, please contact Last.fm");
              System.out.println("       29 : Rate limit exceeded - Your IP has made too many requests in a short period");
            }
          }
    /*
        }
      };

    lastfmThread.start();
    */
  }


  /* calls the last.fm love track method with a basic set of Track data. */
  public String loveTrack(String artist, String title)
  {
    String retVal = "";
    if(artist!=null && !"".equals(artist) && !"null".equalsIgnoreCase(artist) &&
        title!=null && !"".equals(title)  && !"null".equalsIgnoreCase(title) )
    {
      String art = Util.capsToSpacesInString(artist).replace("_"," ").replace("  "," ").replace("  "," ").replace("54•40","54-40").trim();
      String trk = Util.capsToSpacesInString(title).replace("  "," ").replace("  "," ").trim();
      /*
      // Run in separate thread.
      Thread lastfmThread =
        new Thread()
        {
          public void run()
          {
      */
            de.umass.lastfm.Result result = Track.love(art, trk, getLastFmSession());
            System.out.println("loveTrack sent ("+art+", "+trk+") : " + (result.isSuccessful()));
            if (!result.isSuccessful())
            {
              System.out.println("   Result Error Msg : "+result.getErrorMessage() );
              System.out.println("   Result Error Code: "+result.getErrorCode() );
              System.out.println("   Error Codes:");
              System.out.println("       8 : Operation Failed - Server Error. Please try again later.");
              System.out.println("       6 : Invalid track name supplied");
              System.out.println("       2 : Invalid service - This service does not exist");
              System.out.println("       3 : Invalid Method - No method with that name in this package");
              System.out.println("       4 : Authentication Failed - You do not have permissions to access the service");
              System.out.println("       5 : Invalid format - This service doesn't exist in that format");
              System.out.println("       6 : Invalid parameters - Your request is missing a required parameter");
              System.out.println("       7 : Invalid resource specified");
              System.out.println("       8 : Operation failed - Something else went wrong");
              System.out.println("       9 : Invalid session key - Please re-authenticate");
              System.out.println("       10 : Invalid API key - You must be granted a valid key by last.fm");
              System.out.println("       11 : Service Offline - This service is temporarily offline. Try again later.");
              System.out.println("       13 : Invalid method signature supplied");
              System.out.println("       16 : There was a temporary error processing your request. Please try again");
              System.out.println("       26 : Suspended API key - Access for your account has been suspended, please contact Last.fm");
              System.out.println("       29 : Rate limit exceeded - Your IP has made too many requests in a short period");
           }
      /*
          }
        };

      lastfmThread.start();
      */
      retVal = result.getErrorMessage(); //"false";
      if (result.isSuccessful()) retVal = art+"/"+trk;
    }

    return retVal;

  }


  /** Returns a wrapper for the LastFM Album or null if not valid name. Use the Album.getUrl() if needed. **/
  public static de.umass.lastfm.Album retrieveLastFmAlbum(String art, String albumName)
  {
    // this call is not reliable
    System.out.println("\n  >> retrieveLastFmAlbum: " + art +"_" + albumName);
    de.umass.lastfm.Album retVal = de.umass.lastfm.Album.getInfo(art, albumName , LASTFM_DEFAULT_USERNAME, LASTFM_API_KEY);
    return retVal;
  }


  /** Returns a wrapper for the LastFM Album or null if not valid name. Use the Album.getUrl() if needed. **/
  public static String retrieveLastFmAlbumUrl(String art, String albumName)
  {
    String retVal = "";
    if(false)
    {
      de.umass.lastfm.Album al = retrieveLastFmAlbum( art,  albumName);
      if(al!=null)
      {
        System.out.println("\n    >>>> retrieveLastFmAlbumUrl: " + art +"_" +albumName);
        retVal = al.getUrl() ;
      }
    }
    else
    {
      if(albumName.contains("+") || albumName.contains("<") ) System.out.println("\n    >>>>>> albumName: " + albumName.trim());
      retVal = "https://www.last.fm/music/"+Util.capsToSpacesInString(art).trim().replace("+","%252B").replace("_"," ").replace(" ","+").replace("++","+")+
               "/"+albumName.trim().replace("+"," %252B").replace("_"," ").replace(" ","+").replace("++","+").replace("/","%2f").replace("'","%27").replace("#","%23") ;
    }
    return retVal;
  }


  public de.umass.lastfm.Track [] retrieveLastFmRecentSongs() { return retrieveLastFmRecentSongs(getLastFmUserID());}
  public de.umass.lastfm.Track [] retrieveLastFmRecentSongs(String uid )
  {
    de.umass.lastfm.Track [] retVal = null;
    Vector <de.umass.lastfm.Track> t = new Vector<de.umass.lastfm.Track>();
    PaginatedResult <de.umass.lastfm.Track> pgResults = null; //User.getRecentTracks(uid , LASTFM_API_KEY);
    int numPages = 5; //pgResults.getTotalPages();
      for (int i=1; i<= numPages; i++)
      {
        pgResults = User.getRecentTracks(uid, i, 10, LASTFM_API_KEY);
        //System.out.println("\n    >>>> RecentTracks: Page["+i+"] = "+pgResults);
        int curTrk = 0;
        for (Track currTrack : pgResults)
        {
          //System.out.println("    >>>> >> "+curTrk++);
          t.addElement(currTrack);
        }
      }
      retVal= new de.umass.lastfm.Track [t.size()];
      for (int i=0; i< t.size(); i++) retVal[i] = t.get(i);

      return retVal;
  }


  public Vector <Artist> getArtists(){ return  getArtists(false);}
  public Vector <Artist> getArtists(boolean sorted)
  {
    Vector <Artist> retVal = artists_;
    if(sorted)
    {
    }

    return  retVal;
  }


  public String[] getArtistNames(){return getArtistNames(false);}


  public String[] getArtistNames(boolean removeSpaces)
  {
    String [] retVal = new String[artists_.size()];
    for(int i=0;i<artists_.size();i++){retVal[i]=artists_.get(i).artistName(removeSpaces);}
    return retVal;
  }

  public int getNumberOfArtists() {return artists_.size();  }


  public int getNumberOfAlbums()
  {
    int retVal = 0;
    for(int i=0;i<artists_.size();i++){retVal+=artists_.get(i).getNumberOfAlbums();}
    return retVal;
  }


  public int getNumberOfAlbums(String artist)
  {
    int retVal = 0;
    // not implemented
    //for(int i=0;i<artists_.size();i++){retVal+=artists_.get(i).getNumberOfAlbums();}
    return retVal;
  }


  public int getNumberOfSongs()
  {
    int retVal = 0;
    for(int i=0;i<artists_.size();i++){retVal+=artists_.get(i).getNumberOfSongs();}
    return retVal;
  }


  /**
    * Set Method for class field 'webAppContext_'.
    *
    * @param webAppContext is the value to set this class field to.
    *
    **/
  public  void setWebAppContext(String webAppContext)
  {
    this.webAppContext_ = webAppContext;
    setWebappHomePath();
  }  // setWebAppContext Method


  /**
    * Get Method for class field 'webAppContext_'.
    *
    * @return String - The value the class field 'webAppContext_'.
    *
    **/
  public static String getWebAppContext()
  {
    return webAppContext_;
  }  // getWebAppContext Method


  /**
    * Set Method for class field 'webappHomeURL'.
    *
    * @param webappHomeURL is the value to set this class field to.
    *
    **/
  public  void setWebappHomeURL(String webappHomeURL)
  {
    this.webappHomeURL_ = webappHomeURL;
  }  // setWebappHomeURL Method


  /**
    * Get Method for class field 'webappHomeURL_'.
    *
    * @return String - The value the class field 'webappHomeURL_'.
    *
    **/
  public static String getWebappHomeURL()
  {
    return webappHomeURL_;
  }  // getwebappHomeURL Method


  /**
    * Get the URL for the Images dir.
    *
    * @return String - A URL pointing to the images dir.
    *
    **/
  public static String getWebappImagesURL()
  {
    return webappHomeURL_+ "/" + imagesSubPath_;
  }  // getWebappImagesURL Method


  /**
    * Get the URL for the Tunes dir.
    *
    * @return String - A URL pointing to the images dir.
    *
    **/
  public static String getWebappTunesURL()
  {
    return webappHomeURL_+ "/" + tunesSubPath_;
  }  // getWebappTunesURL Method


  /**
    * Set Method for class field 'tunesSubPath_'.
    *
    * @param tunesSubPath is the value to set this class field to.
    *
    **/
  public static void setTunesSubPath(String tunesSubPath)
  {
    tunesSubPath_ = tunesSubPath;
  }  // setTunesSubPath Method


  /**
    * Get Method for class field 'tunesSubPath_'.
    *
    * @return String - The value the class field 'tunesSubPath_'.
    *
    **/
  public static String getTunesSubPath()
  {
    return tunesSubPath_;
  }  // getTunesSubPath Method


  /**
    * Set Method for class field 'webappRootPath_'.
    *
    * @param webappRootPath is the value to set this class field to.
    *
    **/
  public  void setWebappRootPath(String webappRootPath)
  {
    this.webappRootPath_ = webappRootPath;
    setWebappHomePath();
  }  // setWebappRootPath Method


  /**
    * Get Method for class field 'webappRootPath_'.
    *
    * @return String - The value the class field 'webappRootPath'.
    *
    **/
  public String getWebappRootPath()
  {
    return webappRootPath_;
  }  // getWebappRootPath Method


  /**
    * Reset Method for class field 'webappHomePath_' to its root + context path.
    *
    * @param webappHomePath is the value to set this class field to.
    *
    **/
  public  void setWebappHomePath()
  {
    this.webappHomePath_ = getWebappRootPath() + "/" + getWebAppContext();
  }  // setWebappHomePath Method


  /**
    * DEPRECATED - Directly Set Method for class field 'webappHomePath_' which over-rides the root and contect settings (bad).
    *
    * @param webappHomePath is the value to set this class field to.
    *
    **/
  private void setWebappHomePath(String webappHomePath)
  {
    setWebappRootPath(webappHomePath.substring(0,webappHomePath.lastIndexOf("/")-1));
    setWebAppContext(webappHomePath.substring(webappHomePath.lastIndexOf("/")+1));
    //this.webappHomePath_ = webappHomePath;
  }  // setWebappHomePath Method


  /**
    * Get Method for class field 'webappHomePath_'.
    *
    * @return String - The value the class field 'webappHomePath_'.
    *
    **/
  public String getWebappHomePath()
  {
    return webappHomePath_;
  }  // getWebappHomePath Method


  /**
    * Gets the full file path to the tunes dir.
    *
    * @return String - the full file path to the tunes dir.
    *
    **/
  public String getTunesDirPath()
  {
    return getWebappHomePath() +  "/" + tunesSubPath_;
  }  // getWebappHomePath Method


  private String cleanJSON(StringBuilder sb)
  {
    String retVal = sb.toString();
    retVal = Util.tokenReplace(retVal, ","+SYSTEM_LINE_SEPERATOR+"   ,", ",");
    retVal = Util.tokenReplace(retVal, ","+SYSTEM_LINE_SEPERATOR+"  ,", ",");
    retVal = Util.tokenReplace(retVal, ","+SYSTEM_LINE_SEPERATOR+" ,", ",");
    retVal = Util.tokenReplace(retVal, ","+SYSTEM_LINE_SEPERATOR+",", ",");
    return retVal;
  }


    /** lists all songs in all artist's albums in a JSON string.
        /**
      <pre>
      [
        {
   url: "http://warp4.webarts.bc.ca/tunes/mythTunes/3DoorsDown/3DoorsDown/3DoorsDown03-It'sNotMyTime.ogg",
   file: "3DoorsDown03-It'sNotMyTime.ogg",
   title: "It'sNotMyTime",
   album: "3DoorsDown",
   artist: "3DoorsDown",
   number: "03",
   index: "26"
  },
  {
   url: "http://warp4.webarts.bc.ca/tunes/mythTunes/3DoorsDown/3DoorsDown/3DoorsDown04-LetMeBeMyself.ogg",
   file: "3DoorsDown04-LetMeBeMyself.ogg",
   title: "LetMeBeMyself",
   album: "3DoorsDown",
   artist: "3DoorsDown",
   number: "04",
   index: "27"
  },
  {
   url: "http://warp4.webarts.bc.ca/tunes/mythTunes/3DoorsDown/3DoorsDown/3DoorsDown05-Pages.ogg",
   file: "3DoorsDown05-Pages.ogg",
   title: "Pages",
   album: "3DoorsDown",
   artist: "3DoorsDown",
   number: "05",
   index: "28"
  }
      ]
      </pre>
    **/
    public String toJsonString()
    {
      StringBuilder retVal = new StringBuilder("[");
      int songCount = 0; int artistCount = 0; int tot = artists_.size();
      retVal.append(SYSTEM_LINE_SEPERATOR);

      for(Artist currArtist : artists_)
      {
        if(currArtist.getNumberOfSongs()>0)
        {
          retVal.append(currArtist.toJsonString(songCount));
          if(++artistCount<tot)retVal.append("  ,");  // // End Artist "+ currArtist.name(true));
          retVal.append(SYSTEM_LINE_SEPERATOR);
          songCount+=currArtist.getNumberOfSongs();
        }
        else ++artistCount;
      }
      retVal.append("]");
      //retVal.append(" // TunesHelper version: $Revision: 1333 $");
      return cleanJSON(retVal);
    }

  /* **************************************************************************** */

}