Update CrOS OOBE throbber to MD throbber; delete old asset
[chromium-blink-merge.git] / chrome / common / chrome_utility_messages.h
blobe7ff9a48817b09d377f08151c2adc112e40ddbe8
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 // Multiply-included message file, so no include guard.
7 #if defined(OS_WIN)
8 #include <Windows.h>
9 #endif // defined(OS_WIN)
11 #include <string>
12 #include <vector>
14 #include "base/files/file_path.h"
15 #include "base/strings/string16.h"
16 #include "base/tuple.h"
17 #include "base/values.h"
18 #include "chrome/common/safe_browsing/zip_analyzer_results.h"
19 #include "ipc/ipc_message_macros.h"
20 #include "ipc/ipc_platform_file.h"
21 #include "third_party/skia/include/core/SkBitmap.h"
22 #include "ui/gfx/ipc/gfx_param_traits.h"
24 #if defined(FULL_SAFE_BROWSING)
25 #include "chrome/common/safe_browsing/ipc_protobuf_message_macros.h"
26 #include "chrome/common/safe_browsing/protobuf_message_param_traits.h"
27 #endif
29 // Singly-included section for typedefs.
30 #ifndef CHROME_COMMON_CHROME_UTILITY_MESSAGES_H_
31 #define CHROME_COMMON_CHROME_UTILITY_MESSAGES_H_
33 #if defined(OS_WIN)
34 // A vector of filters, each being a Tuple containing a display string (i.e.
35 // "Text Files") and a filter pattern (i.e. "*.txt").
36 typedef std::vector<base::Tuple<base::string16, base::string16>>
37 GetOpenFileNameFilter;
38 #endif // OS_WIN
40 #endif // CHROME_COMMON_CHROME_UTILITY_MESSAGES_H_
42 #define IPC_MESSAGE_START ChromeUtilityMsgStart
44 #if defined(FULL_SAFE_BROWSING)
45 IPC_ENUM_TRAITS_VALIDATE(
46 safe_browsing::ClientDownloadRequest_DownloadType,
47 safe_browsing::ClientDownloadRequest_DownloadType_IsValid(value))
49 IPC_PROTOBUF_MESSAGE_TRAITS_BEGIN(safe_browsing::ClientDownloadRequest_Digests)
50 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(sha256)
51 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(sha1)
52 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(md5)
53 IPC_PROTOBUF_MESSAGE_TRAITS_END()
55 IPC_PROTOBUF_MESSAGE_TRAITS_BEGIN(
56 safe_browsing::ClientDownloadRequest_CertificateChain_Element)
57 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(certificate)
58 IPC_PROTOBUF_MESSAGE_TRAITS_END()
60 IPC_PROTOBUF_MESSAGE_TRAITS_BEGIN(
61 safe_browsing::ClientDownloadRequest_CertificateChain)
62 IPC_PROTOBUF_MESSAGE_TRAITS_REPEATED_COMPLEX_MEMBER(element)
63 IPC_PROTOBUF_MESSAGE_TRAITS_END()
65 IPC_PROTOBUF_MESSAGE_TRAITS_BEGIN(
66 safe_browsing::ClientDownloadRequest_SignatureInfo)
67 IPC_PROTOBUF_MESSAGE_TRAITS_REPEATED_COMPLEX_MEMBER(certificate_chain)
68 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_FUNDAMENTAL_MEMBER(trusted)
69 IPC_PROTOBUF_MESSAGE_TRAITS_REPEATED_COMPLEX_MEMBER(signed_data)
70 IPC_PROTOBUF_MESSAGE_TRAITS_END()
72 IPC_PROTOBUF_MESSAGE_TRAITS_BEGIN(
73 safe_browsing::ClientDownloadRequest_PEImageHeaders_DebugData)
74 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(directory_entry)
75 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(raw_data)
76 IPC_PROTOBUF_MESSAGE_TRAITS_END()
78 IPC_PROTOBUF_MESSAGE_TRAITS_BEGIN(
79 safe_browsing::ClientDownloadRequest_PEImageHeaders)
80 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(dos_header)
81 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(file_header)
82 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(optional_headers32)
83 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(optional_headers64)
84 IPC_PROTOBUF_MESSAGE_TRAITS_REPEATED_COMPLEX_MEMBER(section_header)
85 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(export_section_data)
86 IPC_PROTOBUF_MESSAGE_TRAITS_REPEATED_COMPLEX_MEMBER(debug_data)
87 IPC_PROTOBUF_MESSAGE_TRAITS_END()
89 IPC_PROTOBUF_MESSAGE_TRAITS_BEGIN(
90 safe_browsing::ClientDownloadRequest_ImageHeaders)
91 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(pe_headers)
92 IPC_PROTOBUF_MESSAGE_TRAITS_END()
94 IPC_PROTOBUF_MESSAGE_TRAITS_BEGIN(
95 safe_browsing::ClientDownloadRequest_ArchivedBinary)
96 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(file_basename)
97 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_FUNDAMENTAL_MEMBER(download_type)
98 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(digests)
99 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_FUNDAMENTAL_MEMBER(length)
100 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(signature)
101 IPC_PROTOBUF_MESSAGE_TRAITS_OPTIONAL_COMPLEX_MEMBER(image_headers)
102 IPC_PROTOBUF_MESSAGE_TRAITS_END()
104 IPC_STRUCT_TRAITS_BEGIN(safe_browsing::zip_analyzer::Results)
105 IPC_STRUCT_TRAITS_MEMBER(success)
106 IPC_STRUCT_TRAITS_MEMBER(has_executable)
107 IPC_STRUCT_TRAITS_MEMBER(has_archive)
108 IPC_STRUCT_TRAITS_MEMBER(archived_binary)
109 IPC_STRUCT_TRAITS_MEMBER(archived_archive_filetypes)
110 IPC_STRUCT_TRAITS_END()
111 #endif // FULL_SAFE_BROWSING
113 #if defined(OS_WIN)
114 IPC_STRUCT_BEGIN(ChromeUtilityMsg_GetSaveFileName_Params)
115 IPC_STRUCT_MEMBER(HWND, owner)
116 IPC_STRUCT_MEMBER(DWORD, flags)
117 IPC_STRUCT_MEMBER(GetOpenFileNameFilter, filters)
118 IPC_STRUCT_MEMBER(int, one_based_filter_index)
119 IPC_STRUCT_MEMBER(base::FilePath, suggested_filename)
120 IPC_STRUCT_MEMBER(base::FilePath, initial_directory)
121 IPC_STRUCT_MEMBER(base::string16, default_extension)
122 IPC_STRUCT_END()
123 #endif // OS_WIN
125 //------------------------------------------------------------------------------
126 // Utility process messages:
127 // These are messages from the browser to the utility process.
129 // Tell the utility process to decode the given image data.
130 IPC_MESSAGE_CONTROL3(ChromeUtilityMsg_DecodeImage,
131 std::vector<unsigned char> /* encoded image contents */,
132 bool /* shrink image if needed for IPC msg limit */,
133 int /* delegate id */)
135 #if defined(OS_CHROMEOS)
136 // Tell the utility process to decode the given JPEG image data with a robust
137 // libjpeg codec.
138 IPC_MESSAGE_CONTROL2(ChromeUtilityMsg_RobustJPEGDecodeImage,
139 std::vector<unsigned char> /* encoded image contents*/,
140 int /* delegate id */)
141 #endif // defined(OS_CHROMEOS)
143 // Tell the utility process to patch the given |input_file| using |patch_file|
144 // and place the output in |output_file|. The patch should use the bsdiff
145 // algorithm (Courgette's version).
146 IPC_MESSAGE_CONTROL3(ChromeUtilityMsg_PatchFileBsdiff,
147 base::FilePath /* input_file */,
148 base::FilePath /* patch_file */,
149 base::FilePath /* output_file */)
151 // Tell the utility process to patch the given |input_file| using |patch_file|
152 // and place the output in |output_file|. The patch should use the Courgette
153 // algorithm.
154 IPC_MESSAGE_CONTROL3(ChromeUtilityMsg_PatchFileCourgette,
155 base::FilePath /* input_file */,
156 base::FilePath /* patch_file */,
157 base::FilePath /* output_file */)
159 #if defined(OS_CHROMEOS)
160 // Tell the utility process to create a zip file on the given list of files.
161 IPC_MESSAGE_CONTROL3(ChromeUtilityMsg_CreateZipFile,
162 base::FilePath /* src_dir */,
163 std::vector<base::FilePath> /* src_relative_paths */,
164 base::FileDescriptor /* dest_fd */)
165 #endif // defined(OS_CHROMEOS)
167 // Requests the utility process to respond with a
168 // ChromeUtilityHostMsg_ProcessStarted message once it has started. This may
169 // be used if the host process needs a handle to the running utility process.
170 IPC_MESSAGE_CONTROL0(ChromeUtilityMsg_StartupPing)
172 #if defined(FULL_SAFE_BROWSING)
173 // Tells the utility process to analyze a zip file for malicious download
174 // protection, providing a file that can be used temporarily to analyze binaries
175 // contained therein.
176 IPC_MESSAGE_CONTROL2(ChromeUtilityMsg_AnalyzeZipFileForDownloadProtection,
177 IPC::PlatformFileForTransit /* zip_file */,
178 IPC::PlatformFileForTransit /* temp_file */)
179 #endif
181 #if defined(OS_WIN)
182 // Invokes ui::base::win::OpenFileViaShell from the utility process.
183 IPC_MESSAGE_CONTROL1(ChromeUtilityMsg_OpenFileViaShell,
184 base::FilePath /* full_path */)
186 // Invokes ui::base::win::OpenFolderViaShell from the utility process.
187 IPC_MESSAGE_CONTROL1(ChromeUtilityMsg_OpenFolderViaShell,
188 base::FilePath /* full_path */)
190 // Instructs the utility process to invoke GetOpenFileName. |owner| is the
191 // parent of the modal dialog, |flags| are OFN_* flags. |filter| constrains the
192 // user's file choices. |initial_directory| and |filename| select the directory
193 // to be displayed and the file to be initially selected.
195 // Either ChromeUtilityHostMsg_GetOpenFileName_Failed or
196 // ChromeUtilityHostMsg_GetOpenFileName_Result will be returned when the
197 // operation completes whether due to error or user action.
198 IPC_MESSAGE_CONTROL5(ChromeUtilityMsg_GetOpenFileName,
199 HWND /* owner */,
200 DWORD /* flags */,
201 GetOpenFileNameFilter /* filter */,
202 base::FilePath /* initial_directory */,
203 base::FilePath /* filename */)
204 IPC_MESSAGE_CONTROL1(ChromeUtilityMsg_GetSaveFileName,
205 ChromeUtilityMsg_GetSaveFileName_Params /* params */)
206 #endif // defined(OS_WIN)
208 //------------------------------------------------------------------------------
209 // Utility process host messages:
210 // These are messages from the utility process to the browser.
212 // Reply when the utility process has failed while unpacking and parsing a
213 // web resource. |error_message| is a user-readable explanation of what
214 // went wrong.
215 IPC_MESSAGE_CONTROL1(ChromeUtilityHostMsg_UnpackWebResource_Failed,
216 std::string /* error_message, if any */)
218 // Reply when the utility process has succeeded in decoding the image.
219 IPC_MESSAGE_CONTROL2(ChromeUtilityHostMsg_DecodeImage_Succeeded,
220 SkBitmap /* decoded image */,
221 int /* delegate id */)
223 // Reply when an error occurred decoding the image.
224 IPC_MESSAGE_CONTROL1(ChromeUtilityHostMsg_DecodeImage_Failed,
225 int /* delegate id */)
227 // Reply when a file has been patched.
228 IPC_MESSAGE_CONTROL1(ChromeUtilityHostMsg_PatchFile_Finished, int /* result */)
230 #if defined(OS_CHROMEOS)
231 // Reply when the utility process has succeeded in creating the zip file.
232 IPC_MESSAGE_CONTROL0(ChromeUtilityHostMsg_CreateZipFile_Succeeded)
234 // Reply when an error occured in creating the zip file.
235 IPC_MESSAGE_CONTROL0(ChromeUtilityHostMsg_CreateZipFile_Failed)
236 #endif // defined(OS_CHROMEOS)
238 // Reply when the utility process has started.
239 IPC_MESSAGE_CONTROL0(ChromeUtilityHostMsg_ProcessStarted)
241 #if defined(FULL_SAFE_BROWSING)
242 // Reply when a zip file has been analyzed for malicious download protection.
243 IPC_MESSAGE_CONTROL1(
244 ChromeUtilityHostMsg_AnalyzeZipFileForDownloadProtection_Finished,
245 safe_browsing::zip_analyzer::Results)
246 #endif
248 #if defined(OS_WIN)
249 IPC_MESSAGE_CONTROL0(ChromeUtilityHostMsg_GetOpenFileName_Failed)
250 IPC_MESSAGE_CONTROL2(ChromeUtilityHostMsg_GetOpenFileName_Result,
251 base::FilePath /* directory */,
252 std::vector<base::FilePath> /* filenames */)
253 IPC_MESSAGE_CONTROL0(ChromeUtilityHostMsg_GetSaveFileName_Failed)
254 IPC_MESSAGE_CONTROL2(ChromeUtilityHostMsg_GetSaveFileName_Result,
255 base::FilePath /* path */,
256 int /* one_based_filter_index */)
257 IPC_MESSAGE_CONTROL1(ChromeUtilityHostMsg_BuildDirectWriteFontCache,
258 base::FilePath /* cache file path */)
259 #endif // defined(OS_WIN)