Index: components/update_client/component_patcher_operation.h |
diff --git a/components/update_client/component_patcher_operation.h b/components/update_client/component_patcher_operation.h |
new file mode 100644 |
index 0000000000000000000000000000000000000000..8f31c04309cb9d6c414adff2138cd01063c2ac54 |
--- /dev/null |
+++ b/components/update_client/component_patcher_operation.h |
@@ -0,0 +1,184 @@ |
+// Copyright 2014 The Chromium Authors. All rights reserved. |
+// Use of this source code is governed by a BSD-style license that can be |
+// found in the LICENSE file. |
+ |
+#ifndef COMPONENTS_UPDATE_CLIENT_COMPONENT_PATCHER_OPERATION_H_ |
+#define COMPONENTS_UPDATE_CLIENT_COMPONENT_PATCHER_OPERATION_H_ |
+ |
+#include <string> |
+ |
+#include "base/callback.h" |
+#include "base/compiler_specific.h" |
+#include "base/files/file_path.h" |
+#include "base/macros.h" |
+#include "base/memory/ref_counted.h" |
+#include "components/update_client/component_unpacker.h" |
+ |
+namespace base { |
+class DictionaryValue; |
+} // namespace base |
+ |
+namespace update_client { |
+ |
+extern const char kOp[]; |
+extern const char kBsdiff[]; |
+extern const char kCourgette[]; |
+extern const char kInput[]; |
+extern const char kPatch[]; |
+ |
+class ComponentInstaller; |
+ |
+class DeltaUpdateOp : public base::RefCountedThreadSafe<DeltaUpdateOp> { |
+ public: |
+ DeltaUpdateOp(); |
+ |
+ // Parses, runs, and verifies the operation. Calls |callback| with the |
+ // result of the operation. The callback is called using |task_runner|. |
+ void Run(const base::DictionaryValue* command_args, |
+ const base::FilePath& input_dir, |
+ const base::FilePath& unpack_dir, |
+ ComponentInstaller* installer, |
+ const ComponentUnpacker::Callback& callback, |
+ scoped_refptr<base::SequencedTaskRunner> task_runner); |
+ |
+ protected: |
+ virtual ~DeltaUpdateOp(); |
+ |
+ scoped_refptr<base::SequencedTaskRunner> GetTaskRunner(); |
+ |
+ std::string output_sha256_; |
+ base::FilePath output_abs_path_; |
+ |
+ private: |
+ friend class base::RefCountedThreadSafe<DeltaUpdateOp>; |
+ |
+ ComponentUnpacker::Error CheckHash(); |
+ |
+ // Subclasses must override DoParseArguments to parse operation-specific |
+ // arguments. DoParseArguments returns DELTA_OK on success; any other code |
+ // represents failure. |
+ virtual ComponentUnpacker::Error DoParseArguments( |
+ const base::DictionaryValue* command_args, |
+ const base::FilePath& input_dir, |
+ ComponentInstaller* installer) = 0; |
+ |
+ // Subclasses must override DoRun to actually perform the patching operation. |
+ // They must call the provided callback when they have completed their |
+ // operations. In practice, the provided callback is always for "DoneRunning". |
+ virtual void DoRun(const ComponentUnpacker::Callback& callback) = 0; |
+ |
+ // Callback given to subclasses for when they complete their operation. |
+ // Validates the output, and posts a task to the patching operation's |
+ // callback. |
+ void DoneRunning(ComponentUnpacker::Error error, int extended_error); |
+ |
+ ComponentUnpacker::Callback callback_; |
+ scoped_refptr<base::SequencedTaskRunner> task_runner_; |
+ |
+ DISALLOW_COPY_AND_ASSIGN(DeltaUpdateOp); |
+}; |
+ |
+// A 'copy' operation takes a file currently residing on the disk and moves it |
+// into the unpacking directory: this represents "no change" in the file being |
+// installed. |
+class DeltaUpdateOpCopy : public DeltaUpdateOp { |
+ public: |
+ DeltaUpdateOpCopy(); |
+ |
+ private: |
+ ~DeltaUpdateOpCopy() override; |
+ |
+ // Overrides of DeltaUpdateOp. |
+ ComponentUnpacker::Error DoParseArguments( |
+ const base::DictionaryValue* command_args, |
+ const base::FilePath& input_dir, |
+ ComponentInstaller* installer) override; |
+ |
+ void DoRun(const ComponentUnpacker::Callback& callback) override; |
+ |
+ base::FilePath input_abs_path_; |
+ |
+ DISALLOW_COPY_AND_ASSIGN(DeltaUpdateOpCopy); |
+}; |
+ |
+// A 'create' operation takes a full file that was sent in the delta update |
+// archive and moves it into the unpacking directory: this represents the |
+// addition of a new file, or a file so different that no bandwidth could be |
+// saved by transmitting a differential update. |
+class DeltaUpdateOpCreate : public DeltaUpdateOp { |
+ public: |
+ DeltaUpdateOpCreate(); |
+ |
+ private: |
+ ~DeltaUpdateOpCreate() override; |
+ |
+ // Overrides of DeltaUpdateOp. |
+ ComponentUnpacker::Error DoParseArguments( |
+ const base::DictionaryValue* command_args, |
+ const base::FilePath& input_dir, |
+ ComponentInstaller* installer) override; |
+ |
+ void DoRun(const ComponentUnpacker::Callback& callback) override; |
+ |
+ base::FilePath patch_abs_path_; |
+ |
+ DISALLOW_COPY_AND_ASSIGN(DeltaUpdateOpCreate); |
+}; |
+ |
+// An interface an embedder may fulfill to enable out-of-process patching. |
+class OutOfProcessPatcher |
+ : public base::RefCountedThreadSafe<OutOfProcessPatcher> { |
+ public: |
+ virtual void Patch(const std::string& operation, |
+ scoped_refptr<base::SequencedTaskRunner> task_runner, |
+ const base::FilePath& input_abs_path, |
+ const base::FilePath& patch_abs_path, |
+ const base::FilePath& output_abs_path, |
+ base::Callback<void(int result)> callback) = 0; |
+ |
+ protected: |
+ friend class base::RefCountedThreadSafe<OutOfProcessPatcher>; |
+ |
+ virtual ~OutOfProcessPatcher() {} |
+}; |
+ |
+// Both 'bsdiff' and 'courgette' operations take an existing file on disk, |
+// and a bsdiff- or Courgette-format patch file provided in the delta update |
+// package, and run bsdiff or Courgette to construct an output file in the |
+// unpacking directory. |
+class DeltaUpdateOpPatch : public DeltaUpdateOp { |
+ public: |
+ // |out_of_process_patcher| may be NULL. |
+ DeltaUpdateOpPatch(const std::string& operation, |
+ scoped_refptr<OutOfProcessPatcher> out_of_process_patcher); |
+ |
+ private: |
+ ~DeltaUpdateOpPatch() override; |
+ |
+ // Overrides of DeltaUpdateOp. |
+ ComponentUnpacker::Error DoParseArguments( |
+ const base::DictionaryValue* command_args, |
+ const base::FilePath& input_dir, |
+ ComponentInstaller* installer) override; |
+ |
+ void DoRun(const ComponentUnpacker::Callback& callback) override; |
+ |
+ // |success_code| is the code that indicates a successful patch. |
+ // |result| is the code the patching operation returned. |
+ void DonePatching(const ComponentUnpacker::Callback& callback, int result); |
+ |
+ std::string operation_; |
+ scoped_refptr<OutOfProcessPatcher> out_of_process_patcher_; |
+ base::FilePath patch_abs_path_; |
+ base::FilePath input_abs_path_; |
+ |
+ DISALLOW_COPY_AND_ASSIGN(DeltaUpdateOpPatch); |
+}; |
+ |
+DeltaUpdateOp* CreateDeltaUpdateOp( |
+ const std::string& operation, |
+ scoped_refptr<OutOfProcessPatcher> out_of_process_patcher); |
+ |
+} // namespace update_client |
+ |
+#endif // COMPONENTS_UPDATE_CLIENT_COMPONENT_PATCHER_OPERATION_H_ |