]>
git.immae.eu Git - github/shaarli/Shaarli.git/blob - application/NetscapeBookmarkUtils.php
4 * Utilities to import and export bookmarks using the Netscape format
6 class NetscapeBookmarkUtils
10 * Filters links and adds Netscape-formatted fields
13 * - timestamp link addition date, using the Unix epoch format
14 * - taglist comma-separated tag list
16 * @param LinkDB $linkDb Link datastore
17 * @param string $selection Which links to export: (all|private|public)
18 * @param bool $prependNoteUrl Prepend note permalinks with the server's URL
19 * @param string $indexUrl Absolute URL of the Shaarli index page
21 * @throws Exception Invalid export selection
23 * @return array The links to be exported, with additional fields
25 public static function filterAndFormat($linkDb, $selection, $prependNoteUrl, $indexUrl)
27 // see tpl/export.html for possible values
28 if (! in_array($selection, array('all', 'public', 'private'))) {
29 throw new Exception('Invalid export selection: "'.$selection.'"');
32 $bookmarkLinks = array();
34 foreach ($linkDb as $link) {
35 if ($link['private'] != 0 && $selection == 'public') {
38 if ($link['private'] == 0 && $selection == 'private') {
41 $date = DateTime
::createFromFormat(LinkDB
::LINK_DATE_FORMAT
, $link['linkdate']);
42 $link['timestamp'] = $date->getTimestamp();
43 $link['taglist'] = str_replace(' ', ',', $link['tags']);
45 if (startsWith($link['url'], '?') && $prependNoteUrl) {
46 $link['url'] = $indexUrl . $link['url'];
49 $bookmarkLinks[] = $link;
52 return $bookmarkLinks;
56 * Generates an import status summary
58 * @param string $filename name of the file to import
59 * @param int $filesize size of the file to import
60 * @param int $importCount how many links were imported
61 * @param int $overwriteCount how many links were overwritten
62 * @param int $skipCount how many links were skipped
64 * @return string Summary of the bookmark import status
66 private static function importStatus(
74 $status = 'File '.$filename.' ('.$filesize.' bytes) ';
75 if ($importCount == 0 && $overwriteCount == 0 && $skipCount == 0) {
76 $status .= 'has an unknown file format. Nothing was imported.';
78 $status .= 'was successfully processed: '.$importCount.' links imported, ';
79 $status .= $overwriteCount.' links overwritten, ';
80 $status .= $skipCount.' links skipped.';
86 * Imports Web bookmarks from an uploaded Netscape bookmark dump
88 * @param array $post Server $_POST parameters
89 * @param array $files Server $_FILES parameters
90 * @param LinkDB $linkDb Loaded LinkDB instance
91 * @param string $pagecache Page cache
93 * @return string Summary of the bookmark import status
95 public static function import($post, $files, $linkDb, $pagecache)
97 $filename = $files['filetoupload']['name'];
98 $filesize = $files['filetoupload']['size'];
99 $data = file_get_contents($files['filetoupload']['tmp_name']);
101 if (strpos($data, '<!DOCTYPE NETSCAPE-Bookmark-file-1>') === false) {
102 return self
::importStatus($filename, $filesize);
105 // Overwrite existing links?
106 $overwrite = ! empty($post['overwrite']);
108 // Add tags to all imported links?
109 if (empty($post['default_tags'])) {
110 $defaultTags = array();
112 $defaultTags = preg_split(
114 escape($post['default_tags'])
118 // links are imported as public by default
121 $parser = new NetscapeBookmarkParser(
122 true, // nested tag support
123 $defaultTags, // additional user-specified tags
124 strval(1 - $defaultPrivacy) // defaultPub = 1 - defaultPrivacy
126 $bookmarks = $parser->parseString($data);
132 foreach ($bookmarks as $bkm) {
133 $private = $defaultPrivacy;
134 if (empty($post['privacy']) || $post['privacy'] == 'default') {
135 // use value from the imported file
136 $private = $bkm['pub'] == '1' ? 0 : 1;
137 } else if ($post['privacy'] == 'private') {
138 // all imported links are private
140 } else if ($post['privacy'] == 'public') {
141 // all imported links are public
146 'title' => $bkm['title'],
147 'url' => $bkm['uri'],
148 'description' => $bkm['note'],
149 'private' => $private,
151 'tags' => $bkm['tags']
154 $existingLink = $linkDb->getLinkFromUrl($bkm['uri']);
156 if ($existingLink !== false) {
157 if ($overwrite === false) {
158 // Do not overwrite an existing link
163 // Overwrite an existing link, keep its date
164 $newLink['linkdate'] = $existingLink['linkdate'];
165 $linkDb[$existingLink['linkdate']] = $newLink;
172 $newLinkDate = new DateTime('@'.strval($bkm['time']));
173 while (!empty($linkDb[$newLinkDate->format(LinkDB
::LINK_DATE_FORMAT
)])) {
174 // Ensure the date/time is not already used
175 // - this hack is necessary as the date/time acts as a primary key
176 // - apply 1 second increments until an unused index is found
177 // See https://github.com/shaarli/Shaarli/issues/351
178 $newLinkDate->add(new DateInterval('PT1S'));
180 $linkDbDate = $newLinkDate->format(LinkDB
::LINK_DATE_FORMAT
);
181 $newLink['linkdate'] = $linkDbDate;
182 $linkDb[$linkDbDate] = $newLink;
186 $linkDb->savedb($pagecache);
187 return self
::importStatus(