1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
// Copyright (c) 2006-2008 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.
//
// Base class for managing an action of a sequence of actions to be carried
// out during install/update/uninstall. Supports rollback of actions if this
// process fails.
#ifndef CHROME_INSTALLER_UTIL_WORK_ITEM_H_
#define CHROME_INSTALLER_UTIL_WORK_ITEM_H_
#include <windows.h>
#include <string>
class CopyTreeWorkItem;
class CreateDirWorkItem;
class CreateRegKeyWorkItem;
class DeleteTreeWorkItem;
class DeleteRegValueWorkItem;
class MoveTreeWorkItem;
class SelfRegWorkItem;
class SetRegValueWorkItem;
class WorkItemList;
// A base class that defines APIs to perform/rollback an action or a
// sequence of actions during install/update/uninstall.
class WorkItem {
public:
// Possible states
typedef enum CopyOverWriteOption {
ALWAYS, // Always overwrite regardless of what existed before.
NEVER, // Not used currently.
IF_DIFFERENT, // Overwrite if different. Currently only applies to file.
IF_NOT_PRESENT, // Copy only if file/directory do not exist already.
NEW_NAME_IF_IN_USE // Copy to a new path if dest is in use(only files).
};
virtual ~WorkItem();
// Create a CopyTreeWorkItem that recursively copies a file system hierarchy
// from source path to destination path.
// * If overwrite_option is ALWAYS, the created CopyTreeWorkItem always
// overwrites files.
// * If overwrite_option is NEW_NAME_IF_IN_USE, file is copied with an
// alternate name specified by alternative_path.
static CopyTreeWorkItem* CreateCopyTreeWorkItem(std::wstring source_path,
std::wstring dest_path, std::wstring temp_dir,
CopyOverWriteOption overwrite_option,
std::wstring alternative_path = L"");
// Create a CreateDirWorkItem that creates a directory at the given path.
static CreateDirWorkItem* CreateCreateDirWorkItem(std::wstring path);
// Create a CreateRegKeyWorkItem that creates a registry key at the given
// path.
static CreateRegKeyWorkItem* CreateCreateRegKeyWorkItem(
HKEY predefined_root, std::wstring path);
// Create a DeleteRegValueWorkItem that deletes a registry value
static DeleteRegValueWorkItem* CreateDeleteRegValueWorkItem(
HKEY predefined_root, std::wstring key_path,
std::wstring value_name, bool is_str_type);
// Create a DeleteTreeWorkItem that recursively deletes a file system
// hierarchy at the given root path. A key file can be optionally specified
// by key_path.
static DeleteTreeWorkItem* CreateDeleteTreeWorkItem(std::wstring root_path,
std::wstring key_path);
// Create a MoveTreeWorkItem that recursively moves a file system hierarchy
// from source path to destination path.
static MoveTreeWorkItem* CreateMoveTreeWorkItem(std::wstring source_path,
std::wstring dest_path, std::wstring temp_dir);
// Create a SetRegValueWorkItem that sets a registry value with REG_SZ type
// at the key with specified path.
static SetRegValueWorkItem* CreateSetRegValueWorkItem(
HKEY predefined_root, std::wstring key_path,
std::wstring value_name, std::wstring value_data, bool overwrite);
// Create a SetRegValueWorkItem that sets a registry value with REG_DWORD type
// at the key with specified path.
static SetRegValueWorkItem* CreateSetRegValueWorkItem(
HKEY predefined_root, std::wstring key_path,
std::wstring value_name, DWORD value_data, bool overwrite);
// Add a SelfRegWorkItem that registers or unregisters a DLL at the
// specified path.
static SelfRegWorkItem* CreateSelfRegWorkItem(const std::wstring& dll_path,
bool do_register);
// Create an empty WorkItemList. A WorkItemList can recursively contains
// a list of WorkItems.
static WorkItemList* CreateWorkItemList();
// Perform the actions of WorkItem. Returns true if success, returns false
// otherwise.
// If the WorkItem is transactional, then Do() is done as a transaction.
// If it returns false, there will be no change on the system.
virtual bool Do() = 0;
// Rollback any actions previously carried out by this WorkItem. If the
// WorkItem is transactional, then the previous actions can be fully
// rolled back. If the WorkItem is non-transactional, the rollback is a
// best effort.
virtual void Rollback() = 0;
// Return true if the WorkItem is transactional, return false if
// non-transactional.
virtual bool IsTransactional() { return false; }
// For diagnostics.
virtual std::wstring Dump();
protected:
WorkItem();
};
#endif // CHROME_INSTALLER_UTIL_WORK_ITEM_H_
|
