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
|
// Copyright (c) 2011 The Chromium OS 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 SHILL_PROFILE_
#define SHILL_PROFILE_
#include <map>
#include <string>
#include <vector>
#include <base/memory/scoped_ptr.h>
#include <gtest/gtest_prod.h> // for FRIEND_TEST
#include "shill/key_file_store.h"
#include "shill/property_store.h"
#include "shill/refptr_types.h"
#include "shill/shill_event.h"
class FilePath;
namespace shill {
class ControlInterface;
class Error;
class GLib;
class ProfileAdaptorInterface;
class Profile : public base::RefCounted<Profile> {
public:
struct Identifier {
std::string user; // Empty for global.
std::string identifier;
};
static const char kGlobalStorageDir[];
static const char kUserStorageDirFormat[];
Profile(ControlInterface *control_interface, GLib *glib);
virtual ~Profile();
const std::string &name() { return name_; }
PropertyStore *store() { return &store_; }
// Begin managing the persistence of |entry|, addressable by |entry_name|.
void AdoptEntry(const std::string &entry_name, const EntryRefPtr &entry);
virtual bool MoveToActiveProfile(const std::string &entry_name) {
return false;
}
// Parses a profile identifier. There're two acceptable forms of the |raw|
// identifier: "identifier" and "~user/identifier". Both "user" and
// "identifier" must be suitable for use in a D-Bus object path. Returns true
// on success.
static bool ParseIdentifier(const std::string &raw, Identifier *parsed);
// Returns the RPC object path for a profile identified by
// |identifier|. |identifier| must be a valid identifier, possibly parsed and
// validated through Profile::ParseIdentifier.
static std::string GetRpcPath(const Identifier &identifier);
// Sets |path| to the persistent store file path for a profile identified by
// |identifier|. Returns true on success, and false if unable to determine an
// appropriate file location. |identifier| must be a valid identifier,
// possibly parsed and validated through Profile::ParseIdentifier.
static bool GetStoragePath(const Identifier &identifier, FilePath *path);
protected:
// Properties to be get/set via PropertyStore calls that must also be visible
// in subclasses.
PropertyStore store_;
// Entries representing services that are persisted to disk.
// A std::map because we will need random access for GetEntry(), but usually
// will want to iterate over all Entries.
std::map<std::string, EntryRefPtr> entries_;
private:
friend class ProfileAdaptorInterface;
FRIEND_TEST(ProfileTest, IsValidIdentifierToken);
// TODO(cmasone): once we can add entries organically, take this out.
FRIEND_TEST(ServiceTest, MoveEntry);
static bool IsValidIdentifierToken(const std::string &token);
scoped_ptr<ProfileAdaptorInterface> adaptor_;
// Persistent store associated with the profile.
KeyFileStore storage_;
// Properties to be get/set via PropertyStore calls.
std::string name_;
DISALLOW_COPY_AND_ASSIGN(Profile);
};
} // namespace shill
#endif // SHILL_PROFILE_
|
