OLD | NEW |
1 // Copyright (C) 2013 Google Inc. | 1 // Copyright (C) 2013 Google Inc. |
2 // | 2 // |
3 // Licensed under the Apache License, Version 2.0 (the "License"); | 3 // Licensed under the Apache License, Version 2.0 (the "License"); |
4 // you may not use this file except in compliance with the License. | 4 // you may not use this file except in compliance with the License. |
5 // You may obtain a copy of the License at | 5 // You may obtain a copy of the License at |
6 // | 6 // |
7 // http://www.apache.org/licenses/LICENSE-2.0 | 7 // http://www.apache.org/licenses/LICENSE-2.0 |
8 // | 8 // |
9 // Unless required by applicable law or agreed to in writing, software | 9 // Unless required by applicable law or agreed to in writing, software |
10 // distributed under the License is distributed on an "AS IS" BASIS, | 10 // distributed under the License is distributed on an "AS IS" BASIS, |
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
12 // See the License for the specific language governing permissions and | 12 // See the License for the specific language governing permissions and |
13 // limitations under the License. | 13 // limitations under the License. |
14 // | 14 // |
15 // An object to retrieve data. | 15 // An object to retrieve data. |
16 | 16 |
17 #ifndef I18N_ADDRESSINPUT_RETRIEVER_H_ | 17 #ifndef I18N_ADDRESSINPUT_RETRIEVER_H_ |
18 #define I18N_ADDRESSINPUT_RETRIEVER_H_ | 18 #define I18N_ADDRESSINPUT_RETRIEVER_H_ |
19 | 19 |
20 #include <libaddressinput/callback.h> | 20 #include <libaddressinput/callback.h> |
21 #include <libaddressinput/util/basictypes.h> | 21 #include <libaddressinput/util/basictypes.h> |
22 #include <libaddressinput/util/scoped_ptr.h> | 22 #include <libaddressinput/util/scoped_ptr.h> |
23 | 23 |
24 #include <map> | 24 #include <map> |
25 #include <string> | 25 #include <string> |
26 | 26 |
27 #include "lookup_key_util.h" | |
28 | |
29 namespace i18n { | 27 namespace i18n { |
30 namespace addressinput { | 28 namespace addressinput { |
31 | 29 |
32 class Downloader; | 30 class Downloader; |
33 class Storage; | 31 class Storage; |
34 | 32 |
35 // Retrieves data. Sample usage: | 33 // Retrieves data. Sample usage: |
36 // Storage* storage = ...; | 34 // Storage* storage = ...; |
37 // Downloader* downloader = ...; | 35 // Downloader* downloader = ...; |
38 // Retriever retriever("https://i18napis.appspot.com/ssl-address/", | 36 // Retriever retriever("https://i18napis.appspot.com/ssl-address/", |
39 // downloader, storage); | 37 // downloader, storage); |
40 // retriever.Retrieve("data/CA/AB--fr", | 38 // retriever.Retrieve("data/CA/AB--fr", |
41 // BuildCallback(this, &MyClass::OnDataRetrieved)); | 39 // BuildCallback(this, &MyClass::OnDataRetrieved)); |
42 class Retriever { | 40 class Retriever { |
43 public: | 41 public: |
44 typedef i18n::addressinput::Callback<std::string, std::string> Callback; | 42 typedef i18n::addressinput::Callback<std::string, std::string> Callback; |
45 | 43 |
46 Retriever(const std::string& validation_data_url, | 44 Retriever(const std::string& validation_data_url, |
47 scoped_ptr<Downloader> downloader, | 45 scoped_ptr<Downloader> downloader, |
48 scoped_ptr<Storage> storage); | 46 scoped_ptr<Storage> storage); |
49 ~Retriever(); | 47 ~Retriever(); |
50 | 48 |
51 // Retrieves the data for |key| and invokes the |retrieved| callback. Checks | 49 // Retrieves the data for |key| and invokes the |retrieved| callback. Checks |
52 // for the data in storage first. If storage does not have the data for |key|, | 50 // for the data in storage first. If storage does not have the data for |key|, |
53 // then downloads the data and places it in storage. | 51 // then downloads the data and places it in storage. |
54 void Retrieve(const std::string& key, scoped_ptr<Callback> retrieved); | 52 void Retrieve(const std::string& key, scoped_ptr<Callback> retrieved); |
55 | 53 |
56 private: | 54 private: |
| 55 friend class RetrieverTest; |
| 56 |
57 // Callback for when a rule is retrieved from |storage_|. | 57 // Callback for when a rule is retrieved from |storage_|. |
58 void OnDataRetrievedFromStorage(bool success, | 58 void OnDataRetrievedFromStorage(bool success, |
59 const std::string& key, | 59 const std::string& key, |
60 const std::string& data); | 60 const std::string& data); |
61 | 61 |
62 // Callback for when a rule is retrieved by |downloader_|. | 62 // Callback for when a rule is retrieved by |downloader_|. |
63 void OnDownloaded(bool success, | 63 void OnDownloaded(bool success, |
64 const std::string& url, | 64 const std::string& url, |
65 const std::string& data); | 65 const std::string& data); |
66 | 66 |
| 67 // Returns the URL where the |key| can be retrieved. For example, returns |
| 68 // "https://i18napis.appspot.com/ssl-address/data/US" for input "data/US". |
| 69 // Assumes that the input string is a valid URL segment. |
| 70 std::string GetUrlForKey(const std::string& key) const; |
| 71 |
| 72 // Returns the key for the |url|. For example, returns "data/US" for |
| 73 // "https://i18napis.appspot.com/ssl-address/data/US". If the |url| does not |
| 74 // start with |validation_data_url| that was passed to the constructor, then |
| 75 // returns an empty string. (This can happen if the user of the library |
| 76 // returns a bad URL in their Downloader implementation.) |
| 77 std::string GetKeyForUrl(const std::string& url) const; |
| 78 |
| 79 // Returns true if the |url| starts with |validation_data_url| that was passed |
| 80 // to the constructor. |
| 81 bool IsValidationDataUrl(const std::string& url) const; |
| 82 |
67 // Looks up the callback for |key| in |requests_|, removes it from the map | 83 // Looks up the callback for |key| in |requests_|, removes it from the map |
68 // and returns it. Assumes that |key| is in fact in |requests_|. | 84 // and returns it. Assumes that |key| is in fact in |requests_|. |
69 scoped_ptr<Callback> GetCallbackForKey(const std::string& key); | 85 scoped_ptr<Callback> GetCallbackForKey(const std::string& key); |
70 | 86 |
71 const LookupKeyUtil lookup_key_util_; | 87 const std::string validation_data_url_; |
72 scoped_ptr<Downloader> downloader_; | 88 scoped_ptr<Downloader> downloader_; |
73 scoped_ptr<Storage> storage_; | 89 scoped_ptr<Storage> storage_; |
74 // Holds pending requests. The callback pointers are owned. | 90 // Holds pending requests. The callback pointers are owned. |
75 std::map<std::string, Callback*> requests_; | 91 std::map<std::string, Callback*> requests_; |
76 | 92 |
77 DISALLOW_COPY_AND_ASSIGN(Retriever); | 93 DISALLOW_COPY_AND_ASSIGN(Retriever); |
78 }; | 94 }; |
79 | 95 |
80 } // namespace addressinput | 96 } // namespace addressinput |
81 } // namespace i18n | 97 } // namespace i18n |
82 | 98 |
83 #endif // I18N_ADDRESSINPUT_RETRIEVER_H_ | 99 #endif // I18N_ADDRESSINPUT_RETRIEVER_H_ |
OLD | NEW |