4 use Shaarli\Config\ConfigManager
;
5 use Shaarli\NetscapeBookmarkParser\NetscapeBookmarkParser
;
6 use Katzgrau\KLogger\Logger
;
9 * Utilities to import and export bookmarks using the Netscape format
10 * TODO: Not static, use a container.
12 class NetscapeBookmarkUtils
16 * Filters links and adds Netscape-formatted fields
19 * - timestamp link addition date, using the Unix epoch format
20 * - taglist comma-separated tag list
22 * @param LinkDB $linkDb Link datastore
23 * @param string $selection Which links to export: (all|private|public)
24 * @param bool $prependNoteUrl Prepend note permalinks with the server's URL
25 * @param string $indexUrl Absolute URL of the Shaarli index page
27 * @throws Exception Invalid export selection
29 * @return array The links to be exported, with additional fields
31 public static function filterAndFormat($linkDb, $selection, $prependNoteUrl, $indexUrl)
33 // see tpl/export.html for possible values
34 if (! in_array($selection, array('all', 'public', 'private'))) {
35 throw new Exception('Invalid export selection: "'.$selection.'"');
38 $bookmarkLinks = array();
40 foreach ($linkDb as $link) {
41 if ($link['private'] != 0 && $selection == 'public') {
44 if ($link['private'] == 0 && $selection == 'private') {
47 $date = $link['created'];
48 $link['timestamp'] = $date->getTimestamp();
49 $link['taglist'] = str_replace(' ', ',', $link['tags']);
51 if (startsWith($link['url'], '?') && $prependNoteUrl) {
52 $link['url'] = $indexUrl . $link['url'];
55 $bookmarkLinks[] = $link;
58 return $bookmarkLinks;
62 * Generates an import status summary
64 * @param string $filename name of the file to import
65 * @param int $filesize size of the file to import
66 * @param int $importCount how many links were imported
67 * @param int $overwriteCount how many links were overwritten
68 * @param int $skipCount how many links were skipped
69 * @param int $duration how many seconds did the import take
71 * @return string Summary of the bookmark import status
73 private static function importStatus(
82 $status = 'File '.$filename.' ('.$filesize.' bytes) ';
83 if ($importCount == 0 && $overwriteCount == 0 && $skipCount == 0) {
84 $status .= 'has an unknown file format. Nothing was imported.';
86 $status .= 'was successfully processed in '. $duration .' seconds: ';
87 $status .= $importCount.' links imported, ';
88 $status .= $overwriteCount.' links overwritten, ';
89 $status .= $skipCount.' links skipped.';
95 * Imports Web bookmarks from an uploaded Netscape bookmark dump
97 * @param array $post Server $_POST parameters
98 * @param array $files Server $_FILES parameters
99 * @param LinkDB $linkDb Loaded LinkDB instance
100 * @param ConfigManager $conf instance
101 * @param History $history History instance
103 * @return string Summary of the bookmark import status
105 public static function import($post, $files, $linkDb, $conf, $history)
108 $filename = $files['filetoupload']['name'];
109 $filesize = $files['filetoupload']['size'];
110 $data = file_get_contents($files['filetoupload']['tmp_name']);
112 if (strpos($data, '<!DOCTYPE NETSCAPE-Bookmark-file-1>') === false) {
113 return self
::importStatus($filename, $filesize);
116 // Overwrite existing links?
117 $overwrite = ! empty($post['overwrite']);
119 // Add tags to all imported links?
120 if (empty($post['default_tags'])) {
121 $defaultTags = array();
123 $defaultTags = preg_split(
125 escape($post['default_tags'])
129 // links are imported as public by default
132 $parser = new NetscapeBookmarkParser(
133 true, // nested tag support
134 $defaultTags, // additional user-specified tags
135 strval(1 - $defaultPrivacy), // defaultPub = 1 - defaultPrivacy
136 $conf->get('resource.data_dir') // log path, will be overridden
138 $logger = new Logger(
139 $conf->get('resource.data_dir'),
140 ! $conf->get('dev.debug') ? LogLevel
::INFO
: LogLevel
::DEBUG
,
142 'prefix' => 'import.',
143 'extension' => 'log',
146 $parser->setLogger($logger);
147 $bookmarks = $parser->parseString($data);
153 foreach ($bookmarks as $bkm) {
154 $private = $defaultPrivacy;
155 if (empty($post['privacy']) || $post['privacy'] == 'default') {
156 // use value from the imported file
157 $private = $bkm['pub'] == '1' ? 0 : 1;
158 } else if ($post['privacy'] == 'private') {
159 // all imported links are private
161 } else if ($post['privacy'] == 'public') {
162 // all imported links are public
167 'title' => $bkm['title'],
168 'url' => $bkm['uri'],
169 'description' => $bkm['note'],
170 'private' => $private,
171 'tags' => $bkm['tags']
174 $existingLink = $linkDb->getLinkFromUrl($bkm['uri']);
176 if ($existingLink !== false) {
177 if ($overwrite === false) {
178 // Do not overwrite an existing link
183 // Overwrite an existing link, keep its date
184 $newLink['id'] = $existingLink['id'];
185 $newLink['created'] = $existingLink['created'];
186 $newLink['updated'] = new DateTime();
187 $newLink['shorturl'] = $existingLink['shorturl'];
188 $linkDb[$existingLink['id']] = $newLink;
194 // Add a new link - @ used for UNIX timestamps
195 $newLinkDate = new DateTime('@'.strval($bkm['time']));
196 $newLinkDate->setTimezone(new DateTimeZone(date_default_timezone_get()));
197 $newLink['created'] = $newLinkDate;
198 $newLink['id'] = $linkDb->getNextId();
199 $newLink['shorturl'] = link_small_hash($newLink['created'], $newLink['id']);
200 $linkDb[$newLink['id']] = $newLink;
204 $linkDb->save($conf->get('resource.page_cache'));
205 $history->importLinks();
207 $duration = time() - $start;
208 return self
::importStatus(