Adding instrumentation to locate the source of jankiness
[chromium-blink-merge.git] / chrome / browser / drive / drive_api_util.h
blob69f30bbd40b7eeeb111603a9485877166350a8a2
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef CHROME_BROWSER_DRIVE_DRIVE_API_UTIL_H_
6 #define CHROME_BROWSER_DRIVE_DRIVE_API_UTIL_H_
8 #include <string>
10 #include "base/memory/scoped_ptr.h"
11 #include "google_apis/drive/drive_common_callbacks.h"
12 #include "google_apis/drive/gdata_errorcode.h"
14 class GURL;
16 namespace base {
17 class FilePath;
18 class Value;
19 } // namespace base
21 namespace google_apis {
22 class ChangeList;
23 class ChangeResource;
24 class FileList;
25 class FileResource;
26 class ResourceEntry;
27 class ResourceList;
28 } // namespace google_apis
30 namespace drive {
31 namespace util {
33 // Google Apps MIME types:
34 const char kGoogleDocumentMimeType[] = "application/vnd.google-apps.document";
35 const char kGoogleDrawingMimeType[] = "application/vnd.google-apps.drawing";
36 const char kGooglePresentationMimeType[] =
37 "application/vnd.google-apps.presentation";
38 const char kGoogleSpreadsheetMimeType[] =
39 "application/vnd.google-apps.spreadsheet";
40 const char kGoogleTableMimeType[] = "application/vnd.google-apps.table";
41 const char kGoogleFormMimeType[] = "application/vnd.google-apps.form";
42 const char kDriveFolderMimeType[] = "application/vnd.google-apps.folder";
44 // Escapes ' to \' in the |str|. This is designed to use for string value of
45 // search parameter on Drive API v2.
46 // See also: https://developers.google.com/drive/search-parameters
47 std::string EscapeQueryStringValue(const std::string& str);
49 // Parses the query, and builds a search query for Drive API v2.
50 // This only supports:
51 // Regular query (e.g. dog => fullText contains 'dog')
52 // Conjunctions
53 // (e.g. dog cat => fullText contains 'dog' and fullText contains 'cat')
54 // Exclusion query (e.g. -cat => not fullText contains 'cat').
55 // Quoted query (e.g. "dog cat" => fullText contains 'dog cat').
56 // See also: https://developers.google.com/drive/search-parameters
57 std::string TranslateQuery(const std::string& original_query);
59 // Extracts resource_id out of edit url.
60 std::string ExtractResourceIdFromUrl(const GURL& url);
62 // If |resource_id| is in the old resource ID format used by WAPI, converts it
63 // into the new format.
64 std::string CanonicalizeResourceId(const std::string& resource_id);
66 // Converts FileResource to ResourceEntry.
67 scoped_ptr<google_apis::ResourceEntry>
68 ConvertFileResourceToResourceEntry(
69 const google_apis::FileResource& file_resource);
71 // Converts ChangeResource to ResourceEntry.
72 scoped_ptr<google_apis::ResourceEntry>
73 ConvertChangeResourceToResourceEntry(
74 const google_apis::ChangeResource& change_resource);
76 // Converts FileList to ResourceList.
77 scoped_ptr<google_apis::ResourceList>
78 ConvertFileListToResourceList(const google_apis::FileList& file_list);
80 // Converts ChangeList to ResourceList.
81 scoped_ptr<google_apis::ResourceList>
82 ConvertChangeListToResourceList(const google_apis::ChangeList& change_list);
84 // Returns the (base-16 encoded) MD5 digest of the file content at |file_path|,
85 // or an empty string if an error is found.
86 std::string GetMd5Digest(const base::FilePath& file_path);
88 // Returns preferred file extension for hosted documents which have given mime
89 // type.
90 std::string GetHostedDocumentExtension(const std::string& mime_type);
92 // Returns true if the given mime type is corresponding to one of known hosted
93 // document types.
94 bool IsKnownHostedDocumentMimeType(const std::string& mime_type);
96 // Returns true if the given file path has an extension corresponding to one of
97 // hosted document types.
98 bool HasHostedDocumentExtension(const base::FilePath& path);
100 } // namespace util
101 } // namespace drive
103 #endif // CHROME_BROWSER_DRIVE_DRIVE_API_UTIL_H_