Sync user's custom spellcheck dictionary

chrome/browser/spellchecker/spellcheck_custom_dictionary.h

 // Copyright (c) 2012 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_SPELLCHECKER_SPELLCHECK_CUSTOM_DICTIONARY_H_
 #define CHROME_BROWSER_SPELLCHECKER_SPELLCHECK_CUSTOM_DICTIONARY_H_
 
 #include <string>
 #include <vector>
 
 #include "base/file_path.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "base/observer_list.h"
 #include "chrome/browser/spellchecker/spellcheck_dictionary.h"
 #include "chrome/common/spellcheck_common.h"
+#include "sync/api/syncable_service.h"
 
 // Defines a custom dictionary where users can add their own words. All words
 // must be UTF8, between 1 and 128 bytes long, and without ASCII whitespace.
 // The dictionary contains its own checksum when saved on disk. Example
 // dictionary file contents:
 //
 //   bar
 //   foo
 //   checksum_v1 = ec3df4034567e59e119fcf87f2d9bad4
 //
-class SpellcheckCustomDictionary : public SpellcheckDictionary {
+class SpellcheckCustomDictionary : public SpellcheckDictionary,
+                                   public syncer::SyncableService {
  public:
   class Observer {
    public:
     virtual void OnCustomDictionaryLoaded() = 0;
-    virtual void OnCustomDictionaryWordAdded(const std::string& word) = 0;
-    virtual void OnCustomDictionaryWordRemoved(const std::string& word) = 0;
+    virtual void OnCustomDictionaryWordsAdded(
+        const chrome::spellcheck_common::WordList& words) = 0;
+    virtual void OnCustomDictionaryWordsRemoved(
+        const chrome::spellcheck_common::WordList& words) = 0;
   };
 
   explicit SpellcheckCustomDictionary(Profile* profile);
   virtual ~SpellcheckCustomDictionary();
 
   // Overridden from SpellcheckDictionary:
   virtual void Load() OVERRIDE;
 
   const chrome::spellcheck_common::WordList& GetWords() const;
 
   // Populates the |custom_words| with the list of words in the custom
   // dictionary file. Makes sure that the custom dictionary file is sorted, does
   // not have duplicates, and contains only valid words.
-  void LoadDictionaryIntoCustomWordList(
-      chrome::spellcheck_common::WordList* custom_words);
+  static void LoadDictionaryIntoCustomWordList(

[groby-ooo-7-16, 2012/12/19 22:16:00]

Personal preference: I like to make functions stand-alone if they require truly
no access to members. (I.e. outside of the class, instead of static). It
prevents accidental entanglement later on.

[please use gerrit instead, 2012/12/22 03:20:19]

Done.

+      chrome::spellcheck_common::WordList* custom_words,
+      const FilePath& path);
 
   // Moves the words from the |custom_words| argument into its own private
   // member variable. Does not delete the memory at |custom_words|.
   void SetCustomWordList(chrome::spellcheck_common::WordList* custom_words);
 
   // Adds the given word to the custom words list and informs renderers of the
   // update. Returns false for duplicate and invalid words.
   bool AddWord(const std::string& word);
 
   // Returns false for duplicate words.
   bool CustomWordAddedLocally(const std::string& word);
 
-  void WriteWordToCustomDictionary(const std::string& word);
+  static void WriteWordToCustomDictionary(
+      const std::string& word,
+      const FilePath& path);
 
   // Removes the given word from the custom words list and informs renderers of
   // the update. Returns false for words that are not in the dictionary and
   // invalid words.
   bool RemoveWord(const std::string& word);
 
   // Returns false for words that are not in the dictionary.
   bool CustomWordRemovedLocally(const std::string& word);
 
-  void EraseWordFromCustomDictionary(const std::string& word);
+  static void EraseWordFromCustomDictionary(
+      const std::string& word,
+      const FilePath& path);
 
   void AddObserver(Observer* observer);
   void RemoveObserver(Observer* observer);
 
+  // Overridden from syncer::SyncableService:

[groby-ooo-7-16, 2012/12/19 22:16:00]

Personal preference: I like overridden interfaces together, and either at the
top or bottom of the public section.

[please use gerrit instead, 2012/12/22 03:20:19]

Done.

+  virtual syncer::SyncMergeResult MergeDataAndStartSyncing(
+      syncer::ModelType type,
+      const syncer::SyncDataList& initial_sync_data,
+      scoped_ptr<syncer::SyncChangeProcessor> sync_processor,
+      scoped_ptr<syncer::SyncErrorFactory> sync_error_handler) OVERRIDE;
+  virtual void StopSyncing(syncer::ModelType type) OVERRIDE;
+  virtual syncer::SyncDataList GetAllSyncData(
+      syncer::ModelType type) const OVERRIDE;
+  virtual syncer::SyncError ProcessSyncChanges(
+      const tracked_objects::Location& from_here,
+      const syncer::SyncChangeList& change_list) OVERRIDE;
+
+  // Relinquishes the management of |sync_processor_|, because it is managed by
+  // |SpellcheckService| in testing.
+  void StopSyncingForTesting();
+
+  // Whether the dictionary is loaded.
+  bool IsLoaded();
+
  private:
   // Returns a newly allocated list of words read from custom dictionary file.
   // The caller owns this new list.
-  chrome::spellcheck_common::WordList* LoadDictionary();
+  static chrome::spellcheck_common::WordList* LoadDictionary(
+      const FilePath& path);
 
   // The reply point for PostTaskAndReplyWithResult. Called when LoadDictionary
   // is finished reading words from custom dictionary file. Moves the strings
   // from the |custom_words| argument into the private member variable |words_|
   // and deletes the memory at |custom_words|.
   void SetCustomWordListAndDelete(
       chrome::spellcheck_common::WordList* custom_words);
 
   // Loads the dictionary file into |custom_words|. If the dictionary checksum
   // is not valid, but backup checksum is valid, then restores the backup and
   // loads that into |custom_words| instead. If the backup is invalid too, then
   // clears |custom_words|.
-  void LoadDictionaryFileReliably(
-      chrome::spellcheck_common::WordList* custom_words);
+  static void LoadDictionaryFileReliably(
+      chrome::spellcheck_common::WordList* custom_words,
+      const FilePath& path);
 
   // Backs up the original dictionary, saves |custom_words| and its checksum
   // into the dictionary file.
-  void SaveDictionaryFileReliably(
-      const chrome::spellcheck_common::WordList& custom_words);
+  static void SaveDictionaryFileReliably(
+      const chrome::spellcheck_common::WordList& custom_words,
+      const FilePath& path);
+
+  // Adds words |to_add| and removes words |to_remove| in the custom words list
+  // and informs renderers of the updates. Returns true on success, false on
+  // duplicate words that were not added, missing words that could not be

[groby-ooo-7-16, 2012/12/19 22:16:00]

That's a confusing API - usually boolean returns indicate a failure condition.

Also, two overloaded versions just for an additional bool parameter seems
overkill. Can we just have the one with |is_sync_update|?

And finally, consider making the bool an enum instead, so it's either to
decipher at the invocation side what's going on.

[please use gerrit instead, 2012/12/22 03:20:19]

Done.

+  // removed, and invalid words. Removes duplicates and invalid words from
+  // |to_add| and missing words from |to_remove|. The optional parameter
+  // |is_sync_update| indicates that this change comes from a sync update, which
+  // means that we should not notify the sync process of these changes to avoid
+  // an infinite loop. |is_sync_update| is false by default.
+  bool UpdateWords(chrome::spellcheck_common::WordList* to_add,
+                   chrome::spellcheck_common::WordList* to_remove);
+  bool UpdateWords(chrome::spellcheck_common::WordList* to_add,
+                   chrome::spellcheck_common::WordList* to_remove,
+                   bool is_sync_update);
+
+  // Adds words |to_add| and removes words |to_remove| in the custom words list.
+  // Returns true on success, false on duplicate words that were not added,
+  // missing words that could not be removed, and invalid words. Removes
+  // duplicates and invalid words from |to_add| and missing words from
+  // |to_remove|. The optional parameter |is_sync_update| indicates that this
+  // change comes from a sync update, which means that we should not notify the
+  // sync process of these changes to avoid an infinite loop. |is_sync_update|
+  // is false by default.
+  bool CustomWordsUpdatedLocally(
+      chrome::spellcheck_common::WordList* to_add,
+      chrome::spellcheck_common::WordList* to_remove);
+  bool CustomWordsUpdatedLocally(
+      chrome::spellcheck_common::WordList* to_add,
+      chrome::spellcheck_common::WordList* to_remove,
+      bool is_sync_update);
+
+  // Writes words |to_write| and erases words |to_erase| in the dictionary file.
+  static void WriteAndEraseWordsInCustomDictionary(
+      const chrome::spellcheck_common::WordList* to_write,
+      const chrome::spellcheck_common::WordList* to_erase,
+      const FilePath& path);
+
+  // Deletes the memory at |written| and |erased|.
+  void OnWriteAndEraseFinished(
+      const chrome::spellcheck_common::WordList* written,
+      const chrome::spellcheck_common::WordList* erased);
 
   // In-memory cache of the custom words file.
   chrome::spellcheck_common::WordList words_;
 
   // A path for custom dictionary per profile.
   FilePath custom_dictionary_path_;
 
   base::WeakPtrFactory<SpellcheckCustomDictionary> weak_ptr_factory_;
 
   ObserverList<Observer> observers_;
+  scoped_ptr<syncer::SyncChangeProcessor> sync_processor_;

[groby-ooo-7-16, 2012/12/19 22:16:00]

Please document member vars.

[please use gerrit instead, 2012/12/22 03:20:19]

Done.

+  scoped_ptr<syncer::SyncErrorFactory> sync_error_handler_;
+  bool is_loaded_;
 
   DISALLOW_COPY_AND_ASSIGN(SpellcheckCustomDictionary);
 };
 
 #endif  // CHROME_BROWSER_SPELLCHECKER_SPELLCHECK_CUSTOM_DICTIONARY_H_