summaryrefslogtreecommitdiff
path: root/Providers/QSLinkdingProvider.m
blob: 32b4c1682b1ac1e3e48e2bbd646cee400ab3ebba (plain)
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
218
219
220
221
222
223
224
225
226
227
228
//
//  QSLinkdingProvider.m
//  QSDeliciousPlugIn
//

#import "QSLinkdingProvider.h"
#import "Constants.h"
#import "SocialSite.h"
#import <QSCore/QSCore.h>

@implementation QSLinkdingProvider

- (BOOL)canHandleSite:(SocialSite)site
             username:(NSString *)username
             password:(NSString *)password
                 host:(NSString *)host {
  return (site == SocialSiteLinkding) && username.length > 0 &&
         password.length > 0 && // password is API token for Linkding
         host.length > 0;
}

- (NSData *)cachedBookmarkDataForHost:(NSString *)host
                             username:(NSString *)username {
  // Create a safe filename from host
  NSString *safeHost =
      [[host componentsSeparatedByCharactersInSet:[[NSCharacterSet
                                                      alphanumericCharacterSet]
                                                      invertedSet]]
          componentsJoinedByString:@"-"];
  NSString *cachePath = [QSApplicationSupportSubPath(
      [NSString stringWithFormat:@"Caches/linkding/"], NO)
      stringByAppendingPathComponent:[NSString stringWithFormat:@"%@-%@.json",
                                                                safeHost,
                                                                username]];
  return [NSData dataWithContentsOfFile:cachePath];
}

- (void)cacheBookmarkData:(NSData *)data
                  forHost:(NSString *)host
                 username:(NSString *)username {
  // Create a safe filename from host
  NSString *safeHost =
      [[host componentsSeparatedByCharactersInSet:[[NSCharacterSet
                                                      alphanumericCharacterSet]
                                                      invertedSet]]
          componentsJoinedByString:@"-"];
  NSString *cachePath = [QSApplicationSupportSubPath(
      [NSString stringWithFormat:@"Caches/linkding/"], YES)
      stringByAppendingPathComponent:[NSString stringWithFormat:@"%@-%@.json",
                                                                safeHost,
                                                                username]];
  [data writeToFile:cachePath atomically:NO];
}

- (NSArray *)fetchBookmarksForSite:(SocialSite)site
                          username:(NSString *)username
                          password:(NSString *)password
                        identifier:(NSString *)identifier
                              host:(NSString *)host
                       includeTags:(BOOL)includeTags {

  if (![self canHandleSite:site
                  username:username
                  password:password
                      host:host]) {
    return @[];
  }

  NSData *data = [self cachedBookmarkDataForHost:host username:username];

  if (![data length]) {
    NSString *baseURL = host;
    if (![baseURL hasPrefix:@"http://"] && ![baseURL hasPrefix:@"https://"]) {
      baseURL = [NSString stringWithFormat:@"https://%@", baseURL];
    }
    if ([baseURL hasSuffix:@"/"]) {
      baseURL = [baseURL substringToIndex:[baseURL length] - 1];
    }

    // I'm being lazy with the limit for now. This should instead loop while
    // there is a next, but then the caching will also need to be changed. If
    // you have a particularly large linkding library, I apologize.
    NSString *urlString =
        [NSString stringWithFormat:@"%@/api/bookmarks/?limit=10000", baseURL];
    NSURL *requestURL = [NSURL URLWithString:urlString];

    if (!requestURL) {
      NSLog(@"Invalid Linkding host URL: %@", host);
      return @[];
    }

    NSMutableURLRequest *theRequest =
        [NSMutableURLRequest requestWithURL:requestURL
                                cachePolicy:NSURLRequestUseProtocolCachePolicy
                            timeoutInterval:60.0];
    [theRequest setHTTPMethod:@"GET"];
    [theRequest setValue:@"application/json" forHTTPHeaderField:@"Accept"];
    [theRequest setValue:[NSString stringWithFormat:@"Token %@", password]
        forHTTPHeaderField:@"Authorization"];
    [theRequest setValue:@"Quicksilver (Blacktree,MacOSX)"
        forHTTPHeaderField:@"User-Agent"];

    NSError *error = nil;
    data = [NSURLConnection sendSynchronousRequest:theRequest
                                 returningResponse:nil
                                             error:&error];

    if (error) {
      NSLog(@"Error fetching Linkding bookmarks: %@",
            error.localizedDescription);
      return @[];
    }

    [self cacheBookmarkData:data forHost:host username:username];
  }

  NSError *jsonError = nil;
  NSDictionary *jsonResponse =
      [NSJSONSerialization JSONObjectWithData:data options:0 error:&jsonError];

  if (jsonError) {
    NSLog(@"Error parsing Linkding JSON: %@", jsonError.localizedDescription);
    return @[];
  }

  NSArray *results = [jsonResponse objectForKey:@"results"];
  if (!results || ![results isKindOfClass:[NSArray class]]) {
    NSLog(@"Invalid Linkding response format");
    return @[];
  }

  NSMutableArray *objects = [NSMutableArray arrayWithCapacity:1];
  NSMutableSet *tagSet = [NSMutableSet set];

  for (NSDictionary *bookmark in results) {
    QSObject *newObject = [self objectForLinkdingBookmark:bookmark];
    if (newObject) {
      [objects addObject:newObject];

      if (includeTags) {
        NSArray *tags = [bookmark objectForKey:@"tag_names"];
        if (tags && [tags isKindOfClass:[NSArray class]]) {
          [tagSet addObjectsFromArray:tags];
        }
      }
    }
  }

  if (includeTags) {
    for (NSString *tag in tagSet) {
      if (tag.length > 0) {
        QSObject *tagObject = [QSObject
            makeObjectWithIdentifier:[NSString
                                         stringWithFormat:@"[Linkding tag]:%@",
                                                          tag]];
        [tagObject setObject:tag forType:kTagType];
        [tagObject setObject:@(site) forMeta:kTagSiteField];
        [tagObject setObject:username forMeta:kTagUsernameField];
        [tagObject setObject:host forMeta:kTagHostField];
        // We need the identifier to be able to fetch the keychain password
        [tagObject setObject:identifier forMeta:kTagIdentifierField];
        [tagObject setName:tag];
        [tagObject setPrimaryType:kTagType];
        [objects addObject:tagObject];
      }
    }
  }

  return objects;
}

- (NSArray *)fetchBookmarksForTag:(NSString *)tag
                             site:(SocialSite)site
                         username:(NSString *)username
                         password:(NSString *)password
                             host:(NSString *)host {
  NSData *data = [self cachedBookmarkDataForHost:host username:username];
  if (!data)
    return @[];

  NSError *jsonError;
  NSDictionary *jsonResponse =
      [NSJSONSerialization JSONObjectWithData:data options:0 error:&jsonError];

  if (jsonError)
    return @[];

  NSArray *results = [jsonResponse objectForKey:@"results"];
  if (!results || ![results isKindOfClass:[NSArray class]])
    return @[];

  NSMutableArray *objects = [NSMutableArray arrayWithCapacity:1];

  for (NSDictionary *bookmark in results) {
    NSArray *tags = [bookmark objectForKey:@"tag_names"];
    if (tags && [tags isKindOfClass:[NSArray class]] &&
        [tags containsObject:tag]) {
      QSObject *newObject = [self objectForLinkdingBookmark:bookmark];
      if (newObject) {
        [objects addObject:newObject];
      }
    }
  }

  return objects;
}

- (QSObject *)objectForLinkdingBookmark:(NSDictionary *)bookmark {
  NSNumber *bookmarkId = [bookmark objectForKey:@"id"];
  NSString *url = [bookmark objectForKey:@"url"];
  NSString *title = [bookmark objectForKey:@"title"];
  NSString *description = [bookmark objectForKey:@"description"];

  if (!bookmarkId || !url)
    return nil;

  QSObject *newObject = [QSObject
      makeObjectWithIdentifier:[NSString stringWithFormat:@"linkding-%@",
                                                          bookmarkId]];
  [newObject setObject:url forType:QSURLType];
  [newObject setName:title.length > 0 ? title : url];
  [newObject setDetails:description.length > 0 ? description : @""];
  [newObject setPrimaryType:QSURLType];

  return newObject;
}

@end