birkeh/api-themoviedb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Source code cleanup

Browse Source
This commit is contained in:
Omertron
2011-12-06 12:25:39 +00:00
parent 44b962a60d
commit d0ca6931ec
9 changed files with 545 additions and 297 deletions
Download Patch File Download Diff File Expand all files Collapse all files
themoviedbapi/pom.xml
+8 -3
View File
@@ -15,12 +15,12 @@
<system>Google Code</system>
<url>http://code.google.com/p/themoviedbapi/issues/list</url>
</issueManagement>
<ciManagement>
<system>Hudson CI</system>
<url>http://jenkins.omertron.com/job/API-TheMovieDb/</url>
</ciManagement>
<scm>
<connection>scm:svn:http://themoviedbapi.googlecode.com/svn/trunk/themoviedbapi</connection>
<developerConnection>scm:svn:https://themoviedbapi.googlecode.com/svn/trunk/themoviedbapi</developerConnection>
@@ -39,8 +39,13 @@
<groupId>junit</groupId>
<artifactId>junit</artifactId>
</dependency>
<dependency>
<groupId>commons-codec</groupId>
<artifactId>commons-codec</artifactId>
<version>1.4</version>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
themoviedbapi/src/main/java/com/moviejukebox/themoviedb/TheMovieDb.java
+80 -88
View File
@@ -1,14 +1,14 @@
/*
* Copyright (c) 2004-2011 YAMJ Members
* http://code.google.com/p/moviejukebox/people/list
*
* http://code.google.com/p/moviejukebox/people/list
*
* Web: http://code.google.com/p/moviejukebox/
*
*
* This software is licensed under a Creative Commons License
* See this page: http://code.google.com/p/moviejukebox/wiki/License
*
* For any reuse or distribution, you must make clear to others the
* license terms of this work.
*
* For any reuse or distribution, you must make clear to others the
* license terms of this work.
*/
package com.moviejukebox.themoviedb;
@@ -36,7 +36,7 @@ import com.moviejukebox.themoviedb.tools.WebBrowser;
* This is the main class for the API to connect to TheMovieDb.org.
* The implementation is for v2.1 of the API as detailed here:
* http://api.themoviedb.org/2.1
*
*
* @author Stuart.Boston
* @version 1.3
*/
@@ -47,7 +47,56 @@ public class TheMovieDb {
private static ConsoleHandler tmdbConsoleHandler = new ConsoleHandler();
private static final String API_SITE = "http://api.themoviedb.org/2.1/";
private static final String DEFAULT_LANGUAGE = "en-US";
/**
* Constructor with default logger.
* @param apiKey
*/
public TheMovieDb(String apiKey) {
setLogger(Logger.getLogger("TheMovieDB"));
if (!isValidString(apiKey)) {
logger.severe("TheMovieDb was initialized with a wrong API key!");
}
setApiKey(apiKey);
}
/*
* API Methods
* http://api.themoviedb.org/2.1
* Note: This is currently a read-only interface and as such, no write methods exist.
*/
/*
* Media
*/
@SuppressWarnings("unused")
private static final String MEDIA_GET_INFO = "Media.getInfo";
/*
* Movies
*/
private static final String MOVIE_BROWSE = "Movie.browse";
private static final String MOVIE_GET_IMAGES = "Movie.getImages";
private static final String MOVIE_GET_INFO = "Movie.getInfo";
private static final String MOVIE_GET_LATEST = "Movie.getLatest";
private static final String MOVIE_GET_TRANSLATIONS = "Movie.getTranslations";
private static final String MOVIE_GET_VERSION = "Movie.getVersion";
private static final String MOVIE_IMDB_LOOKUP = "Movie.imdbLookup";
private static final String MOVIE_SEARCH = "Movie.search";
/*
* People
*/
private static final String PERSON_GET_INFO = "Person.getInfo";
private static final String PERSON_GET_LATEST = "Person.getLatest";
private static final String PERSON_GET_VERSION = "Person.getVersion";
private static final String PERSON_SEARCH = "Person.search";
/*
* Misc
*/
private static final String GENRES_GET_LIST = "Genres.getList";
/**
* Compare the MovieDB object with a title & year
* @param moviedb The moviedb object to compare too
@@ -96,7 +145,7 @@ public class TheMovieDb {
}
return false;
}
/**
* Search a list of movies and return the one that matches the title & year
* @param movieList The list of movies to search
@@ -117,7 +166,7 @@ public class TheMovieDb {
return null;
}
/**
* Check the string passed to see if it contains a value.
* @param testString The string to test
@@ -131,68 +180,11 @@ public class TheMovieDb {
}
return true;
}
/*
* API Methods
* http://api.themoviedb.org/2.1
* Note: This is currently a read-only interface and as such, no write methods exist.
*/
/*
* Media
*/
@SuppressWarnings("unused")
private static final String MEDIA_GET_INFO = "Media.getInfo";
/*
* Movies
*/
private static final String MOVIE_BROWSE = "Movie.browse";
private static final String MOVIE_GET_IMAGES = "Movie.getImages";
private static final String MOVIE_GET_INFO = "Movie.getInfo";
private static final String MOVIE_GET_LATEST = "Movie.getLatest";
private static final String MOVIE_GET_TRANSLATIONS = "Movie.getTranslations";
private static final String MOVIE_GET_VERSION = "Movie.getVersion";
private static final String MOVIE_IMDB_LOOKUP = "Movie.imdbLookup";
private static final String MOVIE_SEARCH = "Movie.search";
/*
* People
*/
private static final String PERSON_GET_INFO = "Person.getInfo";
private static final String PERSON_GET_LATEST = "Person.getLatest";
private static final String PERSON_GET_VERSION = "Person.getVersion";
private static final String PERSON_SEARCH = "Person.search";
/*
* Misc
*/
private static final String GENRES_GET_LIST = "Genres.getList";
public static Logger getLogger() {
return logger;
}
/**
* Constructor with default logger.
* @param apiKey
*/
public TheMovieDb(String apiKey) {
setLogger(Logger.getLogger("TheMovieDB"));
if (!isValidString(apiKey)) {
logger.severe("TheMovieDb was initialized with a wrong API key!");
}
setApiKey(apiKey);
}
public TheMovieDb(String apiKey, Logger logger) {
setLogger(logger);
if (!isValidString(apiKey)) {
logger.severe("TheMovieDb was initialized with a wrong API key!");
}
setApiKey(apiKey);
}
/**
* Build comma separated ids for Movie.getLatest and Movie.getVersion.
* @param ids a List of ids
@@ -200,7 +192,7 @@ public class TheMovieDb {
*/
private String buildIds(List<String> ids) {
StringBuilder builder = new StringBuilder();
for (int i = 0; i < ids.size(); i++) {
if (i == 0) {
builder.append(ids.get(i));
@@ -221,9 +213,9 @@ public class TheMovieDb {
*/
private String buildUrl(String prefix, String searchTerm, String language) {
StringBuilder url = new StringBuilder();
url.append(API_SITE);
url.append(prefix);
url.append("/");
@@ -321,11 +313,11 @@ public class TheMovieDb {
validParameters.add("companies");
validParameters.add("countries");
StringBuilder searchUrl = new StringBuilder();
searchUrl.append("order_by=").append(orderBy);
searchUrl.append("&order=").append(order);
if(!parameters.isEmpty()) {
for (String key : validParameters) {
if (parameters.containsKey(key)) {
@@ -336,11 +328,11 @@ public class TheMovieDb {
// Get the search url
String baseUrl = buildUrl(MOVIE_BROWSE, "", language);
// Now append the parameter url to the end of the search url
searchUrl.insert(0, "?");
searchUrl.insert(0, baseUrl);
return MovieDbParser.parseMovies(searchUrl.toString());
}
@@ -395,13 +387,13 @@ public class TheMovieDb {
/**
* Gets all the information for a given TheMovieDb ID
*
*
* @param movie
* An existing MovieDB object to populate with the data
* @param tmdbID
* The Movie Db ID for the movie to get information for
* @param language
* The two digit language code. E.g. en=English
* The two digit language code. E.g. en=English
* @return A movie bean with all of the information
*/
public MovieDB moviedbGetInfo(String tmdbID, MovieDB movie, String language) {
@@ -424,9 +416,9 @@ public class TheMovieDb {
/**
* Passes a null MovieDB object to the full function
*
*
* @param tmdbID TheMovieDB ID of the movie to get the information for
* @param language The two digit language code. E.g. en=English
* @param language The two digit language code. E.g. en=English
* @return A movie bean with all of the information
*/
public MovieDB moviedbGetInfo(String tmdbID, String language) {
@@ -493,9 +485,9 @@ public class TheMovieDb {
/**
* Searches the database using the IMDb reference
*
*
* @param imdbID IMDb reference, must include the "tt" at the start
* @param language The two digit language code. E.g. en=English
* @param language The two digit language code. E.g. en=English
* @return A movie bean with the data extracted
*/
public MovieDB moviedbImdbLookup(String imdbID, String language) {
@@ -512,7 +504,7 @@ public class TheMovieDb {
/**
* Searches the database using the movie title passed
*
*
* @param movieTitle The title to search for
* @param language The two digit language code. E.g. en=English
* @return A movie bean with the data extracted
@@ -528,9 +520,9 @@ public class TheMovieDb {
}
/**
* The Person.getInfo method is used to retrieve the full filmography, known movies,
* The Person.getInfo method is used to retrieve the full filmography, known movies,
* images and things like birthplace for a specific person in the TMDb database.
*
*
* @param personID
* @param language
* @return
@@ -574,18 +566,18 @@ public class TheMovieDb {
}
/**
* The Person.getVersion method is used to retrieve the last modified time
* The Person.getVersion method is used to retrieve the last modified time
* along with the current version number of the called object(s). This is
* useful if you've already called the object sometime in the past and
* simply want to do a quick check for updates.
*
*
* @param personID a Person TMDb id
* @param language the two digit language code. E.g. en=English
* @return
*/
public Person personGetVersion(String personID, String language) {
Person person = new Person();
if (!isValidString(personID)) {
return person;
}
@@ -601,7 +593,7 @@ public class TheMovieDb {
/**
* The Person.search method is used to search for an actor, actress or production member.
* http://api.themoviedb.org/2.1/methods/Person.search
*
*
* @param personName
* @param language
* @return
themoviedbapi/src/main/java/com/moviejukebox/themoviedb/model/MovieDB.java
+34 -31
View File
@@ -1,34 +1,38 @@
/*
* Copyright (c) 2004-2011 YAMJ Members
* http://code.google.com/p/moviejukebox/people/list
*
* http://code.google.com/p/moviejukebox/people/list
*
* Web: http://code.google.com/p/moviejukebox/
*
*
* This software is licensed under a Creative Commons License
* See this page: http://code.google.com/p/moviejukebox/wiki/License
*
* For any reuse or distribution, you must make clear to others the
* license terms of this work.
*
* For any reuse or distribution, you must make clear to others the
* license terms of this work.
*/
package com.moviejukebox.themoviedb.model;
import com.moviejukebox.themoviedb.TheMovieDb;
import java.io.Serializable;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.List;
import java.util.Date;
import com.moviejukebox.themoviedb.tools.ModelTools;
import java.util.logging.Logger;
/**
* This is the Movie Search bean for the MovieDb.org search
*
*
* @author Stuart.Boston
*/
public class MovieDB extends ModelTools implements Serializable {
private static final long serialVersionUID = 1L;
private static final Logger logger = TheMovieDb.getLogger();
public static final String UNKNOWN = "UNKNOWN";
@@ -63,7 +67,7 @@ public class MovieDB extends ModelTools implements Serializable {
public String getPopularity() {
return popularity;
}
public void setPopularity(String popularity) {
this.popularity = popularity;
}
@@ -71,7 +75,7 @@ public class MovieDB extends ModelTools implements Serializable {
public String getTitle() {
return title;
}
public void setTitle(String title) {
this.title = title;
}
@@ -79,11 +83,11 @@ public class MovieDB extends ModelTools implements Serializable {
public String getType() {
return type;
}
public void setType(String type) {
this.type = type;
}
public String getId() {
return id;
}
@@ -91,11 +95,11 @@ public class MovieDB extends ModelTools implements Serializable {
public void setId(String id) {
this.id = id;
}
public String getImdb() {
return imdb;
}
public void setImdb(String imdb) {
this.imdb = imdb;
}
@@ -103,7 +107,7 @@ public class MovieDB extends ModelTools implements Serializable {
public String getUrl() {
return url;
}
public void setUrl(String url) {
this.url = url;
}
@@ -111,7 +115,7 @@ public class MovieDB extends ModelTools implements Serializable {
public String getOverview() {
return overview;
}
public void setOverview(String overview) {
this.overview = overview;
}
@@ -119,7 +123,7 @@ public class MovieDB extends ModelTools implements Serializable {
public String getReleaseDate() {
return releaseDate;
}
public void setReleaseDate(String releaseDate) {
this.releaseDate = releaseDate;
}
@@ -127,7 +131,7 @@ public class MovieDB extends ModelTools implements Serializable {
public String getRating() {
return rating;
}
public void setRating(String rating) {
this.rating = rating;
}
@@ -135,7 +139,7 @@ public class MovieDB extends ModelTools implements Serializable {
public String getRuntime() {
return runtime;
}
public void setRuntime(String runtime) {
this.runtime = runtime;
}
@@ -143,7 +147,7 @@ public class MovieDB extends ModelTools implements Serializable {
public String getBudget() {
return budget;
}
public void setBudget(String budget) {
this.budget = budget;
}
@@ -151,7 +155,7 @@ public class MovieDB extends ModelTools implements Serializable {
public String getRevenue() {
return revenue;
}
public void setRevenue(String revenue) {
this.revenue = revenue;
}
@@ -159,7 +163,7 @@ public class MovieDB extends ModelTools implements Serializable {
public String getHomepage() {
return homepage;
}
public void setHomepage(String homepage) {
this.homepage = homepage;
}
@@ -167,7 +171,7 @@ public class MovieDB extends ModelTools implements Serializable {
public String getTrailer() {
return trailer;
}
public void setTrailer(String trailer) {
this.trailer = trailer;
}
@@ -175,17 +179,17 @@ public class MovieDB extends ModelTools implements Serializable {
public List<Country> getProductionCountries() {
return countries;
}
public void addProductionCountry(Country country) {
if (country != null) {
countries.add(country);
}
}
public List<Person> getPeople() {
return people;
}
public void addPerson(Person person) {
if (person != null) {
people.add(person);
@@ -195,7 +199,7 @@ public class MovieDB extends ModelTools implements Serializable {
public List<Category> getCategories() {
return categories;
}
public void addCategory(Category category) {
if (category != null) {
categories.add(category);
@@ -273,13 +277,13 @@ public class MovieDB extends ModelTools implements Serializable {
public void setStudios(List<Studio> studios) {
this.studios = studios;
}
public void addStudio(Studio studio) {
if (studio != null) {
this.studios.add(studio);
}
}
public void setCountries(List<Country> countries) {
this.countries = countries;
}
@@ -298,11 +302,10 @@ public class MovieDB extends ModelTools implements Serializable {
public void setLastModifiedAt(String lastModifiedAt) {
DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
try {
setLastModifiedAt(df.parse(lastModifiedAt));
} catch (Exception ignore) {
return;
} catch (ParseException ex) {
logger.fine("MovieDB: Error parsing date: " + lastModifiedAt);
}
}
themoviedbapi/src/main/java/com/moviejukebox/themoviedb/model/Person.java
+204 -33
View File
@@ -1,34 +1,38 @@
/*
* Copyright (c) 2004-2011 YAMJ Members
* http://code.google.com/p/moviejukebox/people/list
*
* http://code.google.com/p/moviejukebox/people/list
*
* Web: http://code.google.com/p/moviejukebox/
*
*
* This software is licensed under a Creative Commons License
* See this page: http://code.google.com/p/moviejukebox/wiki/License
*
* For any reuse or distribution, you must make clear to others the
* license terms of this work.
*
* For any reuse or distribution, you must make clear to others the
* license terms of this work.
*/
package com.moviejukebox.themoviedb.model;
import com.moviejukebox.themoviedb.TheMovieDb;
import java.io.Serializable;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import com.moviejukebox.themoviedb.tools.ModelTools;
import java.util.logging.Logger;
/**
* This is the new bean for the Person
*
* This is the new bean for the Person
*
* @author Stuart.Boston
*
*/
public class Person extends ModelTools implements Serializable {
private static final long serialVersionUID = 1L;
private static final Logger logger = TheMovieDb.getLogger();
private static final String UNKNOWN = MovieDB.UNKNOWN;
@@ -49,119 +53,226 @@ public class Person extends ModelTools implements Serializable {
private List<Filmography> filmography = new ArrayList<Filmography>();
private List<String> aka = new ArrayList<String>();
private List<Artwork> images = new ArrayList<Artwork>();
/**
* Add a single AKA
* @param alsoKnownAs
*/
public void addAka(String alsoKnownAs) {
this.aka.add(alsoKnownAs);
}
/**
* Add a film for the person
* @param film
*/
public void addFilm(Filmography film) {
this.filmography.add(film);
}
/**
* Add an artwork image to the person
* @param image
*/
public void addImage(Artwork image) {
if (image != null) {
this.images.add(image);
}
}
/**
* Get all the AKA values
* @return
*/
public List<String> getAka() {
return aka;
}
/**
* Get the biography information
* @return
*/
public String getBiography() {
return biography;
}
/**
* Get the birthday of the person
* @return
*/
public Date getBirthday() {
return birthday;
}
/**
* Get the birthplace
* @return
*/
public String getBirthPlace() {
return birthPlace;
}
/**
* get the cast ID
* @return
*/
public int getCastId() {
return castId;
}
/**
* get the character
* @return
*/
public String getCharacter() {
return character;
}
/**
* get the department
* @return
*/
public String getDepartment() {
return department;
}
/**
* get the list of films
* @return
*/
public List<Filmography> getFilmography() {
return filmography;
}
/**
* get the ID of the person
* @return
*/
public String getId() {
return id;
}
/**
* get a list of images for the person
* @return
*/
public List<Artwork> getImages() {
return images;
}
/**
* get the job
* @return
*/
public String getJob() {
return job;
}
/**
* get the known movies
* @return
*/
public int getKnownMovies() {
return knownMovies;
}
/**
* get the last modified date for the person
* @return
*/
public Date getLastModifiedAt() {
return lastModifiedAt;
}
/**
* get the name
* @return
*/
public String getName() {
return name;
}
/**
* get the order
* @return
*/
public int getOrder() {
return order;
}
/**
* get the URL for the person
* @return
*/
public String getUrl() {
return url;
}
/**
* get the version
* @return
*/
public int getVersion() {
return version;
}
/**
* Set the AKA list for the person
* @param aka
*/
public void setAka(List<String> aka) {
this.aka = aka;
}
/**
* Set the biography
* @param biography
*/
public void setBiography(String biography) {
this.biography = biography;
}
/**
* Set the person's birthday
* @param birthday
*/
public void setBirthday(Date birthday) {
this.birthday = birthday;
}
/**
* Set the person's birthday
* @param sBirthday
*/
public void setBirthday(String sBirthday) {
DateFormat df = new SimpleDateFormat("yyyy-MM-dd");
try {
setBirthday(df.parse(sBirthday));
} catch (Exception ignore) {
return;
} catch (ParseException ex) {
logger.fine("TheMovieDB - Person: Error parsing birthday: " + sBirthday);
}
}
/**
* Set the birth place
* @param birthPlace
*/
public void setBirthPlace(String birthPlace) {
this.birthPlace = birthPlace;
}
/**
* Set the cast ID for the person
* @param castId
*/
public void setCastId(int castId) {
this.castId = castId;
}
/**
* Set the cast ID for the person
* @param castId
*/
public void setCastId(String castId) {
try {
this.castId = Integer.parseInt(castId);
@@ -170,41 +281,77 @@ public class Person extends ModelTools implements Serializable {
}
}
/**
* Set the character
* @param character
*/
public void setCharacter(String character) {
this.character = character;
}
/**
* set the Department
* @param department
*/
public void setDepartment(String department) {
this.department = department;
}
/**
* Add a list of films
* @param filmography
*/
public void setFilmography(List<Filmography> filmography) {
this.filmography = filmography;
}
/**
* Set the ID of the person
* @param id
*/
public void setId(String id) {
this.id = id;
}
/**
* Set a list of images for the person
* @param images
*/
public void setImages(List<Artwork> images) {
this.images = images;
}
/**
* Set the job for the person
* @param job
*/
public void setJob(String job) {
this.job = job;
}
/**
* Set the known movie for the person
* @param knownMovies
*/
public void setKnownMovies(int knownMovies) {
this.knownMovies = knownMovies;
}
/**
* Set the last modified date
* @param lastModifiedAt
*/
public void setLastModifiedAt(Date lastModifiedAt) {
this.lastModifiedAt = lastModifiedAt;
}
/**
* Set the last modified date
* @param lastModifiedAt
*/
public void setLastModifiedAt(String lastModifiedAt) {
DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
try {
Date lma = df.parse(lastModifiedAt);
setLastModifiedAt(lma);
@@ -213,14 +360,26 @@ public class Person extends ModelTools implements Serializable {
}
}
/**
* Set the person's anme
* @param name
*/
public void setName(String name) {
this.name = name;
}
/**
*Set the order
* @param order
*/
public void setOrder(int order) {
this.order = order;
}
/**
* Set the order
* @param order
*/
public void setOrder(String order) {
try {
this.order = Integer.parseInt(order);
@@ -229,14 +388,26 @@ public class Person extends ModelTools implements Serializable {
}
}
/**
* Set the URL
* @param url
*/
public void setUrl(String url) {
this.url = url;
}
/**
* Set the version
* @param version
*/
public void setVersion(int version) {
this.version = version;
}
/**
* Generate a String representation of the person
* @return
*/
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
themoviedbapi/src/main/java/com/moviejukebox/themoviedb/tools/Base64.java
-36
View File
@@ -1,36 +0,0 @@
/*
* Copyright (c) 2004-2011 YAMJ Members
* http://code.google.com/p/moviejukebox/people/list
*
* Web: http://code.google.com/p/moviejukebox/
*
* This software is licensed under a Creative Commons License
* See this page: http://code.google.com/p/moviejukebox/wiki/License
*
* For any reuse or distribution, you must make clear to others the
* license terms of this work.
*/
package com.moviejukebox.themoviedb.tools;
public class Base64 {
private static final String base64code = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
public static String base64Encode(String string) {
String unEncoded = string; // Copy the string so we can modify it
StringBuffer encoded = new StringBuffer();
// determine how many padding bytes to add to the output
int paddingCount = (3 - (unEncoded.length() % 3)) % 3;
// add any necessary padding to the input
unEncoded += "\0\0".substring(0, paddingCount);
// process 3 bytes at a time, churning out 4 output bytes
// worry about CRLF insertions later
for (int i = 0; i < unEncoded.length(); i += 3) {
int j = (unEncoded.charAt(i) << 16) + (unEncoded.charAt(i + 1) << 8) + unEncoded.charAt(i + 2);
encoded.append(base64code.charAt((j >> 18) & 0x3f) + base64code.charAt((j >> 12) & 0x3f) + base64code.charAt((j >> 6) & 0x3f)
+ base64code.charAt(j & 0x3f));
}
// replace encoded padding nulls with "="
// return encoded;
return "Basic " + encoded.toString();
}
}
themoviedbapi/src/main/java/com/moviejukebox/themoviedb/tools/DOMHelper.java
+11 -11
View File
@@ -1,14 +1,14 @@
/*
* Copyright (c) 2004-2011 YAMJ Members
* http://code.google.com/p/moviejukebox/people/list
*
* http://code.google.com/p/moviejukebox/people/list
*
* Web: http://code.google.com/p/moviejukebox/
*
*
* This software is licensed under a Creative Commons License
* See this page: http://code.google.com/p/moviejukebox/wiki/License
*
* For any reuse or distribution, you must make clear to others the
* license terms of this work.
*
* For any reuse or distribution, you must make clear to others the
* license terms of this work.
*/
package com.moviejukebox.themoviedb.tools;
@@ -35,7 +35,7 @@ import com.moviejukebox.themoviedb.TheMovieDb;
*
*/
public class DOMHelper {
private static Logger logger = TheMovieDb.getLogger();
private static final Logger logger = TheMovieDb.getLogger();
/**
* Gets the string value of the tag element name passed
@@ -71,11 +71,11 @@ public class DOMHelper {
Document doc = null;
InputStream in = null;
String webPage = null;
try {
boolean validWebPage = false;
webPage = WebBrowser.request(url);
// There seems to be an error with some of the web pages that returns garbage
if (webPage.startsWith("<?xml version")) {
// This looks like a valid web page
@@ -84,10 +84,10 @@ public class DOMHelper {
logger.fine("DOMHelper: Error with API Call for: " + url);
return null;
}
if (validWebPage) {
in = new ByteArrayInputStream(webPage.getBytes("UTF-8"));
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
DocumentBuilder db = dbf.newDocumentBuilder();
doc = db.parse(in);
themoviedbapi/src/main/java/com/moviejukebox/themoviedb/tools/LogFormatter.java
+17 -14
View File
@@ -1,43 +1,46 @@
/*
* Copyright (c) 2004-2011 YAMJ Members
* http://code.google.com/p/moviejukebox/people/list
*
* http://code.google.com/p/moviejukebox/people/list
*
* Web: http://code.google.com/p/moviejukebox/
*
*
* This software is licensed under a Creative Commons License
* See this page: http://code.google.com/p/moviejukebox/wiki/License
*
* For any reuse or distribution, you must make clear to others the
* license terms of this work.
*
* For any reuse or distribution, you must make clear to others the
* license terms of this work.
*/
package com.moviejukebox.themoviedb.tools;
import java.security.PrivilegedAction;
import java.util.logging.LogRecord;
public class LogFormatter extends java.util.logging.Formatter
{
public class LogFormatter extends java.util.logging.Formatter {
private static String apiKey = null;
private static String EOL = (String)java.security.AccessController.doPrivileged(new PrivilegedAction<Object>() {
private static final String EOL = (String) java.security.AccessController.doPrivileged(new PrivilegedAction<Object>() {
@Override
public Object run() {
return System.getProperty("line.separator");
}
});
@Override
public synchronized String format(LogRecord logRecord) {
String logMessage = logRecord.getMessage();
logMessage = "[TheMovieDb API] " + logMessage.replace(apiKey, "[APIKEY]") + EOL;
Throwable thrown = logRecord.getThrown();
if (thrown != null) {
logMessage = logMessage + thrown.toString();
if (thrown != null) {
logMessage = logMessage + thrown.toString();
}
return logMessage;
}
public void addApiKey(String apiKey) {
LogFormatter.apiKey = apiKey;
LogFormatter.apiKey = apiKey;
return;
}
}
themoviedbapi/src/main/java/com/moviejukebox/themoviedb/tools/MovieDbParser.java
+54 -27
View File
@@ -1,14 +1,14 @@
/*
* Copyright (c) 2004-2011 YAMJ Members
* http://code.google.com/p/moviejukebox/people/list
*
* http://code.google.com/p/moviejukebox/people/list
*
* Web: http://code.google.com/p/moviejukebox/
*
*
* This software is licensed under a Creative Commons License
* See this page: http://code.google.com/p/moviejukebox/wiki/License
*
* For any reuse or distribution, you must make clear to others the
* license terms of this work.
*
* For any reuse or distribution, you must make clear to others the
* license terms of this work.
*/
package com.moviejukebox.themoviedb.tools;
@@ -34,10 +34,14 @@ import com.moviejukebox.themoviedb.model.MovieDB;
import com.moviejukebox.themoviedb.model.Person;
import com.moviejukebox.themoviedb.model.Studio;
/**
* The parser helper class for TheMovieDb API
* @author stuart.boston
*/
public class MovieDbParser {
private static Logger logger = TheMovieDb.getLogger();
private static final Logger logger = TheMovieDb.getLogger();
private static final String NAME = "name";
private static final String GENRE = "genre";
private static final String ID = "id";
@@ -86,27 +90,32 @@ public class MovieDbParser {
return categories;
}
/**
* Get the list of available languages
* @param url
* @return
*/
public static List<Language> parseLanguages(String url) {
List<Language> languages = new ArrayList<Language>();
Document doc = null;
try {
doc = DOMHelper.getEventDocFromUrl(url);
} catch (Exception e) {
logger.severe("Movie.getTranslations error: " + e.getMessage());
return languages;
}
if (doc == null) {
return languages;
}
NodeList nlLanguages = doc.getElementsByTagName(LANGUAGE);
if ((nlLanguages == null) || nlLanguages.getLength() == 0) {
return languages;
}
for (int i = 0; i < nlLanguages.getLength(); i++) {
Node node = nlLanguages.item(i);
if (node.getNodeType() == Node.ELEMENT_NODE) {
@@ -114,7 +123,7 @@ public class MovieDbParser {
languages.add(parseSimpleLanguage(element));
}
}
return languages;
}
@@ -155,6 +164,11 @@ public class MovieDbParser {
return movie;
}
/**
* Parse a DOM document and return the person information
* @param url
* @return
*/
public static Person parseLatestPerson(String url) {
Person person = new Person();
Document doc = null;
@@ -219,6 +233,11 @@ public class MovieDbParser {
return movie;
}
/**
* Parse the DOM document for movie information and return a list of movies
* @param url
* @return
*/
public static List<MovieDB> parseMovieGetVersion(String url) {
List<MovieDB> movies = new ArrayList<MovieDB>();
Document doc = null;
@@ -251,6 +270,11 @@ public class MovieDbParser {
return movies;
}
/**
* Returns a MovieDB object from the Element
* @param movieElement
* @return
*/
private static MovieDB parseMovieInfo(Element movieElement) {
// Inspired by
// http://www.java-tips.org/java-se-tips/javax.xml.parsers/how-to-read-xml-file-in-java.html
@@ -552,6 +576,9 @@ public class MovieDbParser {
return people;
}
/**
* Parse the URL and return a list of the people found in the DOM document
*/
public static ArrayList<Person> parsePersonInfo(String searchUrl) {
ArrayList<Person> people = new ArrayList<Person>();
Person person = null;
@@ -570,15 +597,15 @@ public class MovieDbParser {
NodeList personNodeList = doc.getElementsByTagName(PERSON);
if ((personNodeList == null) || personNodeList.getLength() == 0) {
return people;
}
for (int loop = 0; loop < personNodeList.getLength(); loop++) {
Node personNode = personNodeList.item(loop);
person = new Person();
if (personNode == null) {
logger.finest("Person not found");
return people;
@@ -587,23 +614,23 @@ public class MovieDbParser {
if (personNode.getNodeType() == Node.ELEMENT_NODE) {
try {
Element personElement = (Element) personNode;
person.setName(DOMHelper.getValueFromElement(personElement, NAME));
person.setId(DOMHelper.getValueFromElement(personElement, ID));
person.setBiography(DOMHelper.getValueFromElement(personElement, "biography"));
try {
person.setKnownMovies(Integer.parseInt(DOMHelper.getValueFromElement(personElement, "known_movies")));
} catch (NumberFormatException error) {
person.setKnownMovies(0);
}
person.setBirthday(DOMHelper.getValueFromElement(personElement, "birthday"));
person.setBirthPlace(DOMHelper.getValueFromElement(personElement, "birthplace"));
person.setUrl(DOMHelper.getValueFromElement(personElement, URL));
person.setVersion(Integer.parseInt(DOMHelper.getValueFromElement(personElement, "version")));
person.setLastModifiedAt(DOMHelper.getValueFromElement(personElement, "last_modified_at"));
NodeList artworkNodeList = doc.getElementsByTagName("image");
for (int nodeLoop = 0; nodeLoop < artworkNodeList.getLength(); nodeLoop++) {
Node artworkNode = artworkNodeList.item(nodeLoop);
@@ -617,25 +644,25 @@ public class MovieDbParser {
person.addArtwork(artwork);
}
}
NodeList filmNodeList = doc.getElementsByTagName(MOVIE);
for (int nodeLoop = 0; nodeLoop < filmNodeList.getLength(); nodeLoop++) {
Node filmNode = filmNodeList.item(nodeLoop);
if (filmNode.getNodeType() == Node.ELEMENT_NODE) {
Element filmElement = (Element) filmNode;
Filmography film = new Filmography();
film.setCharacter(filmElement.getAttribute("character"));
film.setDepartment(filmElement.getAttribute("department"));
film.setId(filmElement.getAttribute(ID));
film.setJob(filmElement.getAttribute("job"));
film.setName(filmElement.getAttribute(NAME));
film.setUrl(filmElement.getAttribute(URL));
person.addFilm(film);
}
}
people.add(person);
} catch (Exception error) {
logger.severe("PersonInfo: " + error.getMessage());
@@ -646,7 +673,7 @@ public class MovieDbParser {
}
}
}
return people;
}
@@ -688,7 +715,7 @@ public class MovieDbParser {
movie.setLastModifiedAt(DOMHelper.getValueFromElement(element, "last_modified_at"));
return movie;
}
/**
* Parse a "simple" Person in the form:
* <person>
themoviedbapi/src/main/java/com/moviejukebox/themoviedb/tools/WebBrowser.java
+137 -54
View File
@@ -1,14 +1,14 @@
/*
* Copyright (c) 2004-2011 YAMJ Members
* http://code.google.com/p/moviejukebox/people/list
*
* http://code.google.com/p/moviejukebox/people/list
*
* Web: http://code.google.com/p/moviejukebox/
*
*
* This software is licensed under a Creative Commons License
* See this page: http://code.google.com/p/moviejukebox/wiki/License
*
* For any reuse or distribution, you must make clear to others the
* license terms of this work.
*
* For any reuse or distribution, you must make clear to others the
* license terms of this work.
*/
package com.moviejukebox.themoviedb.tools;
@@ -26,14 +26,15 @@ import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.codec.binary.Base64;
/**
* Web browser with simple cookies support
*/
public final class WebBrowser {
private static Map<String, String> browserProperties = new HashMap<String, String>();
private static Map<String, Map<String, String>> cookies;
private static Map<String, Map<String, String>> cookies = new HashMap<String, Map<String, String>>();
private static String proxyHost = null;
private static String proxyPort = null;
private static String proxyUsername = null;
@@ -42,68 +43,87 @@ public final class WebBrowser {
private static int webTimeoutConnect = 25000; // 25 second timeout
private static int webTimeoutRead = 90000; // 90 second timeout
static {
browserProperties.put("User-Agent", "Mozilla/5.25 Netscape/5.0 (Windows; I; Win95)");
cookies = new HashMap<String, Map<String, String>>();
/**
* Constructor for WebBrowser.
* Does instantiates the browser properties.
*/
public WebBrowser() {
if (browserProperties.isEmpty()) {
browserProperties.put("User-Agent", "Mozilla/5.25 Netscape/5.0 (Windows; I; Win95)");
}
}
/**
* Request the web page at the specified URL
* @param url
* @return
* @throws IOException
*/
public static String request(String url) throws IOException {
return request(new URL(url));
}
/**
* Open a connection using proxy parameters if they exist.
* @param url
* @return
* @throws IOException
*/
public static URLConnection openProxiedConnection(URL url) throws IOException {
if (proxyHost != null) {
System.getProperties().put("proxySet", "true");
System.getProperties().put("proxyHost", proxyHost);
System.getProperties().put("proxyPort", proxyPort);
}
URLConnection cnx = url.openConnection();
if (proxyUsername != null) {
cnx.setRequestProperty("Proxy-Authorization", proxyEncodedPassword);
}
return cnx;
}
/**
* Request the web page at the specified URL
* @param url
* @return
* @throws IOException
*/
public static String request(URL url) throws IOException {
StringWriter content = null;
StringBuilder content = new StringBuilder();
BufferedReader in = null;
URLConnection cnx = null;
try {
content = new StringWriter();
cnx = openProxiedConnection(url);
BufferedReader in = null;
URLConnection cnx = null;
try {
cnx = openProxiedConnection(url);
sendHeader(cnx);
readHeader(cnx);
sendHeader(cnx);
readHeader(cnx);
in = new BufferedReader(new InputStreamReader(cnx.getInputStream(), getCharset(cnx)));
String line;
while ((line = in.readLine()) != null) {
content.write(line);
}
} finally {
if (in != null) {
in.close();
}
if ((cnx != null) && (cnx instanceof HttpURLConnection)) {
((HttpURLConnection)cnx).disconnect();
}
in = new BufferedReader(new InputStreamReader(cnx.getInputStream(), getCharset(cnx)));
String line;
while ((line = in.readLine()) != null) {
content.append(line);
}
return content.toString();
} finally {
if (content != null) {
content.close();
if (in != null) {
in.close();
}
if ((cnx != null) && (cnx instanceof HttpURLConnection)) {
((HttpURLConnection) cnx).disconnect();
}
}
return content.toString();
}
/**
* Set the header information for the connection
* @param cnx
*/
private static void sendHeader(URLConnection cnx) {
// send browser properties
for (Map.Entry<String, String> browserProperty : browserProperties.entrySet()) {
@@ -116,6 +136,11 @@ public final class WebBrowser {
}
}
/**
* Create the cookies for the header
* @param cnx
* @return
*/
private static String createCookieHeader(URLConnection cnx) {
String host = cnx.getURL().getHost();
StringBuilder cookiesHeader = new StringBuilder();
@@ -136,6 +161,10 @@ public final class WebBrowser {
return cookiesHeader.toString();
}
/**
* Read the header information into the cookies
* @param cnx
*/
private static void readHeader(URLConnection cnx) {
// read new cookies and update our cookies
for (Map.Entry<String, List<String>> header : cnx.getHeaderFields().entrySet()) {
@@ -172,6 +201,11 @@ public final class WebBrowser {
}
}
/**
* Determine the charset for the connection
* @param cnx
* @return
*/
private static Charset getCharset(URLConnection cnx) {
Charset charset = null;
// content type will be string like "text/html; charset=UTF-8" or "text/html"
@@ -191,59 +225,108 @@ public final class WebBrowser {
if (charset == null) {
charset = Charset.defaultCharset();
}
return charset;
}
/**
* Return the proxy host name
* @return
*/
public static String getProxyHost() {
return proxyHost;
}
/**
* Set the proxy host name
* @param tvdbProxyHost
*/
public static void setProxyHost(String tvdbProxyHost) {
WebBrowser.proxyHost = tvdbProxyHost;
}
/**
* Get the proxy port
* @return
*/
public static String getProxyPort() {
return proxyPort;
}
public static void setProxyPort(String tvdbProxyPort) {
WebBrowser.proxyPort = tvdbProxyPort;
/**
* Set the proxy port
* @param proxyPort
*/
public static void setProxyPort(String proxyPort) {
WebBrowser.proxyPort = proxyPort;
}
public static String getTvdbProxyUsername() {
/**
* Get the proxy username
* @return
*/
public static String getProxyUsername() {
return proxyUsername;
}
public static void setProxyUsername(String tvdbProxyUsername) {
WebBrowser.proxyUsername = tvdbProxyUsername;
/**
* Set the proxy username
* @param proxyUsername
*/
public static void setProxyUsername(String proxyUsername) {
WebBrowser.proxyUsername = proxyUsername;
}
/**
* Get the proxy password
* @return
*/
public static String getProxyPassword() {
return proxyPassword;
}
public static void setProxyPassword(String tvdbProxyPassword) {
WebBrowser.proxyPassword = tvdbProxyPassword;
if (proxyUsername != null) {
proxyEncodedPassword = proxyUsername + ":" + tvdbProxyPassword;
proxyEncodedPassword = Base64.base64Encode(proxyEncodedPassword);
/**
* Set the proxy password.
* Note this will automatically encode the password
* @param proxyPassword
*/
public static void setProxyPassword(String proxyPassword) {
WebBrowser.proxyPassword = proxyPassword;
if (proxyUsername != null && !proxyPassword.isEmpty()) {
proxyEncodedPassword = proxyUsername + ":" + proxyPassword;
proxyEncodedPassword = "Basic " + new String(Base64.encodeBase64((proxyUsername + ":" + proxyPassword).getBytes()));
}
}
/**
* Get the current web connect timeout value
* @return
*/
public static int getWebTimeoutConnect() {
return webTimeoutConnect;
}
/**
* Get the current web read timeout value
* @return
*/
public static int getWebTimeoutRead() {
return webTimeoutRead;
}
/**
* Set the web connect timeout value
* @param webTimeoutConnect
*/
public static void setWebTimeoutConnect(int webTimeoutConnect) {
WebBrowser.webTimeoutConnect = webTimeoutConnect;
}
/**
* Set the web read timeout value
* @param webTimeoutRead
*/
public static void setWebTimeoutRead(int webTimeoutRead) {
WebBrowser.webTimeoutRead = webTimeoutRead;
}