]> git.immae.eu Git - github/shaarli/Shaarli.git/blob - application/NetscapeBookmarkUtils.php
Docker: expose a volume for the thumbnail cache
[github/shaarli/Shaarli.git] / application / NetscapeBookmarkUtils.php
1 <?php
2
3 use Psr\Log\LogLevel;
4 use Shaarli\Config\ConfigManager;
5 use Shaarli\NetscapeBookmarkParser\NetscapeBookmarkParser;
6 use Katzgrau\KLogger\Logger;
7
8 /**
9 * Utilities to import and export bookmarks using the Netscape format
10 * TODO: Not static, use a container.
11 */
12 class NetscapeBookmarkUtils
13 {
14
15 /**
16 * Filters links and adds Netscape-formatted fields
17 *
18 * Added fields:
19 * - timestamp link addition date, using the Unix epoch format
20 * - taglist comma-separated tag list
21 *
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
26 *
27 * @throws Exception Invalid export selection
28 *
29 * @return array The links to be exported, with additional fields
30 */
31 public static function filterAndFormat($linkDb, $selection, $prependNoteUrl, $indexUrl)
32 {
33 // see tpl/export.html for possible values
34 if (! in_array($selection, array('all', 'public', 'private'))) {
35 throw new Exception(t('Invalid export selection:') .' "'.$selection.'"');
36 }
37
38 $bookmarkLinks = array();
39 foreach ($linkDb as $link) {
40 if ($link['private'] != 0 && $selection == 'public') {
41 continue;
42 }
43 if ($link['private'] == 0 && $selection == 'private') {
44 continue;
45 }
46 $date = $link['created'];
47 $link['timestamp'] = $date->getTimestamp();
48 $link['taglist'] = str_replace(' ', ',', $link['tags']);
49
50 if (startsWith($link['url'], '?') && $prependNoteUrl) {
51 $link['url'] = $indexUrl . $link['url'];
52 }
53
54 $bookmarkLinks[] = $link;
55 }
56
57 return $bookmarkLinks;
58 }
59
60 /**
61 * Generates an import status summary
62 *
63 * @param string $filename name of the file to import
64 * @param int $filesize size of the file to import
65 * @param int $importCount how many links were imported
66 * @param int $overwriteCount how many links were overwritten
67 * @param int $skipCount how many links were skipped
68 * @param int $duration how many seconds did the import take
69 *
70 * @return string Summary of the bookmark import status
71 */
72 private static function importStatus(
73 $filename,
74 $filesize,
75 $importCount=0,
76 $overwriteCount=0,
77 $skipCount=0,
78 $duration=0
79 )
80 {
81 $status = sprintf(t('File %s (%d bytes) '), $filename, $filesize);
82 if ($importCount == 0 && $overwriteCount == 0 && $skipCount == 0) {
83 $status .= t('has an unknown file format. Nothing was imported.');
84 } else {
85 $status .= vsprintf(
86 t('was successfully processed in %d seconds: %d links imported, %d links overwritten, %d links skipped.'),
87 [$duration, $importCount, $overwriteCount, $skipCount]
88 );
89 }
90 return $status;
91 }
92
93 /**
94 * Imports Web bookmarks from an uploaded Netscape bookmark dump
95 *
96 * @param array $post Server $_POST parameters
97 * @param array $files Server $_FILES parameters
98 * @param LinkDB $linkDb Loaded LinkDB instance
99 * @param ConfigManager $conf instance
100 * @param History $history History instance
101 *
102 * @return string Summary of the bookmark import status
103 */
104 public static function import($post, $files, $linkDb, $conf, $history)
105 {
106 $start = time();
107 $filename = $files['filetoupload']['name'];
108 $filesize = $files['filetoupload']['size'];
109 $data = file_get_contents($files['filetoupload']['tmp_name']);
110
111 if (preg_match('/<!DOCTYPE NETSCAPE-Bookmark-file-1>/i', $data) === 0) {
112 return self::importStatus($filename, $filesize);
113 }
114
115 // Overwrite existing links?
116 $overwrite = ! empty($post['overwrite']);
117
118 // Add tags to all imported links?
119 if (empty($post['default_tags'])) {
120 $defaultTags = array();
121 } else {
122 $defaultTags = preg_split(
123 '/[\s,]+/',
124 escape($post['default_tags'])
125 );
126 }
127
128 // links are imported as public by default
129 $defaultPrivacy = 0;
130
131 $parser = new NetscapeBookmarkParser(
132 true, // nested tag support
133 $defaultTags, // additional user-specified tags
134 strval(1 - $defaultPrivacy), // defaultPub = 1 - defaultPrivacy
135 $conf->get('resource.data_dir') // log path, will be overridden
136 );
137 $logger = new Logger(
138 $conf->get('resource.data_dir'),
139 ! $conf->get('dev.debug') ? LogLevel::INFO : LogLevel::DEBUG,
140 [
141 'prefix' => 'import.',
142 'extension' => 'log',
143 ]
144 );
145 $parser->setLogger($logger);
146 $bookmarks = $parser->parseString($data);
147
148 $importCount = 0;
149 $overwriteCount = 0;
150 $skipCount = 0;
151
152 foreach ($bookmarks as $bkm) {
153 $private = $defaultPrivacy;
154 if (empty($post['privacy']) || $post['privacy'] == 'default') {
155 // use value from the imported file
156 $private = $bkm['pub'] == '1' ? 0 : 1;
157 } elseif ($post['privacy'] == 'private') {
158 // all imported links are private
159 $private = 1;
160 } elseif ($post['privacy'] == 'public') {
161 // all imported links are public
162 $private = 0;
163 }
164
165 $newLink = array(
166 'title' => $bkm['title'],
167 'url' => $bkm['uri'],
168 'description' => $bkm['note'],
169 'private' => $private,
170 'tags' => $bkm['tags']
171 );
172
173 $existingLink = $linkDb->getLinkFromUrl($bkm['uri']);
174
175 if ($existingLink !== false) {
176 if ($overwrite === false) {
177 // Do not overwrite an existing link
178 $skipCount++;
179 continue;
180 }
181
182 // Overwrite an existing link, keep its date
183 $newLink['id'] = $existingLink['id'];
184 $newLink['created'] = $existingLink['created'];
185 $newLink['updated'] = new DateTime();
186 $newLink['shorturl'] = $existingLink['shorturl'];
187 $linkDb[$existingLink['id']] = $newLink;
188 $importCount++;
189 $overwriteCount++;
190 continue;
191 }
192
193 // Add a new link - @ used for UNIX timestamps
194 $newLinkDate = new DateTime('@'.strval($bkm['time']));
195 $newLinkDate->setTimezone(new DateTimeZone(date_default_timezone_get()));
196 $newLink['created'] = $newLinkDate;
197 $newLink['id'] = $linkDb->getNextId();
198 $newLink['shorturl'] = link_small_hash($newLink['created'], $newLink['id']);
199 $linkDb[$newLink['id']] = $newLink;
200 $importCount++;
201 }
202
203 $linkDb->save($conf->get('resource.page_cache'));
204 $history->importLinks();
205
206 $duration = time() - $start;
207 return self::importStatus(
208 $filename,
209 $filesize,
210 $importCount,
211 $overwriteCount,
212 $skipCount,
213 $duration
214 );
215 }
216 }