3 namespace Shaarli\Netscape
;
8 use Katzgrau\KLogger\Logger
;
10 use Shaarli\Bookmark\Bookmark
;
11 use Shaarli\Bookmark\BookmarkServiceInterface
;
12 use Shaarli\Config\ConfigManager
;
13 use Shaarli\Formatter\BookmarkFormatter
;
15 use Shaarli\NetscapeBookmarkParser\NetscapeBookmarkParser
;
18 * Utilities to import and export bookmarks using the Netscape format
19 * TODO: Not static, use a container.
21 class NetscapeBookmarkUtils
25 * Filters bookmarks and adds Netscape-formatted fields
28 * - timestamp link addition date, using the Unix epoch format
29 * - taglist comma-separated tag list
31 * @param BookmarkServiceInterface $bookmarkService Link datastore
32 * @param BookmarkFormatter $formatter instance
33 * @param string $selection Which bookmarks to export: (all|private|public)
34 * @param bool $prependNoteUrl Prepend note permalinks with the server's URL
35 * @param string $indexUrl Absolute URL of the Shaarli index page
37 * @return array The bookmarks to be exported, with additional fields
38 *@throws Exception Invalid export selection
41 public static function filterAndFormat(
48 // see tpl/export.html for possible values
49 if (!in_array($selection, array('all', 'public', 'private'))) {
50 throw new Exception(t('Invalid export selection:') . ' "' . $selection . '"');
53 $bookmarkLinks = array();
54 foreach ($bookmarkService->search([], $selection) as $bookmark) {
55 $link = $formatter->format($bookmark);
56 $link['taglist'] = implode(',', $bookmark->getTags());
57 if ($bookmark->isNote() && $prependNoteUrl) {
58 $link['url'] = $indexUrl . $link['url'];
61 $bookmarkLinks[] = $link;
64 return $bookmarkLinks;
68 * Generates an import status summary
70 * @param string $filename name of the file to import
71 * @param int $filesize size of the file to import
72 * @param int $importCount how many bookmarks were imported
73 * @param int $overwriteCount how many bookmarks were overwritten
74 * @param int $skipCount how many bookmarks were skipped
75 * @param int $duration how many seconds did the import take
77 * @return string Summary of the bookmark import status
79 private static function importStatus(
87 $status = sprintf(t('File %s (%d bytes) '), $filename, $filesize);
88 if ($importCount == 0 && $overwriteCount == 0 && $skipCount == 0) {
89 $status .= t('has an unknown file format. Nothing was imported.');
93 'was successfully processed in %d seconds: '
94 . '%d bookmarks imported, %d bookmarks overwritten, %d bookmarks skipped.'
96 [$duration, $importCount, $overwriteCount, $skipCount]
103 * Imports Web bookmarks from an uploaded Netscape bookmark dump
105 * @param array $post Server $_POST parameters
106 * @param array $files Server $_FILES parameters
107 * @param BookmarkServiceInterface $bookmarkService Loaded LinkDB instance
108 * @param ConfigManager $conf instance
109 * @param History $history History instance
111 * @return string Summary of the bookmark import status
113 public static function import($post, $files, $bookmarkService, $conf, $history)
116 $filename = $files['filetoupload']['name'];
117 $filesize = $files['filetoupload']['size'];
118 $data = file_get_contents($files['filetoupload']['tmp_name']);
120 if (preg_match('/<!DOCTYPE NETSCAPE-Bookmark-file-1>/i', $data) === 0) {
121 return self
::importStatus($filename, $filesize);
124 // Overwrite existing bookmarks?
125 $overwrite = !empty($post['overwrite']);
127 // Add tags to all imported bookmarks?
128 if (empty($post['default_tags'])) {
129 $defaultTags = array();
131 $defaultTags = preg_split(
133 escape($post['default_tags'])
137 // bookmarks are imported as public by default
140 $parser = new NetscapeBookmarkParser(
141 true, // nested tag support
142 $defaultTags, // additional user-specified tags
143 strval(1 - $defaultPrivacy), // defaultPub = 1 - defaultPrivacy
144 $conf->get('resource.data_dir') // log path, will be overridden
146 $logger = new Logger(
147 $conf->get('resource.data_dir'),
148 !$conf->get('dev.debug') ? LogLevel
::INFO
: LogLevel
::DEBUG
,
150 'prefix' => 'import.',
151 'extension' => 'log',
154 $parser->setLogger($logger);
155 $bookmarks = $parser->parseString($data);
161 foreach ($bookmarks as $bkm) {
162 $private = $defaultPrivacy;
163 if (empty($post['privacy']) || $post['privacy'] == 'default') {
164 // use value from the imported file
165 $private = $bkm['pub'] == '1' ? 0 : 1;
166 } elseif ($post['privacy'] == 'private') {
167 // all imported bookmarks are private
169 } elseif ($post['privacy'] == 'public') {
170 // all imported bookmarks are public
174 $link = $bookmarkService->findByUrl($bkm['uri']);
175 $existingLink = $link !== null;
176 if (! $existingLink) {
177 $link = new Bookmark();
180 if ($existingLink !== false) {
181 if ($overwrite === false) {
182 // Do not overwrite an existing link
187 $link->setUpdated(new DateTime());
190 $newLinkDate = new DateTime('@' . strval($bkm['time']));
191 $newLinkDate->setTimezone(new DateTimeZone(date_default_timezone_get()));
192 $link->setCreated($newLinkDate);
195 $link->setTitle($bkm['title']);
196 $link->setUrl($bkm['uri'], $conf->get('security.allowed_protocols'));
197 $link->setDescription($bkm['note']);
198 $link->setPrivate($private);
199 $link->setTagsString($bkm['tags']);
201 $bookmarkService->addOrSet($link, false);
205 $bookmarkService->save();
206 $history->importLinks();
208 $duration = time() - $start;
209 return self
::importStatus(