[ReadingList iOS] Cleanup Offline directory on startup

ios/chrome/browser/reading_list/reading_list_download_service.h

 // Copyright 2016 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 IOS_CHROME_BROWSER_READING_LIST_READING_LIST_DOWNLOAD_SERVICE_H_
 #define IOS_CHROME_BROWSER_READING_LIST_READING_LIST_DOWNLOAD_SERVICE_H_
 
 #include "base/macros.h"
 #include "components/keyed_service/core/keyed_service.h"
 #include "components/reading_list/ios/reading_list_model_observer.h"
 #include "ios/chrome/browser/reading_list/url_downloader.h"
 #include "net/base/network_change_notifier.h"
 
 class GURL;
 class PrefService;
 class ReadingListModel;
 namespace base {
 class FilePath;
 }
 
 namespace dom_distiller {
 class DomDistillerService;
 }
 
 namespace reading_list {
 class ReadingListDistillerPageFactory;
 }
 
 // Observes the reading list and downloads offline versions of its articles.
 // Any calls made to DownloadAllEntries/DownloadEntry before the model is

[gambard, 2017/01/25 09:02:07]

Update this comment.

[Olivier, 2017/01/25 12:25:30]

SyncWithModel is private. Removed from comment.

 // loaded will be ignored. When the model is loaded, DownloadAllEntries will be

[gambard, 2017/01/25 09:02:07]

Same

[Olivier, 2017/01/25 12:25:30]

Done.

 // called automatically.
 class ReadingListDownloadService
     : public KeyedService,
       public ReadingListModelObserver,
       public net::NetworkChangeNotifier::ConnectionTypeObserver {
  public:
   ReadingListDownloadService(
       ReadingListModel* reading_list_model,
       dom_distiller::DomDistillerService* distiller_service,
       PrefService* prefs,
@@ skipping 16 matching lines @@
   void ReadingListModelLoaded(const ReadingListModel* model) override;
   void ReadingListWillRemoveEntry(const ReadingListModel* model,
                                   const GURL& url) override;
   void ReadingListDidAddEntry(const ReadingListModel* model,
                               const GURL& url,
                               reading_list::EntrySource entry_source) override;
   void ReadingListDidMoveEntry(const ReadingListModel* model,
                                const GURL& url) override;
 
  private:
-  // Tries to save offline versions of all entries in the reading list that are
-  // not yet saved. Must only be called after reading list model is loaded.
-  void DownloadAllEntries();
+  // Checks the model and determine what entries are processed and what entries

[jif, 2017/01/25 09:15:51]

s/what entries/which entries/

[jif, 2017/01/25 09:15:51]

s/determine/determines/

[Olivier, 2017/01/25 12:25:30]

Done.

[Olivier, 2017/01/25 12:25:30]

Done.

+  // needs to be processed.

[jif, 2017/01/25 09:15:51]

need

[Olivier, 2017/01/25 12:25:31]

Done.

+  // Initiates a cleanup of |OfflineRoot| directory removing sub_directories

[gambard, 2017/01/25 09:02:07]

s/OfflineRoot/OfflineRoot()/

[Olivier, 2017/01/25 12:25:31]

Done.

+  // not corresponding to a processed ReadingListEntry.
+  // Schedule unprocessed entries for distillation.
+  void SyncWithModel();
+  // Scans |OfflineRoot| directory and deletes all subdirectories not listed in

[gambard, 2017/01/25 09:02:07]

s/OfflineRoot/OfflineRoot()/

[Olivier, 2017/01/25 12:25:30]

Done.

+  // processed_directories.

[gambard, 2017/01/25 09:02:07]

s/processed_directories/|processed_directories|/

[Olivier, 2017/01/25 12:25:31]

Done.

+  // Must be called on File thread.
+  void CleanUpFiles(const std::set<std::string>& processed_directories);

[gambard, 2017/01/25 09:02:07]

Based on the name of the function I would expect it to clear the data listed in
|processed_directories|.
Maybe CleanUpExcept()? Or change processed_directories to something like
directories_to_keep, exception_directories?

[Olivier, 2017/01/25 12:25:30]

Done.

+  // Schedules all emtries in |unprocessed_entries| for distillation.

[gambard, 2017/01/25 09:02:07]

s/emtries/entries/
This sentence looks weird to me but I have trouble finding a better one. Maybe
it is because we are not scheduling an entry for distillation but scheduling a
download?

[Olivier, 2017/01/25 12:25:31]

Done.

+  void DownloadUnprocessedEntries(const std::set<GURL>& unprocessed_entries);
   // Processes a new entry and schedule a download if needed.

[gambard, 2017/01/25 09:02:07]

s/schedule/schedules

[Olivier, 2017/01/25 12:25:31]

Done.

   void ProcessNewEntry(const GURL& url);
-  // Schedule a download of an offline version of the reading list entry,
+  // Schedules a download of an offline version of the reading list entry,
   // according to the delay of the entry. Must only be called after reading list
   // model is loaded.
   void ScheduleDownloadEntry(const GURL& url);
   // Tries to save an offline version of the reading list entry if it is not yet
   // saved. Must only be called after reading list model is loaded.
   void DownloadEntry(const GURL& url);
   // Removes the offline version of the reading list entry if it exists. Must
   // only be called after reading list model is loaded.
   void RemoveDownloadedEntry(const GURL& url);
   // Callback for entry download.
@@ skipping 18 matching lines @@
   bool had_connection_;
   std::unique_ptr<reading_list::ReadingListDistillerPageFactory>
       distiller_page_factory_;
 
   base::WeakPtrFactory<ReadingListDownloadService> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(ReadingListDownloadService);
 };
 
 #endif  // IOS_CHROME_BROWSER_READING_LIST_READING_LIST_DOWNLOAD_SERVICE_H_