Download A Dat
… and keep data up-to-date
by entering the link here.
Share a Folder
… and sync changes by sharing
the link with someone else.
---
# Dat Desktop
**Peer to peer data versioning & syncronization.**
[](https://travis-ci.org/dat-land/dat-desktop)
[](https://standardjs.com)
## Table of Content
- [Download](https://github.com/datproject/dat-desktop/releases)
- [FAQ](#faq)
- [License](#licenses)
## Contributing
To run _Dat Desktop_ in development mode:
```sh
node --version # v12.4.0
npm install # install dependencies
npm start # start the application
```
To create binary packages run:
```sh
npm install # install dependencies
npm run dist :os # compile the app into an binary package
```
## FAQ
### How to speed up downloading Electron
If you’re not in Europe or the US, you might want to use a different mirror for
`electron`. You can set the `ELECTRON_MIRROR` variable to point to a different
provider:
```sh
# Europe / US
$ npm install
# Asia / Oceania
$ ELECTRON_MIRROR="https://npm.taobao.org/mirrors/electron/" npm install
```
## Licenses
[MIT License](./LICENSE)
### Font Attribution & License
SourceSansPro-Regular.ttf: Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries. [SIL Open Font License, 1.1](http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL)
SourceCodePro-Regular.ttf: Copyright 2010, 2012 Adobe Systems Incorporated. All Rights Reserved. [SIL Open Font License, 1.1](http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL)
================================================
FILE: app/actions/dat-middleware.js
================================================
'use strict'
import Dat from 'dat-node'
import { encode } from 'dat-encoding'
import fs from 'fs'
import { basename, join as joinPath } from 'path'
import { ipcRenderer, shell } from 'electron'
import mkdirp from 'mkdirp-promise'
import mirror from 'mirror-folder'
import promisify from 'util-promisify'
const readFile = promisify(fs.readFile)
const writeFile = promisify(fs.writeFile)
const { Notification } = window
async function readJSON (file) {
try {
const blob = await readFile(file, 'utf8')
if (!blob) {
return {}
}
return JSON.parse(blob)
} catch (_) {}
return {}
}
export default class DatMiddleware {
constructor ({ downloadsDir, dataDir }) {
this.downloadsDir = downloadsDir
this.dataDir = dataDir
this.dats = {}
this.listeners = []
this.execByType = {
UPDATE_TITLE: action => this.updateTitle(action),
REMOVE_DAT: action => this.removeDat(action),
TRY_ADD_DAT: action => this.tryAddDat(action),
REQUEST_DOWNLOAD: action => this.validateDownloadRequest(action),
TOGGLE_PAUSE: action => this.togglePause(action),
DOWNLOAD_SPARSE_DAT: action => this.downloadSparseDat(action),
CANCEL_DOWNLOAD_DAT: action => this.cancelDownloadDat(action)
}
}
async validateDownloadRequest ({ key }) {
if (key) {
key = encode(key)
if (this.dats[key]) {
return this.dispatch({
type: 'ADD_DAT_ERROR',
key,
error: new Error('Dat with same key already exists.')
})
}
}
this.dispatch({ type: 'SHOW_DOWNLOAD_SCREEN', key })
}
execAction (action) {
const exec = this.execByType[action.type]
if (!exec) return false
// Telling it to all the middlewares.
this.dispatch(action)
exec(action)
.then(data =>
this.dispatch({ ...action, type: `${action.type}_SUCCESS`, ...data })
)
.catch(error =>
this.dispatch({ ...action, type: `${action.type}_ERROR`, error })
)
return true
}
middleware (store) {
return dispatch => {
this.listeners.push(dispatch)
return action => {
const triggersEffect = this.execAction(action)
if (!triggersEffect) {
// This action was not ment for this middleware.
// Pass on to the next.
dispatch(action)
}
}
}
}
dispatch (action) {
this.listeners.forEach(listener => listener(action))
}
async updateTitle ({ key, title }) {
const dat = this.dats[key]
const filePath = joinPath(dat.path, 'dat.json')
const metadata = { ...dat.dat.metadata, title: title }
try {
await writeFile(filePath, JSON.stringify(metadata))
} catch (error) {
return this.dispatch({ type: 'WRITE_METADATA_ERROR', key, error })
}
}
async removeDat ({ key }) {
this.removeDatInternally(key)
this.storeOnDisk()
}
async tryAddDat (action) {
let { key, path } = action
if (key) {
key = encode(key)
if (this.dats[key]) {
this.dispatch({ type: 'ADD_DAT_ERROR:EXISTED' })
throw this.dispatch({
type: 'ADD_DAT_ERROR',
key,
error: new Error('Dat with same key already added.')
})
}
}
if (!path) path = joinPath(this.downloadsDir, key)
for (let key in this.dats) {
const dat = this.dats[key]
if (dat.path === path) {
this.dispatch({ type: 'ADD_DAT_ERROR:EXISTED' })
throw this.dispatch({
type: 'ADD_DAT_ERROR',
key,
error: new Error('Dat with same path already added.')
})
}
}
await this.internalAddDat(action)
}
async internalAddDat ({ key, path, paused, ...opts }) {
if (key) {
this.dispatch({ type: 'ADD_DAT', key, path, paused })
}
opts = {
watch: true,
resume: true,
ignoreHidden: true,
compareFileContent: true,
...opts
}
Dat(path, { key }, (error, dat) => {
if (error) return this.dispatch({ type: 'ADD_DAT_ERROR', key, error })
if (!key) {
key = encode(dat.key)
this.dispatch({ type: 'ADD_DAT', key, path, paused })
}
dat.trackStats()
if (dat.writable) dat.importFiles(opts)
this.dispatch({
type: 'DAT_METADATA',
key,
metadata: {
title: basename(path),
author: 'Anonymous'
}
})
this.dispatch({ type: 'ADD_DAT_SUCCESS', key })
this.dispatch({ type: 'DAT_WRITABLE', key, writable: dat.writable })
dat.archive.readFile('dat.json', (err, blob) => {
if (err) return
let metadata = {}
try {
metadata = JSON.parse(blob)
} catch (_) {}
this.dispatch({ type: 'DAT_METADATA', key, metadata })
})
dat.stats.on('update', stats => {
if (!stats) stats = dat.stats.get()
this.updateProgress(dat, key, stats)
this.dispatch({ type: 'DAT_STATS', key, stats: { ...stats } })
})
this.updateState(dat)
this.updateProgress(dat, key)
if (!paused) {
this.joinNetwork(dat)
this.updateConnections(dat)
}
let prevNetworkStats
dat.updateInterval = setInterval(() => {
const stats = JSON.stringify(dat.stats.network)
if (stats === prevNetworkStats) return
prevNetworkStats = stats
this.dispatch({
type: 'DAT_NETWORK_STATS',
key,
stats: {
up: dat.stats.network.uploadSpeed,
down: dat.stats.network.downloadSpeed
}
})
}, 1000)
this.appendDatInternally(key, dat, path, opts)
this.storeOnDisk()
})
}
updateProgress (dat, key, stats) {
if (!stats) stats = dat.stats.get()
const prevProgress = dat.progress
const progress = !dat.stats
? 0
: dat.writable ? 1 : Math.min(1, stats.downloaded / stats.length)
dat.progress = progress
this.dispatch({ type: 'DAT_PROGRESS', key, progress })
this.updateState(dat)
const unfinishedBefore = prevProgress < 1 && prevProgress > 0
if (dat.progress === 1 && unfinishedBefore) {
const notification = new Notification('Download finished', {
body: key
})
notification.onclick = () =>
shell.openExternal(`file://${dat.path}`, () => {})
}
const incomplete = []
for (const d of Object.values(this.dats)) {
if (d.network && d.progress < 1) incomplete.push(d)
}
let totalProgress = incomplete.length
? incomplete.reduce((acc, dat) => {
return acc + dat.progress
}, 0) / incomplete.length
: 1
if (totalProgress === 1) totalProgress = -1 // deactivate
if (ipcRenderer) ipcRenderer.send('progress', totalProgress)
}
async togglePause ({ key, paused }) {
const { dat } = this.dats[key]
if (paused) {
this.joinNetwork(dat)
} else {
dat.leaveNetwork()
}
this.storeOnDisk()
}
async downloadSparseDat ({ key }) {
key = encode(key)
if (this.dats[key]) {
this.dispatch({ type: 'ADD_DAT_ERROR:EXISTED' })
return
}
const path = joinPath(this.downloadsDir, key)
this.dispatch({ type: 'ADD_DAT', key, path })
Dat(path, { key, sparse: true }, (error, dat) => {
if (error) return this.dispatch({ type: 'ADD_DAT_ERROR', key, error })
dat.trackStats()
this.dispatch({
type: 'DAT_METADATA',
key,
metadata: {
title: basename(path),
author: 'Anonymous'
}
})
this.dispatch({ type: 'ADD_DAT_SUCCESS', key })
dat.archive.readFile('/dat.json', (err, blob) => {
if (err) return
let metadata = {}
try {
metadata = JSON.parse(blob)
} catch (_) {}
this.dispatch({ type: 'DAT_METADATA', key, metadata })
})
dat.stats.on('update', stats => {
if (!stats) stats = dat.stats.get()
this.dispatch({ type: 'DAT_STATS', key, stats: { ...stats } })
})
this.updateState(dat)
this.joinNetwork(dat)
this.updateConnections(dat)
this.appendDatInternally(key, dat, path)
})
}
async cancelDownloadDat ({ key }) {
this.removeDatInternally(key)
}
appendDatInternally (key, dat, path, opts = {}) {
this.dats[key] = { dat, path, opts }
dat.stats.once('update', () => {
this.walk(dat)
})
}
removeDatInternally (key) {
this.dispatch({ type: 'REMOVE_DAT', key })
const { dat } = this.dats[key] || {}
if (!dat) return // maybe was deleted
delete this.dats[key]
if (dat.mirrorProgress) {
dat.mirrorProgress.destroy()
}
for (const con of dat.network.connections) {
con.removeAllListeners()
}
dat.stats.removeAllListeners()
clearInterval(dat.updateInterval)
dat.close()
}
walk (dat) {
const key = encode(dat.key)
if (!this.dats[key]) return // maybe it was deleted?
if (!dat.files) dat.files = []
var fs = { name: '/', fs: dat.archive }
var progress = mirror(fs, '/', { dryRun: true })
progress.on('put', file => {
file.name = file.name.slice(1)
if (file.name === '') return
dat.files.push({
path: file.name,
size: file.stat.size,
isFile: file.stat.isFile()
})
dat.files.sort(function (a, b) {
return a.path.localeCompare(b.path)
})
const { files } = dat
this.dispatch({ type: 'DAT_FILES', key, files })
})
dat.mirrorProgress = progress
}
updateState (dat) {
const key = encode(dat.key)
const state = !dat.network
? 'paused'
: dat.writable || dat.progress === 1
? 'complete'
: dat.network.connected ? 'loading' : 'stale'
this.dispatch({ type: 'DAT_STATE', key, state })
}
updateConnections (dat) {
if (!dat.network) return
const key = encode(dat.key)
this.dispatch({ type: 'DAT_PEERS', key, peers: dat.network.connected })
}
joinNetwork (dat) {
dat.joinNetwork()
dat.network.on('connection', con => {
this.updateConnections(dat)
this.updateState(dat)
con.on('close', () => {
this.updateConnections(dat)
this.updateState(dat)
})
})
}
async loadFromDisk () {
try {
await mkdirp(this.downloadsDir)
await mkdirp(this.dataDir)
} catch (_) {}
const [datOpts, paused] = await Promise.all([
readJSON(joinPath(this.dataDir, 'dats.json')),
readJSON(joinPath(this.dataDir, 'paused.json'))
])
for (const key of Object.keys(datOpts)) {
const opts = JSON.parse(datOpts[key])
this.internalAddDat({
key,
path: opts.dir,
paused: paused[key],
...opts
})
}
}
async storeOnDisk () {
try {
await mkdirp(this.dataDir)
} catch (_) {}
const datsState = Object.keys(this.dats).reduce(
(acc, key) => ({
...acc,
[key]: JSON.stringify({
dir: this.dats[key].path,
opts: this.dats[key].opts
})
}),
{}
)
const pausedState = Object.keys(this.dats).reduce(
(acc, key) => ({
...acc,
[key]: !this.dats[key].dat.network
}),
{}
)
await writeFile(
joinPath(this.dataDir, 'dats.json'),
JSON.stringify(datsState)
)
await writeFile(
joinPath(this.dataDir, 'paused.json'),
JSON.stringify(pausedState)
)
}
}
================================================
FILE: app/actions/index.js
================================================
'use strict'
import { encode } from 'dat-encoding'
import { clipboard, remote, shell } from 'electron'
import fs from 'fs'
import promisify from 'util-promisify'
import path from 'path'
const stat = promisify(fs.stat)
function showOpenDialog (props) {
if (process.env.RUNNING_IN_SPECTRON && process.env.OPEN_RESULT) {
return new Promise((resolve, reject) => {
resolve({
cancelled: false,
filePaths: [path.resolve(__dirname, process.env.OPEN_RESULT)]
})
})
}
return remote.dialog.showOpenDialog(props)
}
export const shareDat = key => ({ type: 'DIALOGS_LINK_OPEN', key })
export const copyLink = link => {
clipboard.writeText(link)
return { type: 'DIALOGS_LINK_COPY' }
}
export const closeShareDat = () => ({ type: 'DIALOGS_LINK_CLOSE' })
export const closeAlert = () => ({ type: 'DIALOGS_ALERT_CLOSE' })
export const createDat = () => dispatch => {
showOpenDialog({
properties: ['openDirectory']
})
.then(({ filePaths, cancelled }) => {
if (cancelled) return
if (!filePaths) {
console.error('Did not get files from the open dialog, closing')
return
}
const path = filePaths[0]
addDat({ path })(dispatch)
})
.catch(err => {
console.error(err)
})
}
export const requestDownload = key => ({
type: 'REQUEST_DOWNLOAD',
key: encode(key)
})
export const hideDownloadScreen = () => ({ type: 'HIDE_DOWNLOAD_SCREEN' })
export const cancelDownloadDat = key => dispatch =>
dispatch({ type: 'CANCEL_DOWNLOAD_DAT', key })
export const changeDownloadPath = key => dispatch => {
const files = showOpenDialog({
properties: ['openDirectory']
})
if (!files || !files.length) return
const path = files[0]
dispatch({ type: 'CHANGE_DOWNLOAD_PATH', key, path })
}
export const downloadSparseDat = ({ key }) => dispatch =>
dispatch({ type: 'DOWNLOAD_SPARSE_DAT', key })
export const addDat = ({ key, path, paused, ...opts }) => dispatch =>
dispatch({ type: 'TRY_ADD_DAT', key, path, paused, ...opts })
export const deleteDat = key => ({ type: 'DIALOGS_DELETE_OPEN', key })
export const confirmDeleteDat = key => dispatch => {
dispatch({ type: 'REMOVE_DAT', key })
dispatch({ type: 'DIALOGS_DELETE_CLOSE' })
}
export const cancelDeleteDat = () => ({ type: 'DIALOGS_DELETE_CLOSE' })
export const togglePause = ({ key, paused }) => dispatch =>
dispatch({ type: 'TOGGLE_PAUSE', paused, key })
export const inspectDat = key => dispatch => {
dispatch({ type: 'INSPECT_DAT', key })
}
export const closeInspectDat = () => ({ type: 'INSPECT_DAT_CLOSE' })
export const dropFolder = folder => async dispatch => {
const isDirectory = (await stat(folder.path)).isDirectory()
if (!isDirectory) return
addDat({ path: folder.path })(dispatch)
}
export const openHomepage = () => shell.openExternal('https://datproject.org/')
export const nextIntro = screen => ({ type: 'NEXT_INTRO', screen })
export const hideIntro = () => ({ type: 'HIDE_INTRO' })
export const updateTitle = (key, title) => async dispatch =>
dispatch({
type: 'UPDATE_TITLE',
key,
title
})
export const toggleMenu = visible => dispatch => {
dispatch({ type: 'TOGGLE_MENU', visible })
}
================================================
FILE: app/components/app.js
================================================
'use strict'
import React, { Fragment } from 'react'
import { connect } from 'react-redux'
import SCREEN from '../consts/screen'
import IntroContainer from '../containers/intro'
import HeaderContainer from '../containers/header'
import TableContainer from '../containers/table'
import * as Dialog from '../containers/dialog'
import StatusBarContainer from '../containers/status-bar'
import InspectContainer from '../containers/inspect'
import DragDropContainer from '../containers/drag-drop'
const mapStateToProps = state => ({
screen: state.screen
})
const mapDispatchToProps = dispatch => ({})
export default connect(mapStateToProps, mapDispatchToProps)(function ({
screen
}) {
if (screen === SCREEN.INTRO) {
return
Anyone with this link can view your Dat.
Are you sure you want to remove this dat?
This can’t be undone.
{alert}
… and keep data up-to-date
by entering the link here.
… and sync changes by sharing
the link with someone else.
Dat Desktop is a peer to peer data versioning and syncronization app.
{dat.path}
Hey there! This is a Dat.
, 2: (Think of it as a folder – with some magic.
), 3: (You can turn any folder on your computer into a Dat.
), 4: (Dats can be easily shared. Just copy the unique dat link and securely share it.
), 5: (You can also import existing Dats. Check out{' '} openHomepage()} > datproject.org {' '} to explore open datasets.
) }[screen] }
{dat.metadata.author || 'Anonymous'} •{' '} {dat.writable ? 'Read & Write' : 'Read-only'}
This page includes an extra development build of React. 🚧
The React build on this page includes both development and production versions because dead code elimination has not been applied correctly.
This makes its size larger, and causes React to run slower.
Make sure to set up dead code elimination before deployment.
Open the developer tools, and the React tab will appear to the right.
================================================ FILE: dev/react-dev-tools/popups/development.html ================================================This page is using the development build of React. 🚧
Note that the development build is not suitable for production.
Make sure to use the production build before deployment.
Open the developer tools, and the React tab will appear to the right.
================================================ FILE: dev/react-dev-tools/popups/disabled.html ================================================
This page doesn’t appear to be using React.
If this seems wrong, follow the troubleshooting instructions.
This page is using an outdated version of React. ⌛
We recommend updating React to ensure that you receive important bugfixes and performance improvements.
You can find the upgrade instructions on the React blog.
Open the developer tools, and the React tab will appear to the right.
================================================ FILE: dev/react-dev-tools/popups/production.html ================================================
This page is using the production build of React. ✅
Open the developer tools, and the React tab will appear to the right.
This page is using an unminified build of React. 🚧
The React build on this page appears to be unminified.
This makes its size larger, and causes React to run slower.
Make sure to set up minification before deployment.
Open the developer tools, and the React tab will appear to the right.
================================================ FILE: dist/.gitignore ================================================ * !.gitignore ================================================ FILE: index.html ================================================ element when screen given', t => {
const fn = () => {}
const show = true
const wrapper = shallow(