Importing certain bookmarks from firefox and HTML file as search engines.

chrome/utility/importer/bookmark_html_reader.h

 // Copyright 2013 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_UTILITY_IMPORTER_BOOKMARK_HTML_READER_H_
 #define CHROME_UTILITY_IMPORTER_BOOKMARK_HTML_READER_H_
 
 #include <string>
 #include <vector>
 
 #include "base/callback_forward.h"
 #include "base/strings/string16.h"
+#include "chrome/common/importer/importer_data_types.h"
 
 class GURL;
 struct ImportedBookmarkEntry;
 struct ImportedFaviconUsage;
 
 namespace base {
 class FilePath;
 class Time;
 }
 
 namespace bookmark_html_reader {
 
 // Imports the bookmarks from the specified file.
 //
 // |cancellation_callback| is polled to query if the import should be cancelled;
 // if it returns |true| at any time the import will be cancelled. If
 // |cancellation_callback| is a null callback the import will run to completion.
 //
 // |valid_url_callback| is called to determine if a specified URL is valid for
 // import; it returns |true| if it is. If |valid_url_callback| is a null
 // callback, all URLs are considered to be valid.
 //
 // |file_path| is the path of the file on disk to import.
 //
 // |bookmarks| is a pointer to a vector, which is filled with the imported
 // bookmarks. It may not be NULL.
 //
+// |url_keywords| is a pointer toa vector, which is filled with the imported

[Ilya Sherman, 2014/09/30 20:54:12]

nit: "toa" -> "to a"

[Tapu Ghose, 2014/10/07 02:02:44]

Done.

+// keywords that will be imported as search engines.
+//
 // |favicons| is a pointer to a vector, which is filled with the favicons of
 // imported bookmarks. It may be NULL, in which case favicons are not imported.
 void ImportBookmarksFile(
     const base::Callback<bool(void)>& cancellation_callback,
     const base::Callback<bool(const GURL&)>& valid_url_callback,
     const base::FilePath& file_path,
     std::vector<ImportedBookmarkEntry>* bookmarks,
+    std::vector<importer::URLKeywordInfo>* url_keywords,

[Peter Kasting, 2014/10/01 01:02:55]

"URL keyword" seems like a rather confusing name.  Why not call the type and
variable here something about "template URLs" or "search engines"?

[Tapu Ghose, 2014/10/07 02:02:44]

Renaming the variable to search_engine_keywords which will passed to
InProcessImporterBridge::SetKeywords(...) as parameter.

     std::vector<ImportedFaviconUsage>* favicons);
 
+// Checks if a bookmark that contains invalid |url| can be imported as search
+// engine. Scan |url| to check if there is any replacement term, %s. If yes then

[Peter Kasting, 2014/10/01 01:02:55]

Nit: Scan -> scans, substitute -> substitutes.

[Tapu Ghose, 2014/10/07 02:02:44]

Done.

+// substitute the replacement term(s) with any arbitrary value. Returns true if

[Peter Kasting, 2014/10/01 01:02:55]

What does "with any arbitrary value" mean?  Surely it uses some particular
value.  Did you mean "an" instead of "any"?

[Tapu Ghose, 2014/10/07 02:02:44]

I meant "an" here.

+// the resulted url is a valid one.

[Ilya Sherman, 2014/09/30 20:54:12]

nit: "resulted" -> "resulting"

[Tapu Ghose, 2014/10/07 02:02:44]

Done.

+// |decoded_url| holds decoded raw url of |url|.
+bool CanImportURLAsSearchEngine(const GURL& url, base::string16* decoded_url);
+
 namespace internal {
 
 // The file format that BookmarkHTMLReader parses starts with a heading
 // tag, which contains its title. All bookmarks and sub-folders follow,
 // bracketed by a <DL> tag:
 //   <DT><H3 PERSONAL_TOOLBAR_FOLDER="true" ...>title</H3>
 //   <DL><p>
 //      ... container ...
 //   </DL><p>
 // And a bookmark is presented by a <A> tag:
@@ skipping 29 matching lines @@
 bool ParseMinimumBookmarkFromLine(const std::string& line,
                                   const std::string& charset,
                                   base::string16* title,
                                   GURL* url);
 
 }  // namespace internal
 
 }  // namespace bookmark_html_reader
 
 #endif  // CHROME_UTILITY_IMPORTER_BOOKMARK_HTML_READER_H_