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
|
// Copyright 2014 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 COMPONENTS_ENHANCED_BOOKMARKS_METADATA_ACCESSOR_H_
#define COMPONENTS_ENHANCED_BOOKMARKS_METADATA_ACCESSOR_H_
#include <set>
#include <string>
#include <vector>
class GURL;
namespace bookmarks {
class BookmarkModel;
class BookmarkNode;
}
// TODO(rfevang): Remove this file once the remaining caller
// is converted (enhanced_bookmarks_bridge.cc)
// The functions in this file store and retrieve structured data encoded in the
// bookmark metadata. This information suplements the data in the bookmark with
// images and descriptions related to the url.
namespace enhanced_bookmarks {
typedef std::vector<const bookmarks::BookmarkNode*> NodeVector;
typedef std::set<const bookmarks::BookmarkNode*> NodeSet;
// The keys used to store the data in the bookmarks metadata dictionary.
extern const char* kPageDataKey;
extern const char* kImageDataKey;
extern const char* kIdDataKey;
extern const char* kNoteKey;
// Returns the remoteId for a bookmark. If the bookmark doesn't have one already
// this function will create and set one.
std::string RemoteIdFromBookmark(bookmarks::BookmarkModel* bookmark_model,
const bookmarks::BookmarkNode* node);
// Sets the description of a bookmark.
void SetDescriptionForBookmark(bookmarks::BookmarkModel* bookmark_model,
const bookmarks::BookmarkNode* node,
const std::string& description);
// Returns the description of a bookmark.
std::string DescriptionFromBookmark(const bookmarks::BookmarkNode* node);
// Sets the URL of an image representative of the page.
// Expects the URL to be valid and not empty.
// Returns true if the metainfo is successfully populated.
bool SetOriginalImageForBookmark(bookmarks::BookmarkModel* bookmark_model,
const bookmarks::BookmarkNode* node,
const GURL& url,
int width,
int height);
// Returns the url and dimensions of the original scraped image.
// Returns true if the out variables are populated, false otherwise.
bool OriginalImageFromBookmark(const bookmarks::BookmarkNode* node,
GURL* url,
int* width,
int* height);
// Returns the url and dimensions of the server provided thumbnail image.
// Returns true if the out variables are populated, false otherwise.
bool ThumbnailImageFromBookmark(const bookmarks::BookmarkNode* node,
GURL* url,
int* width,
int* height);
// Returns a brief server provided synopsis of the bookmarked page.
// Returns the empty string if the snippet could not be extracted.
std::string SnippetFromBookmark(const bookmarks::BookmarkNode* node);
// Used for testing, simulates the process that creates the thumnails. Will
// remove existing entries for empty urls or set them if the url is not empty.
// expects valid or empty urls. Returns true if the metainfo is successfully
// populated.
bool SetAllImagesForBookmark(bookmarks::BookmarkModel* bookmark_model,
const bookmarks::BookmarkNode* node,
const GURL& image_url,
int image_width,
int image_height,
const GURL& thumbnail_url,
int thumbnail_width,
int thumbnail_height);
} // namespace enhanced_bookmarks
#endif // COMPONENTS_ENHANCED_BOOKMARKS_METADATA_ACCESSOR_H_
|
