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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
// Copyright (c) 2010 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 CHROME_BROWSER_SYNC_GLUE_EXTENSION_UTIL_H_
#define CHROME_BROWSER_SYNC_GLUE_EXTENSION_UTIL_H_
#pragma once
// This file contains some low-level utility functions used by
// extensions sync.
#include <set>
#include <string>
class Extension;
class ExtensionPrefs;
class ExtensionTypeSet;
class ExtensionsService;
struct UninstalledExtensionInfo;
namespace sync_pb {
class ExtensionSpecifics;
} // sync_pb
namespace browser_sync {
enum ExtensionType {
THEME,
EXTENSION,
// A converted user script that does not have an update URL.
LOCAL_USER_SCRIPT,
// A converted user script that has an update URL. (We don't have a
// similar distinction for "regular" extensions as an empty update
// URL is interpreted to mean the default update URL [i.e., the
// extensions gallery].)
UPDATEABLE_USER_SCRIPT,
APP,
};
typedef std::set<ExtensionType> ExtensionTypeSet;
// Returns the type of the given extension.
//
// TODO(akalin): Might be useful to move this into extension.cc.
ExtensionType GetExtensionType(const Extension& extension);
// TODO(akalin): Remove this once we unify ExtensionType and simply
// have an ExtensionType member in UninstalledExtensionInfo.
ExtensionType GetExtensionTypeFromUninstalledExtensionInfo(
const UninstalledExtensionInfo& uninstalled_extension_info);
// Returns whether or not the given extension is one we want to sync.
bool IsExtensionValid(const Extension& extension);
// Returns whether or not the given extension is one we want to sync.
bool IsExtensionValidAndSyncable(const Extension& extension,
const ExtensionTypeSet& allowed_types);
// Stringifies the given ExtensionSpecifics.
std::string ExtensionSpecificsToString(
const sync_pb::ExtensionSpecifics& specifics);
// Returns whether or not the values of the given specifics are valid,
// in particular the id, version, and update URL.
bool IsExtensionSpecificsValid(
const sync_pb::ExtensionSpecifics& specifics);
// Equivalent to DCHECK(IsExtensionSpecificsValid(specifics)) <<
// ExtensionSpecificsToString(specifics);
void DcheckIsExtensionSpecificsValid(
const sync_pb::ExtensionSpecifics& specifics);
// Returns true iff two ExtensionSpecifics denote the same extension
// state. Neither |a| nor |b| need to be valid.
bool AreExtensionSpecificsEqual(const sync_pb::ExtensionSpecifics& a,
const sync_pb::ExtensionSpecifics& b);
// Returns true iff the given ExtensionSpecifics is equal to the empty
// ExtensionSpecifics object. |specifics| does not have to be valid
// and indeed, IsExtensionSpecificsValid(specifics) ->
// !IsExtensionSpecificsUnset(specifics).
bool IsExtensionSpecificsUnset(
const sync_pb::ExtensionSpecifics& specifics);
// Copies the user properties from |specifics| into |dest_specifics|.
// User properties are properties that are set by the user, i.e. not
// inherent to the extension. Currently they include |enabled| and
// |incognito_enabled|. Neither parameter need be valid.
void CopyUserProperties(
const sync_pb::ExtensionSpecifics& specifics,
sync_pb::ExtensionSpecifics* dest_specifics);
// Copies everything but non-user properties. Neither parameter need
// be valid.
void CopyNonUserProperties(
const sync_pb::ExtensionSpecifics& specifics,
sync_pb::ExtensionSpecifics* dest_specifics);
// Returns true iff two ExtensionSpecifics have the same user
// properties. Neither |a| nor |b| need to be valid.
bool AreExtensionSpecificsUserPropertiesEqual(
const sync_pb::ExtensionSpecifics& a,
const sync_pb::ExtensionSpecifics& b);
// Returns true iff two ExtensionSpecifics have the same non-user
// properties. Neither |a| nor |b| need to be valid.
bool AreExtensionSpecificsNonUserPropertiesEqual(
const sync_pb::ExtensionSpecifics& a,
const sync_pb::ExtensionSpecifics& b);
// Fills |specifics| with information taken from |extension|, which
// must be a syncable extension. |specifics| will be valid after this
// function is called.
void GetExtensionSpecifics(const Extension& extension,
ExtensionPrefs* extension_prefs,
sync_pb::ExtensionSpecifics* specifics);
// Exposed only for testing. Pre- and post-conditions are the same as
// GetExtensionSpecifics().
void GetExtensionSpecificsHelper(const Extension& extension,
bool enabled, bool incognito_enabled,
sync_pb::ExtensionSpecifics* specifics);
// Returns whether or not the extension should be updated according to
// the specifics. |extension| must be syncable and |specifics| must
// be valid.
bool IsExtensionOutdated(const Extension& extension,
const sync_pb::ExtensionSpecifics& specifics);
// Sets properties of |extension| according to the information in
// specifics. |extension| must be syncable and |specifics| must be
// valid.
void SetExtensionProperties(
const sync_pb::ExtensionSpecifics& specifics,
ExtensionsService* extensions_service, const Extension* extension);
// Merge |specifics| into |merged_specifics|. Both must be valid and
// have the same ID. The merge policy is currently to copy the
// non-user properties of |specifics| into |merged_specifics| (and the
// user properties if |merge_user_properties| is set) if |specifics|
// has a more recent or the same version as |merged_specifics|.
void MergeExtensionSpecifics(
const sync_pb::ExtensionSpecifics& specifics,
bool merge_user_properties,
sync_pb::ExtensionSpecifics* merged_specifics);
} // namespace browser_sync
#endif // CHROME_BROWSER_SYNC_GLUE_EXTENSION_UTIL_H_
|
