git ssb

1
var fs = require('fs')
2
var http = require('http')
3
var qs = require('querystring')
4
var path = require('path')
5
var crypto = require('crypto')
6
var pull = require('pull-stream')
7
var paramap = require('pull-paramap')
8
var sort = require('ssb-sort')
9
var toPull = require('stream-to-pull-stream')
10
var memo = require('asyncmemo')
11
var lru = require('lrucache')
12
var webresolve = require('ssb-web-resolver')
13
var serveEmoji = require('emoji-server')()
14
var {
15
  MdRenderer,
16
  renderEmoji,
17
  formatMsgs,
18
  wrapPage,
19
  renderThread,
20
  renderAbout,
21
  renderShowAll,
22
  renderRssItem,
23
  wrapRss,
24
} = require('./render');
25
26
var appHash = hash([fs.readFileSync(__filename)])
27
28
var urlIdRegex = /^(?:\/(([%&@]|%25|%26|%40)(?:[A-Za-z0-9\/+]|%2[Ff]|%2[Bb]){43}(?:=|%3[Dd])\.(?:sha256|ed25519))(?:\.([^?]*))?|(\/.*?))(?:\?(.*))?$/
29
30
function hash(arr) {
31
  return arr.reduce(function (hash, item) {
32
    return hash.update(String(item))
33
  }, crypto.createHash('sha256')).digest('base64')
34
}
35
36
exports.name = 'viewer'
37
exports.manifest = {}
38
exports.version = require('./package').version
39
40
exports.init = function (sbot, config) {
41
  var conf = config.viewer || {}
42
  var port = conf.port || 8807
43
  var host = conf.host || config.host || '::'
44
45
  var base = conf.base || '/'
46
  var defaultOpts = {
47
    base: base,
48
    msg_base: conf.msg_base || base,
49
    feed_base: conf.feed_base || base,
50
    blob_base: conf.blob_base || base,
51
    img_base: conf.img_base || base,
52
    emoji_base: conf.emoji_base || (base + 'emoji/'),
53
    requireOptIn: conf.require_opt_in == null ? true : conf.require_opt_in,
54
  }
55
56
  defaultOpts.marked = {
57
    gfm: true,
58
    mentions: true,
59
    tables: true,
60
    breaks: true,
61
    pedantic: false,
62
    sanitize: true,
63
    smartLists: true,
64
    smartypants: false,
65
    emoji: renderEmoji,
66
    renderer: new MdRenderer(defaultOpts)
67
  }
68
69
  var getMsg = memo({cache: lru(100)}, getMsgWithValue, sbot)
70
  var getAbout = memo({cache: lru(100)}, require('./lib/about'), sbot)
71
  var serveAcmeChallenge = require('ssb-acme-validator')(sbot)
72
73
  http.createServer(serve).listen(port, host, function () {
74
    console.log('[viewer] Listening on http://' + host + ':' + port)
75
  })
76
77
  function serve(req, res) {
78
    if (req.method !== 'GET' && req.method !== 'HEAD') {
79
      return respond(res, 405, 'Method must be GET or HEAD')
80
    }
81
82
    var m = urlIdRegex.exec(req.url)
83
84
    if (req.url.startsWith('/user-feed/')) return serveUserFeed(req, res, m[4])
85
    else if (req.url.startsWith('/channel/')) return serveChannel(req, res, m[4])
86
    else if (req.url.startsWith('/.well-known/acme-challenge')) return serveAcmeChallenge(req, res)
87
    else if (req.url.startsWith('/web/')) return serveWeb(req, res, m[4])
88
89
    if (m[2] && m[2].length === 3) {
90
      m[1] = decodeURIComponent(m[1])
91
      m[2] = m[1][0]
92
    }
93
    switch (m[2]) {
94
      case '%': return serveId(req, res, m[1], m[3], m[5])
95
      case '@': return serveFeed(req, res, m[1], m[3], m[5])
96
      case '&': return serveBlob(req, res, sbot, m[1])
97
      default: return servePath(req, res, m[4], conf)
98
    }
99
  }
100
101
  function serveFeed(req, res, feedId, ext) {
102
    console.log("serving feed: " + feedId)
103
104
    var showAll = req.url.endsWith("?showAll");
105
106
    getAbout(feedId, function (err, about) {
107
      if (err) return respond(res, 500, err.stack || err)
108
109
      function render() {
110
        switch (ext) {
111
          case 'rss':
112
            return pull(
113
              // formatMsgs(feedId, ext, defaultOpts)
114
              renderRssItem(defaultOpts), wrapRss(about.name, defaultOpts)
115
            );
116
          default:
117
            var publicWebHosting = about.publicWebHosting == null
118
              ? !defaultOpts.requireOptIn : about.publicWebHosting
119
            var name = publicWebHosting ? about.name : feedId.substr(0, 10) + '…'
120
            return pull(
121
              renderAbout(defaultOpts, about,
122
                          renderShowAll(showAll, req.url)), wrapPage(name)
123
            );
124
        }
125
      }
126
127
      pull(
128
        sbot.createUserStream({ id: feedId, reverse: true, limit: showAll ? -1 : (ext == 'rss' ? 25 : 10) }),
129
        pull.filter(function (data) {
130
          return 'object' === typeof data.value.content
131
        }),
132
        pull.collect(function (err, logs) {
133
          if (err) return respond(res, 500, err.stack || err)
134
          res.writeHead(200, {
135
            'Content-Type': ctype(ext)
136
          })
137
          pull(
138
            pull.values(logs),
139
            paramap(addAuthorAbout, 8),
140
            paramap(addBlog, 8),
141
            paramap(addFollowAbout, 8),
142
            paramap(addVoteMessage, 8),
143
            paramap(addGitLinks, 8),
144
            paramap(addGatheringAbout, 8),
145
            render(),
146
            toPull(res, function (err) {
147
              if (err) console.error('[viewer]', err)
148
            })
149
          )
150
        })
151
      )
152
    })
153
  }
154
155
  function serveWeb (req, res, url) {
156
    var self = this
157
    var id = decodeURIComponent(url.substr(1))
158
159
    var components = url.split('/')
160
    if (components[0] === '') components.shift()
161
    if (components[0] === 'web') components.shift()
162
    components[0] = decodeURIComponent(components[0])
163
164
    webresolve(sbot, components, function (err, data) {
165
      if (err) {
166
        return respond(res, 404, 'ERROR: ' + err)
167
      }
168
      return pull(
169
        pull.once(data),
170
        toPull(res, function (err) {
171
          if (err) console.error('[viewer]', err)
172
        })
173
      )
174
    })
175
  }
176
177
  function serveUserFeed(req, res, url) {
178
    var feedId = url.substring(url.lastIndexOf('user-feed/')+10, 100)
179
    console.log("serving user feed: " + feedId)
180
181
    var following = []
182
    var channelSubscriptions = []
183
    
184
    getAbout(feedId, function (err, about) {
185
      pull(
186
	sbot.createUserStream({ id: feedId }),
187
	pull.filter((msg) => {
188
	  return !msg.value ||
189
	    msg.value.content.type == 'contact' ||
190
	    (msg.value.content.type == 'channel' &&
191
	     typeof msg.value.content.subscribed != 'undefined')
192
	}),
193
	pull.collect(function (err, msgs) {
194
	  msgs.forEach((msg) => {
195
	    if (msg.value.content.type == 'contact')
196
	    {
197
	      if (msg.value.content.following)
198
		following[msg.value.content.contact] = 1
199
	      else
200
		delete following[msg.value.content.contact]
201
	    }
202
	    else // channel subscription
203
	    {
204
	      if (msg.value.content.subscribed)
205
		channelSubscriptions[msg.value.content.channel] = 1
206
	      else
207
		delete channelSubscriptions[msg.value.content.channel]
208
	    }
209
	  })
210
	  
211
	  serveFeeds(req, res, following, channelSubscriptions, feedId,
212
                     'user feed ' + (about ? about.name : ""))
213
	})
214
      )
215
    })
216
  }
217
218
  function serveFeeds(req, res, following, channelSubscriptions, feedId, name) {
219
    var feedOpts = Object.assign({}, defaultOpts, {
220
      renderPrivate: false,
221
      renderSubscribe: false,
222
      renderVote: false,
223
      renderTalenet: false,
224
      renderChess: false,
225
      renderFollow: false,
226
      renderPub: false,
227
      renderAbout: false
228
    })
229
230
    pull(
231
      sbot.createLogStream({ reverse: true, limit: 5000 }),
232
      pull.filter((msg) => {
233
	return !msg.value ||
234
	  (msg.value.author in following ||
235
	   msg.value.content.channel in channelSubscriptions)
236
      }),
237
      pull.take(150),
238
      pull.collect(function (err, logs) {
239
	if (err) return respond(res, 500, err.stack || err)
240
	res.writeHead(200, {
241
	  'Content-Type': ctype("html")
242
	})
243
	pull(
244
	  pull.values(logs),
245
	  paramap(addAuthorAbout, 8),
246
          paramap(addBlog, 8),
247
	  paramap(addFollowAbout, 8),
248
	  paramap(addVoteMessage, 8),
249
	  paramap(addGitLinks, 8),
250
    paramap(addGatheringAbout, 8),
251
	  pull(renderThread(feedOpts), wrapPage(name)),
252
	  toPull(res, function (err) {
253
	    if (err) console.error('[viewer]', err)
254
	  })
255
	)
256
      })
257
    )
258
  }
259
260
  function serveChannel(req, res, url) {
261
    var channelId = url.substring(url.lastIndexOf('channel/')+8, 100)
262
    console.log("serving channel: " + channelId)
263
264
    var showAll = req.url.endsWith("?showAll")
265
    
266
    pull(
267
      sbot.query.read({ limit: showAll ? 300 : 10, reverse: true, query: [{$filter: { value: { content: { channel: channelId }}}}]}),
268
      pull.collect(function (err, logs) {
269
	if (err) return respond(res, 500, err.stack || err)
270
	res.writeHead(200, {
271
	  'Content-Type': ctype("html")
272
	})
273
	pull(
274
	  pull.values(logs),
275
	  paramap(addAuthorAbout, 8),
276
          paramap(addBlog, 8),
277
    paramap(addVoteMessage, 8),
278
    paramap(addGatheringAbout, 8),
279
	  pull(renderThread(defaultOpts, '', renderShowAll(showAll, req.url)),
280
	       wrapPage('#' + channelId)),
281
	  toPull(res, function (err) {
282
	    if (err) console.error('[viewer]', err)
283
	  })
284
	)
285
      })
286
    )
287
  }
288
289
  function serveId(req, res, id, ext, query) {
290
    var q = query ? qs.parse(query) : {}
291
    var includeRoot = !('noroot' in q)
292
    var base = q.base || conf.base
293
    var baseToken
294
    if (!base) {
295
      if (ext === 'js') base = baseToken = '__BASE_' + Math.random() + '_'
296
      else base = '/'
297
    }
298
    var opts = {
299
      base: base,
300
      base_token: baseToken,
301
      msg_base: q.msg_base || conf.msg_base || base,
302
      feed_base: q.feed_base || conf.feed_base || base,
303
      blob_base: q.blob_base || conf.blob_base || base,
304
      img_base: q.img_base || conf.img_base || base,
305
      emoji_base: q.emoji_base || conf.emoji_base || (base + 'emoji/'),
306
      requireOptIn: defaultOpts.requireOptIn,
307
    }
308
    opts.marked = {
309
      gfm: true,
310
      mentions: true,
311
      tables: true,
312
      breaks: true,
313
      pedantic: false,
314
      sanitize: true,
315
      smartLists: true,
316
      smartypants: false,
317
      emoji: renderEmoji,
318
      renderer: new MdRenderer(opts)
319
    }
320
321
    var format = formatMsgs(id, ext, opts)
322
    if (format === null) return respond(res, 415, 'Invalid format')
323
324
    function render (links) {
325
      var etag = hash(sort.heads(links).concat(appHash, ext, qs))
326
      if (req.headers['if-none-match'] === etag) return respond(res, 304)
327
      res.writeHead(200, {
328
        'Content-Type': ctype(ext),
329
        'etag': etag
330
      })
331
      pull(
332
        pull.values(sort(links)),
333
        paramap(addAuthorAbout, 8),
334
        paramap(addBlog, 8),
335
        paramap(addGatheringAbout, 8),
336
        format,
337
        toPull(res, function (err) {
338
          if (err) console.error('[viewer]', err)
339
        })
340
      )
341
    }
342
343
    getMsgWithValue(sbot, id, function (err, root) {
344
      if (err) return respond(res, 500, err.stack || err)
345
      if('string' === typeof root.value.content)
346
        return render([root])
347
348
      pull(
349
        sbot.links({dest: id, values: true, rel: 'root' }),
350
        pull.unique('key'),
351
        pull.collect(function (err, links) {
352
          if (err) return respond(res, 500, err.stack || err)
353
          if(includeRoot)
354
            links.unshift(root)
355
          render(links)
356
        })
357
      )
358
    })
359
  }
360
361
  function addFollowAbout(msg, cb) {
362
    if (msg.value.content.contact)
363
      getAbout(msg.value.content.contact, function (err, about) {
364
	if (err) return cb(err)
365
	msg.value.content.contactAbout = about
366
	cb(null, msg)
367
      })
368
    else
369
      cb(null, msg)
370
  }
371
372
  function addVoteMessage(msg, cb) {
373
    if (msg.value.content.type == 'vote' && msg.value.content.vote && msg.value.content.vote.link[0] == '%')
374
      getMsg(msg.value.content.vote.link, function (err, linkedMsg) {
375
	if (linkedMsg)
376
	  msg.value.content.vote.linkedText = linkedMsg.value.content.text
377
	cb(null, msg)
378
      })
379
    else
380
      cb(null, msg)
381
  }
382
383
  function addBlog(msg, cb) {
384
    if (msg.value && msg.value.content.type == "blog") {
385
      pull(
386
        sbot.blobs.get(msg.value.content.blog),
387
        pull.collect(function(err, blob) {
388
          msg.value.content.blogContent = blob
389
          cb(null, msg)
390
        })
391
      )
392
    } else
393
      cb(null, msg)
394
  }
395
396
  function addAuthorAbout(msg, cb) {
397
    getAbout(msg.value.author, function (err, about) {
398
      if (err) return cb(err)
399
      msg.author = about
400
      cb(null, msg)
401
    })
402
  }
403
404
  function addGatheringAbout(msg, cb) {
405
    if (msg.value && msg.value.content.type === 'gathering') {
406
      getAbout(msg.key, (err, about) => {
407
        if (err) { cb(err) }
408
409
        msg.value.content.about = about
410
411
        pull(
412
          sbot.backlinks.read({
413
            query: [{ $filter: {
414
              dest: msg.key,
415
              value: { content: { type: 'about' }},
416
            }}],
417
            index: 'DTA'
418
          }),
419
          // Only grab messages about attendance
420
          pull.filter(o => o.value.content.attendee !== undefined),
421
          // Filter "can't attend"-messages
422
          pull.filter(o => !o.value.content.attendee.remove),
423
          pull.unique(o => o.value.content.attendee.link),
424
          pull.collect((err, arr) => {
425
            if (err) { cb(err) }
426
427
            msg.value.content.numberAttending = arr.length
428
429
            cb(null, msg)
430
          })
431
        )
432
      })
433
    } else {
434
      cb(null, msg)
435
    }
436
  }
437
438
  function addGitLinks(msg, cb) {
439
    if (msg.value.content.type == 'git-update')
440
      getMsg(msg.value.content.repo, function (err, gitRepo) {
441
	if (gitRepo)
442
	  msg.value.content.repoName = gitRepo.value.content.name
443
	cb(null, msg)
444
      })
445
    else if (msg.value.content.type == 'issue')
446
      getMsg(msg.value.content.project, function (err, gitRepo) {
447
	if (gitRepo)
448
	  msg.value.content.repoName = gitRepo.value.content.name
449
	cb(null, msg)
450
      })
451
    else
452
      cb(null, msg)
453
  }
454
}
455
456
function serveBlob(req, res, sbot, id) {
457
  if (req.headers['if-none-match'] === id) return respond(res, 304)
458
  sbot.blobs.has(id, function (err, has) {
459
    if (err) {
460
      if (/^invalid/.test(err.message)) return respond(res, 400, err.message)
461
      else return respond(res, 500, err.message || err)
462
    }
463
    if (!has) return respond(res, 404, 'Not found')
464
    res.writeHead(200, {
465
      'Cache-Control': 'public, max-age=315360000',
466
      'etag': id
467
    })
468
    pull(
469
      sbot.blobs.get(id),
470
      toPull(res, function (err) {
471
        if (err) console.error('[viewer]', err)
472
      })
473
    )
474
  })
475
}
476
477
function getMsgWithValue(sbot, id, cb) {
478
  sbot.get(id, function (err, value) {
479
    if (err) return cb(err)
480
    cb(null, {key: id, value: value})
481
  })
482
}
483
484
function respond(res, status, message) {
485
  res.writeHead(status)
486
  res.end(message)
487
}
488
489
function ctype(name) {
490
  switch (name && /[^.\/]*$/.exec(name)[0] || 'html') {
491
    case 'html': return 'text/html'
492
    case 'js': return 'text/javascript'
493
    case 'css': return 'text/css'
494
    case 'json': return 'application/json'
495
    case 'rss': return 'text/xml'
496
  }
497
}
498
499
function servePath(req, res, url, conf) {
500
  switch (url) {
501
    case '/robots.txt': return serveRobots(req, res, conf)
502
  }
503
  var m = /^(\/?[^\/]*)(\/.*)?$/.exec(url)
504
  switch (m[1]) {
505
    case '/static': return serveStatic(req, res, m[2])
506
    case '/emoji': return serveEmoji(req, res, m[2])
507
  }
508
  return respond(res, 404, 'Not found')
509
}
510
511
function ifModified(req, lastMod) {
512
  var ifModSince = req.headers['if-modified-since']
513
  if (!ifModSince) return false
514
  var d = new Date(ifModSince)
515
  return d && Math.floor(d/1000) >= Math.floor(lastMod/1000)
516
}
517
518
function serveStatic(req, res, file) {
519
  serveFile(req, res, path.join(__dirname, 'static', file))
520
}
521
522
function serveFile(req, res, file) {
523
  fs.stat(file, function (err, stat) {
524
    if (err && err.code === 'ENOENT') return respond(res, 404, 'Not found')
525
    if (err) return respond(res, 500, err.stack || err)
526
    if (!stat.isFile()) return respond(res, 403, 'May only load files')
527
    if (ifModified(req, stat.mtime)) return respond(res, 304, 'Not modified')
528
    res.writeHead(200, {
529
      'Content-Type': ctype(file),
530
      'Content-Length': stat.size,
531
      'Last-Modified': stat.mtime.toGMTString()
532
    })
533
    fs.createReadStream(file).pipe(res)
534
  })
535
}
536
537
function serveRobots(req, res, conf) {
538
  res.end('User-agent: *'
539
    + (conf.disallowRobots ? '\nDisallow: /' : ''))
540
}
541
542
function prepend(fn, arg) {
543
  return function (read) {
544
    return function (abort, cb) {
545
      if (fn && !abort) {
546
        var _fn = fn
547
        fn = null
548
        return _fn(arg, function (err, value) {
549
          if (err) return read(err, function (err) {
550
            cb(err || true)
551
          })
552
          cb(null, value)
553
        })
554
      }
555
      read(abort, cb)
556
    }
557
  }
558
}
559