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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
/*******************************************************************************
* Copyright (c) 2000, 2011 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.help.internal.base;
import java.util.ArrayList;
import java.util.Observable;
import java.util.StringTokenizer;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.preferences.IEclipsePreferences;
import org.eclipse.core.runtime.preferences.InstanceScope;
import org.eclipse.help.IHelpResource;
import org.eclipse.help.internal.base.util.TString;
import org.osgi.service.prefs.BackingStoreException;
/**
* Code for bookmark management has been moved here so that it can be shared
* between the web app and the help view. The manager implements Observable so
* that views can be notified on bookmark changes. The webapp does not use this
* feature.
*
* @since 3.1
*/
public class BookmarkManager extends Observable {
// all bookmarks removed
public static final int REMOVE_ALL = 1;
// bookmark added
public static final int ADD = 2;
// bookmark removed
public static final int REMOVE = 3;
// bookmark changed
public static final int CHANGE = 4;
// everything changed (by the webapp)
public static final int WORLD_CHANGED = 5;
private ArrayList<Bookmark> bookmarks;
public static class Bookmark implements IHelpResource {
private String label;
private String href;
public Bookmark(String label, String href) {
this.label = label;
this.href = href;
}
@Override
public String getHref() {
return href;
}
@Override
public String getLabel() {
return label;
}
@Override
public boolean equals(Object object) {
if (object == null)
return false;
if (object == this)
return true;
if (object instanceof Bookmark) {
Bookmark b = (Bookmark) object;
return b.href.equals(href) && b.label.equals(label);
}
return false;
}
}
public static class BookmarkEvent {
private int type;
private Bookmark bookmark;
public BookmarkEvent(int type, Bookmark bookmark) {
this.type = type;
this.bookmark = bookmark;
}
public int getType() {
return type;
}
public Bookmark getBookmark() {
return bookmark;
}
}
public BookmarkManager() {
}
public void close() {
}
public void addBookmark(String bookmarkURL, String title) {
if (bookmarkURL != null && bookmarkURL.length() > 0
&& !bookmarkURL.equals("about:blank")) { //$NON-NLS-1$
if (title == null) {
return;
}
String bookmarks = readBookmarks();
// separate the url and title by vertical bar
// check for duplicates
if (bookmarks.indexOf("," + encode(bookmarkURL) + "|") != -1) //$NON-NLS-1$ //$NON-NLS-2$
return;
bookmarks = bookmarks
+ "," + encode(bookmarkURL) + "|" + encode(title); //$NON-NLS-1$ //$NON-NLS-2$
saveBookmarks(bookmarks);
Bookmark bookmark = new Bookmark(title, bookmarkURL);
if (this.bookmarks!=null)
this.bookmarks.add(bookmark);
setChanged();
notifyObservers(new BookmarkEvent(ADD, bookmark));
}
}
public void removeBookmark(String bookmarkURL, String title) {
removeBookmark(new Bookmark(title, bookmarkURL));
}
public void removeBookmark(Bookmark bookmark) {
String bookmarkURL = bookmark.getHref();
String title = bookmark.getLabel();
if (bookmarkURL != null && bookmarkURL.length() > 0
&& !bookmarkURL.equals("about:blank")) { //$NON-NLS-1$
if (title == null) {
return;
}
String bookmarks = readBookmarks();
String removeString = "," + encode(bookmarkURL) + "|" + encode(title); //$NON-NLS-1$ //$NON-NLS-2$
int i = bookmarks.indexOf(removeString);
if (i == -1)
return;
bookmarks = bookmarks.substring(0, i)
+ bookmarks.substring(i + removeString.length());
saveBookmarks(bookmarks);
if (this.bookmarks!=null)
this.bookmarks.remove(bookmark);
setChanged();
notifyObservers(new BookmarkEvent(REMOVE, bookmark));
}
}
public void removeAllBookmarks() {
saveBookmarks(""); //$NON-NLS-1$
if (bookmarks!=null)
bookmarks.clear();
setChanged();
notifyObservers(new BookmarkEvent(REMOVE_ALL, null));
}
public IHelpResource[] getBookmarks() {
if (bookmarks==null) {
String value = readBookmarks();
StringTokenizer tokenizer = new StringTokenizer(value, ","); //$NON-NLS-1$
bookmarks = new ArrayList<Bookmark>();
while (tokenizer.hasMoreTokens()) {
String bookmark = tokenizer.nextToken();
// url and title are separated by vertical bar
int separator = bookmark.indexOf('|');
String label = decode(bookmark.substring(separator + 1));
String href = separator < 0 ? "" //$NON-NLS-1$
: decode(bookmark.substring(0, separator));
bookmarks.add(new Bookmark(label, href));
}
}
return bookmarks.toArray(new IHelpResource[bookmarks.size()]);
}
/**
* Ensures that string does not contains ',' or '|' characters.
*
* @param s
* @return String
*/
private static String encode(String s) {
s = TString.change(s, "\\", "\\escape"); //$NON-NLS-1$ //$NON-NLS-2$
s = TString.change(s, ",", "\\comma"); //$NON-NLS-1$ //$NON-NLS-2$
return TString.change(s, "|", "\\pipe"); //$NON-NLS-1$ //$NON-NLS-2$
}
private static String decode(String s) {
s = TString.change(s, "\\pipe", "|"); //$NON-NLS-1$ //$NON-NLS-2$
s = TString.change(s, "\\comma", ","); //$NON-NLS-1$ //$NON-NLS-2$
return TString.change(s, "\\escape", "\\"); //$NON-NLS-1$ //$NON-NLS-2$
}
private String readBookmarks() {
return Platform.getPreferencesService().getString(HelpBasePlugin.PLUGIN_ID, BaseHelpSystem.BOOKMARKS, "", null); //$NON-NLS-1$
}
private void saveBookmarks(String bookmarks) {
IEclipsePreferences prefs = InstanceScope.INSTANCE.getNode(HelpBasePlugin.PLUGIN_ID);
prefs.put(BaseHelpSystem.BOOKMARKS, bookmarks);
try {
prefs.flush();
} catch (BackingStoreException e) {
}
}
}
|
