/* Copyright (c) 2008 Google Inc.

*

* Licensed under the Apache License, Version 2.0 (the "License");

* you may not use this file except in compliance with the License.

* You may obtain a copy of the License at

*

* http://www.apache.org/licenses/LICENSE-2.0

*

* Unless required by applicable law or agreed to in writing, software

* distributed under the License is distributed on an "AS IS" BASIS,

* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

* See the License for the specific language governing permissions and

* limitations under the License.

*/

package sample.docs;

import com.google.gdata.client.GoogleAuthTokenFactory.UserToken;

import com.google.gdata.client.GoogleService;

import com.google.gdata.client.Query;

import com.google.gdata.client.docs.DocsService;

import com.google.gdata.data.MediaContent;

import com.google.gdata.data.PlainTextConstruct;

import com.google.gdata.data.acl.AclEntry;

import com.google.gdata.data.acl.AclFeed;

import com.google.gdata.data.acl.AclRole;

import com.google.gdata.data.acl.AclScope;

import com.google.gdata.data.docs.DocumentEntry;

import com.google.gdata.data.docs.DocumentListEntry;

import com.google.gdata.data.docs.DocumentListFeed;

import com.google.gdata.data.docs.FolderEntry;

import com.google.gdata.data.docs.PresentationEntry;

import com.google.gdata.data.docs.RevisionFeed;

import com.google.gdata.data.docs.SpreadsheetEntry;

import com.google.gdata.data.media.MediaSource;

import com.google.gdata.util.AuthenticationException;

import com.google.gdata.util.ServiceException;

import java.io.File;

import java.io.FileOutputStream;

import java.io.IOException;

import java.io.InputStream;

import java.net.MalformedURLException;

import java.net.URL;

import java.util.HashMap;

import java.util.Iterator;

import java.util.Map;

import java.util.Set;

/**

* An application that serves as a sample to show how the Documents List Service

* can be used to search your documents, upload and download files, change

* sharing permission, file documents in folders, and view revisions history.

*

*

*

*/

public class DocumentList {

public DocsService service;

public GoogleService spreadsheetsService;

public static final String DEFAULT_HOST = "docs.google.com";

public static final String SPREADSHEETS_SERVICE_NAME = "wise";

public static final String SPREADSHEETS_HOST = "spreadsheets.google.com";

private final String URL_FEED = "/feeds";

private final String URL_DOWNLOAD = "/download";

private final String URL_DOCLIST_FEED = "/private/full";

private final String URL_DEFAULT = "/default";

private final String URL_FOLDERS = "/contents";

private final String URL_ACL = "/acl";

private final String URL_REVISIONS = "/revisions";

private final String URL_CATEGORY_DOCUMENT = "/-/document";

private final String URL_CATEGORY_SPREADSHEET = "/-/spreadsheet";

private final String URL_CATEGORY_PDF = "/-/pdf";

private final String URL_CATEGORY_PRESENTATION = "/-/presentation";

private final String URL_CATEGORY_STARRED = "/-/starred";

private final String URL_CATEGORY_TRASHED = "/-/trashed";

private final String URL_CATEGORY_FOLDER = "/-/folder";

private final String URL_CATEGORY_EXPORT = "/Export";

private final String PARAMETER_SHOW_FOLDERS = "showfolders=true";

private String host;

private final Map<String, String> DOWNLOAD_DOCUMENT_FORMATS;

{

DOWNLOAD_DOCUMENT_FORMATS = new HashMap<String, String>();

DOWNLOAD_DOCUMENT_FORMATS.put("doc", "doc");

DOWNLOAD_DOCUMENT_FORMATS.put("txt", "txt");

DOWNLOAD_DOCUMENT_FORMATS.put("odt", "odt");

DOWNLOAD_DOCUMENT_FORMATS.put("pdf", "pdf");

DOWNLOAD_DOCUMENT_FORMATS.put("png", "png");

DOWNLOAD_DOCUMENT_FORMATS.put("rtf", "rtf");

DOWNLOAD_DOCUMENT_FORMATS.put("html", "html");

DOWNLOAD_DOCUMENT_FORMATS.put("zip", "zip");

}

private final Map<String, String> DOWNLOAD_PRESENTATION_FORMATS;

{

DOWNLOAD_PRESENTATION_FORMATS = new HashMap<String, String>();

DOWNLOAD_PRESENTATION_FORMATS.put("pdf", "pdf");

DOWNLOAD_PRESENTATION_FORMATS.put("png", "png");

DOWNLOAD_PRESENTATION_FORMATS.put("ppt", "ppt");

DOWNLOAD_PRESENTATION_FORMATS.put("swf", "swf");

DOWNLOAD_PRESENTATION_FORMATS.put("txt", "txt");

}

private final Map<String, String> DOWNLOAD_SPREADSHEET_FORMATS;

{

DOWNLOAD_SPREADSHEET_FORMATS = new HashMap<String, String>();

DOWNLOAD_SPREADSHEET_FORMATS.put("xls", "xls");

DOWNLOAD_SPREADSHEET_FORMATS.put("ods", "ods");

DOWNLOAD_SPREADSHEET_FORMATS.put("pdf", "pdf");

DOWNLOAD_SPREADSHEET_FORMATS.put("csv", "csv");

DOWNLOAD_SPREADSHEET_FORMATS.put("tsv", "tsv");

DOWNLOAD_SPREADSHEET_FORMATS.put("html", "html");

}

/**

* Constructor.

*

* @param applicationName name of the application.

*

* @throws DocumentListException

*/

public DocumentList(String applicationName) throws DocumentListException {

this(applicationName, DEFAULT_HOST);

}

/**

* Constructor

*

* @param applicationName name of the application

* @param host the host that contains the feeds

*

* @throws DocumentListException

*/

public DocumentList(String applicationName, String host) throws DocumentListException {

if (host == null) {

throw new DocumentListException("null passed in required parameters");

}

service = new DocsService(applicationName);

// Creating a spreadsheets service is necessary for downloading spreadsheets

spreadsheetsService = new GoogleService(SPREADSHEETS_SERVICE_NAME, applicationName);

this.host = host;

}

/**

* Set user credentials based on a username and password.

*

* @param user username to log in with.

* @param pass password for the user logging in.

*

* @throws AuthenticationException

* @throws DocumentListException

*/

public void login(String user, String pass) throws AuthenticationException,

DocumentListException {

if (user == null || pass == null) {

throw new DocumentListException("null login credentials");

}

service.setUserCredentials(user, pass);

spreadsheetsService.setUserCredentials(user, pass);

}

/**

* Allow a user to login using an AuthSub token.

*

* @param token the token to be used when logging in.

*

* @throws AuthenticationException

* @throws DocumentListException

*/

public void loginWithAuthSubToken(String token) throws AuthenticationException,

DocumentListException {

if (token == null) {

throw new DocumentListException("null login credentials");

}

service.setAuthSubToken(token);

spreadsheetsService.setAuthSubToken(token);

}

/**

* Create a new item in the DocList.

*

* @param title the title of the document to be created.

* @param type the type of the document to be created. One of "spreadsheet",

* "presentation", or "document".

*

* @throws DocumentListException

* @throws ServiceException

* @throws IOException

* @throws MalformedURLException

*/

public DocumentListEntry createNew(String title, String type) throws MalformedURLException,

IOException, ServiceException,

DocumentListException {

if (title == null || type == null) {

throw new DocumentListException("null title or type");

}

DocumentListEntry newEntry = null;

if (type.equals("document")) {

newEntry = new DocumentEntry();

} else if (type.equals("presentation")) {

newEntry = new PresentationEntry();

} else if (type.equals("spreadsheet")) {

newEntry = new SpreadsheetEntry();

} else if (type.equals("folder")) {

newEntry = new FolderEntry();

}

newEntry.setTitle(new PlainTextConstruct(title));

return service.insert(buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED), newEntry);

}

/**

* Gets a feed containing the documents.

*

* @param category what types of documents to list:

* "all": lists all the doc objects (documents, spreadsheets, presentations)

* "folders": lists all doc objects including folders.

* "documents": lists only documents.

* "spreadsheets": lists only spreadsheets.

* "pdfs": lists only pdfs.

* "presentations": lists only presentations.

* "starred": lists only starred objects.

* "trashed": lists trashed objects.

*

* @throws IOException

* @throws MalformedURLException

* @throws ServiceException

* @throws DocumentListException

*/

public DocumentListFeed getDocsListFeed(String category) throws IOException,

MalformedURLException, ServiceException, DocumentListException {

if (category == null) {

throw new DocumentListException("null category");

}

URL url;

if (category.equals("all")) {

url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED);

} else if (category.equals("folders")) {

String[] parameters = {PARAMETER_SHOW_FOLDERS};

url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520URL_CATEGORY_FOLDER%2C%2520parameters);

} else if (category.equals("documents")) {

url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520URL_CATEGORY_DOCUMENT);

} else if (category.equals("spreadsheets")) {

url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520URL_CATEGORY_SPREADSHEET);

} else if (category.equals("pdfs")) {

url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520URL_CATEGORY_PDF);

} else if (category.equals("presentations")) {

url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520URL_CATEGORY_PRESENTATION);

} else if (category.equals("starred")) {

url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520URL_CATEGORY_STARRED);

} else if (category.equals("trashed")) {

url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520URL_CATEGORY_TRASHED);

} else {

return null;

}

return service.getFeed(url, DocumentListFeed.class);

}

/**

* Gets the entry for the provided object id.

*

* @param resourceId the resource id of the object to fetch an entry for.

*

* @throws IOException

* @throws MalformedURLException

* @throws ServiceException

* @throws DocumentListException

*/

public DocumentListEntry getDocsListEntry(String resourceId) throws IOException,

MalformedURLException, ServiceException, DocumentListException {

if (resourceId == null) {

throw new DocumentListException("null resourceId");

}

URL url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520%26quot%3B%2F%26quot%3B%2520%2B%2520resourceId);

return service.getEntry(url, DocumentListEntry.class);

}

/**

* Gets the feed for all the objects contained in a folder.

*

* @param folderResourceId the resource id of the folder to return the feed

* for the contents.

*

* @throws IOException

* @throws MalformedURLException

* @throws ServiceException

* @throws DocumentListException

*/

public DocumentListFeed getFolderDocsListFeed(String folderResourceId) throws IOException,

MalformedURLException, ServiceException, DocumentListException {

if (folderResourceId == null) {

throw new DocumentListException("null folderResourceId");

}

URL url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520%26quot%3B%2F%26quot%3B%2520%2B%2520folderResourceId%253C%2Fdiv%253E%253C%2Fdiv%253E%253C%2Fdiv%253E%253Cdiv%2520class%3D%2522react-code-text%2520react-code-line-contents%2522%2520style%3D%2522min-height%3Aauto%2522%253E%253Cdiv%253E%253Cdiv%2520id%3D%2522LC314%2522%2520class%3D%2522react-file-line%2520html-div%2522%2520data-testid%3D%2522code-cell%2522%2520data-line-number%3D%2522314%2522%2520style%3D%2522position%3Arelative%2522%253E%2520%2520%2520%2520%2520%2520%2520%2520%2B%2520URL_FOLDERS);

return service.getFeed(url, DocumentListFeed.class);

}

/**

* Gets a feed containing the documents.

*

* @param resourceId the resource id of the object to fetch revisions for.

*

* @throws IOException

* @throws MalformedURLException

* @throws ServiceException

* @throws DocumentListException

*/

public RevisionFeed getRevisionsFeed(String resourceId) throws IOException,

MalformedURLException, ServiceException, DocumentListException {

if (resourceId == null) {

throw new DocumentListException("null resourceId");

}

URL url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520%26quot%3B%2F%26quot%3B%2520%2B%2520resourceId%253C%2Fdiv%253E%253C%2Fdiv%253E%253C%2Fdiv%253E%253Cdiv%2520class%3D%2522react-code-text%2520react-code-line-contents%2522%2520style%3D%2522min-height%3Aauto%2522%253E%253Cdiv%253E%253Cdiv%2520id%3D%2522LC335%2522%2520class%3D%2522react-file-line%2520html-div%2522%2520data-testid%3D%2522code-cell%2522%2520data-line-number%3D%2522335%2522%2520style%3D%2522position%3Arelative%2522%253E%2520%2520%2520%2520%2520%2520%2520%2520%2B%2520URL_REVISIONS);

return service.getFeed(url, RevisionFeed.class);

}

/**

* Search the documents, and return a feed of docs that match.

*

* @param searchParameters parameters to be used in searching criteria.

*

* @throws IOException

* @throws MalformedURLException

* @throws ServiceException

* @throws DocumentListException

*/

public DocumentListFeed search(Map<String, String> searchParameters) throws IOException,

MalformedURLException, ServiceException, DocumentListException {

return search(searchParameters, null);

}

/**

* Search the documents, and return a feed of docs that match.

*

* @param searchParameters parameters to be used in searching criteria.

* accepted parameters are:

* "q": Typical search query

* "alt":

* "author":

* "updated-min": Lower bound on the last time a document' content was changed.

* "updated-max": Upper bound on the last time a document' content was changed.

* "edited-min": Lower bound on the last time a document was edited by the

* current user. This value corresponds to the app:edited value in the

* Atom entry, which represents changes to the document's content or metadata.

* "edited-max": Upper bound on the last time a document was edited by the

* current user. This value corresponds to the app:edited value in the

* Atom entry, which represents changes to the document's content or metadata.

* "title": Specifies the search terms for the title of a document.

* This parameter used without title-exact will only submit partial queries, not exact

* queries.

* "title-exact": Specifies whether the title query should be taken as an exact string.

* Meaningless without title. Possible values are true and false.

* "opened-min": Bounds on the last time a document was opened by the current user.

* Use the RFC 3339 timestamp format. For example: 2005-08-09T10:57:00-08:00

* "opened-max": Bounds on the last time a document was opened by the current user.

* Use the RFC 3339 timestamp format. For example: 2005-08-09T10:57:00-08:00

* "owner": Searches for documents with a specific owner.

* Use the email address of the owner.

* "writer": Searches for documents which can be written to by specific users.

* Use a single email address or a comma separated list of email addresses.

* "reader": Searches for documents which can be read by specific users.

* Use a single email address or a comma separated list of email addresses.

* "showfolders": Specifies whether the query should return folders as well as documents.

* Possible values are true and false.

* @param category define the category to search. (documents, spreadsheets, presentations,

* starred, trashed, folders)

*

* @throws IOException

* @throws MalformedURLException

* @throws ServiceException

* @throws DocumentListException

*/

public DocumentListFeed search(Map<String, String> searchParameters, String category)

throws IOException, MalformedURLException, ServiceException, DocumentListException {

if (searchParameters == null) {

throw new DocumentListException("searchParameters null");

}

URL url;

if (category == null || category.equals("")) {

url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED);

} else if (category.equals("documents")) {

url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520URL_CATEGORY_DOCUMENT);

} else if (category.equals("spreadsheets")) {

url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520URL_CATEGORY_SPREADSHEET);

} else if (category.equals("presentations")) {

url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520URL_CATEGORY_PRESENTATION);

} else if (category.equals("starred")) {

url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520URL_CATEGORY_STARRED);

} else if (category.equals("trashed")) {

url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520URL_CATEGORY_TRASHED);

} else if (category.equals("folders")) {

url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520URL_CATEGORY_FOLDER);

} else {

throw new DocumentListException("invaild category");

}

Query qry = new Query(url);

for (String key : searchParameters.keySet()) {

qry.setStringCustomParameter(key, searchParameters.get(key));

}

return service.query(qry, DocumentListFeed.class);

}

/**

* Upload a file.

*

* @param filepath path to uploaded file.

* @param title title to use for uploaded file.

*

* @throws ServiceException when the request causes an error in the Doclist

* service.

* @throws IOException when an error occurs in communication with the Doclist

* service.

* @throws DocumentListException

*/

public DocumentListEntry uploadFile(String filepath, String title)

throws IOException, ServiceException, DocumentListException {

if (filepath == null || title == null) {

throw new DocumentListException("null passed in for required parameters");

}

File file = new File(filepath);

String mimeType = DocumentListEntry.MediaType.fromFileName(file.getName())

.getMimeType();

DocumentEntry newDocument = new DocumentEntry();

newDocument.setFile(file, mimeType);

newDocument.setTitle(new PlainTextConstruct(title));

return service

.insert(buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED), newDocument);

}

/**

* Trash an object.

*

* @param resourceId the resource id of object to be trashed.

* @param delete true to delete the permanently, false to move it to the

* trash.

*

* @throws IOException

* @throws MalformedURLException

* @throws ServiceException

* @throws DocumentListException

*/

public void trashObject(String resourceId, boolean delete) throws IOException,

MalformedURLException, ServiceException, DocumentListException {

if (resourceId == null) {

throw new DocumentListException("null resourceId");

}

String feedUrl = URL_DEFAULT + URL_DOCLIST_FEED + "/" + resourceId;

if (delete) {

feedUrl += "?delete=true";

}

service.delete(buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FfeedUrl), getDocsListEntry(resourceId).getEtag());

}

/**

* Remove an object from a folder.

*

* @param resourceId the resource id of an object to be removed from the

* folder.

* @param folderResourceId the resource id of the folder to remove the object

* from.

*

* @throws IOException

* @throws MalformedURLException

* @throws ServiceException

* @throws DocumentListException

*/

public void removeFromFolder(String resourceId, String folderResourceId)

throws IOException, MalformedURLException, ServiceException,

DocumentListException {

if (resourceId == null || folderResourceId == null) {

throw new DocumentListException("null passed in for required parameters");

}

URL url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520%26quot%3B%2F%26quot%3B%2520%2B%2520folderResourceId%253C%2Fdiv%253E%253C%2Fdiv%253E%253C%2Fdiv%253E%253Cdiv%2520class%3D%2522react-code-text%2520react-code-line-contents%2522%2520style%3D%2522min-height%3Aauto%2522%253E%253Cdiv%253E%253Cdiv%2520id%3D%2522LC508%2522%2520class%3D%2522react-file-line%2520html-div%2522%2520data-testid%3D%2522code-cell%2522%2520data-line-number%3D%2522508%2522%2520style%3D%2522position%3Arelative%2522%253E%2520%2520%2520%2520%2520%2520%2520%2520%2B%2520URL_FOLDERS%2520%2B%2520%26quot%3B%2F%26quot%3B%2520%2B%2520resourceId);

service.delete(url, getDocsListEntry(resourceId).getEtag());

}

/**

* Downloads a file.

*

* @param exportUrl the full url of the export link to download the file from.

* @param filepath path and name of the object to be saved as.

*

* @throws IOException

* @throws MalformedURLException

* @throws ServiceException

* @throws DocumentListException

*/

public void downloadFile(URL exportUrl, String filepath) throws IOException,

MalformedURLException, ServiceException, DocumentListException {

if (exportUrl == null || filepath == null) {

throw new DocumentListException("null passed in for required parameters");

}

MediaContent mc = new MediaContent();

mc.setUri(exportUrl.toString());

MediaSource ms = service.getMedia(mc);

InputStream inStream = null;

FileOutputStream outStream = null;

try {

inStream = ms.getInputStream();

outStream = new FileOutputStream(filepath);

int c;

while ((c = inStream.read()) != -1) {

outStream.write(c);

}

} finally {

if (inStream != null) {

inStream.close();

}

if (outStream != null) {

outStream.flush();

outStream.close();

}

}

}

/**

* Downloads a spreadsheet file.

*

* @param filepath path and name of the object to be saved as.

* @param resourceId the resource id of the object to be downloaded.

* @param format format to download the file to. The following file types are

* supported: spreadsheets: "ods", "pdf", "xls", "csv", "html", "tsv"

*

* @throws IOException

* @throws MalformedURLException

* @throws ServiceException

* @throws DocumentListException

*/

public void downloadSpreadsheet(String resourceId, String filepath,

String format) throws IOException, MalformedURLException,

ServiceException, DocumentListException {

if (resourceId == null || filepath == null || format == null) {

throw new DocumentListException("null passed in for required parameters");

}

UserToken docsToken = (UserToken) service.getAuthTokenFactory()

.getAuthToken();

UserToken spreadsheetsToken = (UserToken) spreadsheetsService

.getAuthTokenFactory().getAuthToken();

service.setUserToken(spreadsheetsToken.getValue());

HashMap<String, String> parameters = new HashMap<String, String>();

parameters

.put("key", resourceId.substring(resourceId.lastIndexOf(':') + 1));

parameters.put("exportFormat", format);

// If exporting to .csv or .tsv, add the gid parameter to specify which

// sheet to export

if (format.equals(DOWNLOAD_SPREADSHEET_FORMATS.get("csv"))

|| format.equals(DOWNLOAD_SPREADSHEET_FORMATS.get("tsv"))) {

parameters.put("gid", "0"); // download only the first sheet

}

URL url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FSPREADSHEETS_HOST%2C%2520URL_DOWNLOAD%2520%2B%2520%26quot%3B%2Fspreadsheets%26quot%3B%253C%2Fdiv%253E%253C%2Fdiv%253E%253C%2Fdiv%253E%253Cdiv%2520class%3D%2522react-code-text%2520react-code-line-contents%2522%2520style%3D%2522min-height%3Aauto%2522%253E%253Cdiv%253E%253Cdiv%2520id%3D%2522LC594%2522%2520class%3D%2522react-file-line%2520html-div%2522%2520data-testid%3D%2522code-cell%2522%2520data-line-number%3D%2522594%2522%2520style%3D%2522position%3Arelative%2522%253E%2520%2520%2520%2520%2520%2520%2520%2520%2B%2520URL_CATEGORY_EXPORT%2C%2520parameters);

downloadFile(url, filepath);

// Restore docs token for our DocList client

service.setUserToken(docsToken.getValue());

}

/**

* Downloads a document.

*

* @param filepath path and name of the object to be saved as.

* @param resourceId the resource id of the object to be downloaded.

* @param format format to download the file to. The following file types are

* supported: documents: "doc", "txt", "odt", "png", "pdf", "rtf",

* "html"

*

* @throws IOException

* @throws MalformedURLException

* @throws ServiceException

* @throws DocumentListException

*/

public void downloadDocument(String resourceId, String filepath, String format)

throws IOException, MalformedURLException, ServiceException,

DocumentListException {

if (resourceId == null || filepath == null || format == null) {

throw new DocumentListException("null passed in for required parameters");

}

String[] parameters = {"docID=" + resourceId, "exportFormat=" + format};

URL url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DOWNLOAD%2520%2B%2520%26quot%3B%2Fdocuments%26quot%3B%2520%2B%2520URL_CATEGORY_EXPORT%2C%253C%2Fdiv%253E%253C%2Fdiv%253E%253C%2Fdiv%253E%253Cdiv%2520class%3D%2522react-code-text%2520react-code-line-contents%2522%2520style%3D%2522min-height%3Aauto%2522%253E%253Cdiv%253E%253Cdiv%2520id%3D%2522LC624%2522%2520class%3D%2522react-file-line%2520html-div%2522%2520data-testid%3D%2522code-cell%2522%2520data-line-number%3D%2522624%2522%2520style%3D%2522position%3Arelative%2522%253E%2520%2520%2520%2520%2520%2520%2520%2520parameters);

downloadFile(url, filepath);

}

/**

* Downloads a presentation.

*

* @param filepath path and name of the object to be saved as.

* @param resourceId the resource id of the object to be downloaded.

* @param format format to download the file to. The following file types are

* supported: presentations: "pdf", "ppt", "png", "swf", "txt"

*

* @throws IOException

* @throws MalformedURLException

* @throws ServiceException

* @throws DocumentListException

*/

public void downloadPresentation(String resourceId, String filepath,

String format) throws IOException, MalformedURLException,

ServiceException, DocumentListException {

if (resourceId == null || filepath == null || format == null) {

throw new DocumentListException("null passed in for required parameters");

}

String[] parameters = {"docID=" + resourceId, "exportFormat=" + format};

URL url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DOWNLOAD%2520%2B%2520%26quot%3B%2Fpresentations%26quot%3B%2520%2B%2520URL_CATEGORY_EXPORT%2C%253C%2Fdiv%253E%253C%2Fdiv%253E%253C%2Fdiv%253E%253Cdiv%2520class%3D%2522react-code-text%2520react-code-line-contents%2522%2520style%3D%2522min-height%3Aauto%2522%253E%253Cdiv%253E%253Cdiv%2520id%3D%2522LC651%2522%2520class%3D%2522react-file-line%2520html-div%2522%2520data-testid%3D%2522code-cell%2522%2520data-line-number%3D%2522651%2522%2520style%3D%2522position%3Arelative%2522%253E%2520%2520%2520%2520%2520%2520%2520%2520parameters);

downloadFile(url, filepath);

}

/**

* Moves a object to a folder.

*

* @param resourceId the resource id of the object to be moved to the folder.

* @param folderId the id of the folder to move the object to.

*

* @throws IOException

* @throws MalformedURLException

* @throws ServiceException

* @throws DocumentListException

*/

public DocumentListEntry moveObjectToFolder(String resourceId, String folderId)

throws IOException, MalformedURLException, ServiceException, DocumentListException {

if (resourceId == null || folderId == null) {

throw new DocumentListException("null passed in for required parameters");

}

DocumentListEntry doc = new DocumentListEntry();

doc.setId(buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520%26quot%3B%2F%26quot%3B%2520%2B%2520resourceId).toString());

URL url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520%26quot%3B%2F%26quot%3B%2520%2B%2520folderId%2520%2B%2520URL_FOLDERS);

return service.insert(url, doc);

}

/**

* Gets the access control list for a object.

*

* @param resourceId the resource id of the object to retrieve the ACL for.

*

* @throws IOException

* @throws MalformedURLException

* @throws ServiceException

* @throws DocumentListException

*/

public AclFeed getAclFeed(String resourceId) throws IOException,

MalformedURLException, ServiceException, DocumentListException {

if (resourceId == null) {

throw new DocumentListException("null resourceId");

}

URL url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520%26quot%3B%2F%26quot%3B%2520%2B%2520resourceId%253C%2Fdiv%253E%253C%2Fdiv%253E%253C%2Fdiv%253E%253Cdiv%2520class%3D%2522react-code-text%2520react-code-line-contents%2522%2520style%3D%2522min-height%3Aauto%2522%253E%253Cdiv%253E%253Cdiv%2520id%3D%2522LC698%2522%2520class%3D%2522react-file-line%2520html-div%2522%2520data-testid%3D%2522code-cell%2522%2520data-line-number%3D%2522698%2522%2520style%3D%2522position%3Arelative%2522%253E%2520%2520%2520%2520%2520%2520%2520%2520%2B%2520URL_ACL);

return service.getFeed(url, AclFeed.class);

}

/**

* Add an ACL role to an object.

*

* @param role the role of the ACL to be added to the object.

* @param scope the scope for the ACL.

* @param resourceId the resource id of the object to set the ACL for.

*

* @throws IOException

* @throws MalformedURLException

* @throws ServiceException

* @throws DocumentListException

*/

public AclEntry addAclRole(AclRole role, AclScope scope, String resourceId)

throws IOException, MalformedURLException, ServiceException,

DocumentListException {

if (role == null || scope == null || resourceId == null) {

throw new DocumentListException("null passed in for required parameters");

}

AclEntry entry = new AclEntry();

entry.setRole(role);

entry.setScope(scope);

URL url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520%26quot%3B%2F%26quot%3B%2520%2B%2520resourceId%2520%2B%2520URL_ACL);

return service.insert(url, entry);

}

/**

* Change the ACL role of a file.

*

* @param role the new role of the ACL to be updated.

* @param scope the new scope for the ACL.

* @param resourceId the resource id of the object to be updated.

*

* @throws IOException

* @throws MalformedURLException

* @throws ServiceException

* @throws DocumentListException

*/

public AclEntry changeAclRole(AclRole role, AclScope scope, String resourceId)

throws IOException, ServiceException, DocumentListException {

if (role == null || scope == null || resourceId == null) {

throw new DocumentListException("null passed in for required parameters");

}

URL url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520%26quot%3B%2F%26quot%3B%2520%2B%2520resourceId%253C%2Fdiv%253E%253C%2Fdiv%253E%253C%2Fdiv%253E%253Cdiv%2520class%3D%2522react-code-text%2520react-code-line-contents%2522%2520style%3D%2522min-height%3Aauto%2522%253E%253Cdiv%253E%253Cdiv%2520id%3D%2522LC749%2522%2520class%3D%2522react-file-line%2520html-div%2522%2520data-testid%3D%2522code-cell%2522%2520data-line-number%3D%2522749%2522%2520style%3D%2522position%3Arelative%2522%253E%2520%2520%2520%2520%2520%2520%2520%2520%2B%2520URL_ACL);

return service.update(url, scope, role);

}

/**

* Remove an ACL role from a object.

*

* @param scope scope of the ACL to be removed.

* @param email email address to remove the role of.

* @param resourceId the resource id of the object to remove the role from.

*

* @throws IOException

* @throws MalformedURLException

* @throws ServiceException

* @throws DocumentListException

*/

public void removeAclRole(String scope, String email, String resourceId) throws IOException,

MalformedURLException, ServiceException, DocumentListException {

if (scope == null || email == null || resourceId == null) {

throw new DocumentListException("null passed in for required parameters");

}

URL url = buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FURL_DEFAULT%2520%2B%2520URL_DOCLIST_FEED%2520%2B%2520%26quot%3B%2F%26quot%3B%2520%2B%2520resourceId%253C%2Fdiv%253E%253C%2Fdiv%253E%253C%2Fdiv%253E%253Cdiv%2520class%3D%2522react-code-text%2520react-code-line-contents%2522%2520style%3D%2522min-height%3Aauto%2522%253E%253Cdiv%253E%253Cdiv%2520id%3D%2522LC773%2522%2520class%3D%2522react-file-line%2520html-div%2522%2520data-testid%3D%2522code-cell%2522%2520data-line-number%3D%2522773%2522%2520style%3D%2522position%3Arelative%2522%253E%2520%2520%2520%2520%2520%2520%2520%2520%2B%2520URL_ACL%2520%2B%2520%26quot%3B%2F%26quot%3B%2520%2B%2520scope%2520%2B%2520%26quot%3B%253A%26quot%3B%2520%2B%2520email);

service.delete(url);

}

/**

* Returns the format code based on a file extension, and object id.

*

* @param resourceId the resource id of the object you want the format for.

* @param ext extension of the file you want the format for.

*

* @throws DocumentListException

*/

public String getDownloadFormat(String resourceId, String ext) throws DocumentListException {

if (resourceId == null || ext == null) {

throw new DocumentListException("null passed in for required parameters");

}

if (resourceId.indexOf("document") == 0) {

if (DOWNLOAD_DOCUMENT_FORMATS.containsKey(ext)) {

return DOWNLOAD_DOCUMENT_FORMATS.get(ext);

}

} else if (resourceId.indexOf("presentation") == 0) {

if (DOWNLOAD_PRESENTATION_FORMATS.containsKey(ext)) {

return DOWNLOAD_PRESENTATION_FORMATS.get(ext);

}

} else if (resourceId.indexOf("spreadsheet") == 0) {

if (DOWNLOAD_SPREADSHEET_FORMATS.containsKey(ext)) {

return DOWNLOAD_SPREADSHEET_FORMATS.get(ext);

}

}

throw new DocumentListException("invalid document type");

}

/**

* Gets the suffix of the resourceId. If the resourceId is

* "document:dh3bw3j_0f7xmjhd8", "dh3bw3j_0f7xmjhd8" will be returned.

*

* @param resourceId the resource id to extract the suffix from.

*

* @throws DocumentListException

*/

public String getResourceIdSuffix(String resourceId) throws DocumentListException {

if (resourceId == null) {

throw new DocumentListException("null resourceId");

}

if (resourceId.indexOf("%3A") != -1) {

return resourceId.substring(resourceId.lastIndexOf("%3A") + 3);

} else if (resourceId.indexOf(":") != -1) {

return resourceId.substring(resourceId.lastIndexOf(":") + 1);

}

throw new DocumentListException("Bad resourceId");

}

/**

* Gets the prefix of the resourceId. If the resourceId is

* "document:dh3bw3j_0f7xmjhd8", "document" will be returned.

*

* @param resourceId the resource id to extract the suffix from.

*

* @throws DocumentListException

*/

public String getResourceIdPrefix(String resourceId) throws DocumentListException {

if (resourceId == null) {

throw new DocumentListException("null resourceId");

}

if (resourceId.indexOf("%3A") != -1) {

return resourceId.substring(0, resourceId.indexOf("%3A"));

} else if (resourceId.indexOf(":") != -1) {

return resourceId.substring(0, resourceId.indexOf(":"));

} else {

throw new DocumentListException("Bad resourceId");

}

}

/**

* Builds a URL from a patch.

*

* @param path the path to add to the protocol/host

*

* @throws MalformedURLException

* @throws DocumentListException

*/

private URL buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FString%2520path) throws MalformedURLException, DocumentListException {

if (path == null) {

throw new DocumentListException("null path");

}

return buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2Fpath%2C%2520null);

}

/**

* Builds a URL with parameters.

*

* @param path the path to add to the protocol/host

* @param parameters parameters to be added to the URL.

*

* @throws MalformedURLException

* @throws DocumentListException

*/

private URL buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FString%2520path%2C%2520String%5B%5D%2520parameters)

throws MalformedURLException, DocumentListException {

if (path == null) {

throw new DocumentListException("null path");

}

return buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2Fhost%2C%2520path%2C%2520parameters);

}

/**

* Builds a URL with parameters.

*

* @param domain the domain of the server

* @param path the path to add to the protocol/host

* @param parameters parameters to be added to the URL.

*

* @throws MalformedURLException

* @throws DocumentListException

*/

private URL buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FString%2520domain%2C%2520String%2520path%2C%2520String%5B%5D%2520parameters)

throws MalformedURLException, DocumentListException {

if (path == null) {

throw new DocumentListException("null path");

}

StringBuffer url = new StringBuffer();

url.append("https://" + domain + URL_FEED + path);

if (parameters != null && parameters.length > 0) {

url.append("?");

for (int i = 0; i < parameters.length; i++) {

url.append(parameters[i]);

if (i != (parameters.length - 1)) {

url.append("&");

}

}

}

return new url(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2Furl.toString%28));

}

/**

* Builds a URL with parameters.

*

* @param domain the domain of the server

* @param path the path to add to the protocol/host

* @param parameters parameters to be added to the URL as key value pairs.

*

* @throws MalformedURLException

* @throws DocumentListException

*/

private URL buildurl(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2FString%2520domain%2C%2520String%2520path%2C%2520Map%26lt%3BString%2C%2520String%26gt%3B%2520parameters)

throws MalformedURLException, DocumentListException {

if (path == null) {

throw new DocumentListException("null path");

}

StringBuffer url = new StringBuffer();

url.append("https://" + domain + URL_FEED + path);

if (parameters != null && parameters.size() > 0) {

Set<Map.Entry<String, String>> params = parameters.entrySet();

Iterator<Map.Entry<String, String>> itr = params.iterator();

url.append("?");

while (itr.hasNext()) {

Map.Entry<String, String> entry = itr.next();

url.append(entry.getKey() + "=" + entry.getValue());

if (itr.hasNext()) {

url.append("&");

}

}

}

return new url(/sitelet?url=https%3A%2F%2Fgithub.com%2Fgoogle%2Fgdata-java-client%2Fblob%2Fmaster%2Fjava%2Fsample%2Fdocs%2Furl.toString%28));

}

}