Merge pull request #330 from tropy/feature/print

Feature: Print Items
tropy · Jul 25, 2019 · 90de31f · 90de31f
2 parents 816373e + 19c24ea
commit 90de31f
Show file tree

Hide file tree

Showing 39 changed files with 991 additions and 43 deletions.
diff --git a/res/menu/app.en.yml b/res/menu/app.en.yml
@@ -51,6 +51,12 @@ en:
           command: 'app:consolidate-photo-library'
           condition: 'project'
         - type: 'separator'
+        - &print
+          label: 'Print'
+          command: 'app:print'
+          accelerator: 'CmdOrCtrl+P'
+          condition: 'project'
+        - type: 'separator'
         - &close
           label: 'Close Project'
           command: 'app:close-project'
@@ -131,6 +137,11 @@ en:
           label: 'Enter &Full Screen'
           role: 'togglefullscreen'
           condition: 'window'
+        - type: 'separator'
+        - label: 'Close'
+          accelerator: 'Ctrl+W'
+          role: 'close'
+          condition: 'window'
     - &dev
       label: 'Developer'
       id: 'dev'
@@ -241,6 +252,8 @@ en:
         - *import
         - *consolidate
         - type: 'separator'
+        - *print
+        - type: 'separator'
         - *close
     - label: 'Edit'
       submenu:
@@ -270,6 +283,8 @@ en:
         - label: 'Zoom'
           accelerator: 'Ctrl+Cmd+Z'
           role: 'zoom'
+        - label: 'Move to Center'
+          command: 'app:center-window'
           condition: 'window'
         - type: 'separator'
         - *center-window

diff --git a/res/strings/renderer.en.yml b/res/strings/renderer.en.yml
@@ -94,6 +94,15 @@ en:
           light: Light
           dark: Dark
           system: Follow system preference
+      print:
+        mode: Print
+        modes:
+          item: One item per page
+          photo: One photo per page
+          selection: One selection per page
+        metadata: Include metadata
+        notes: Include notes
+        overflow: Allow content to take up more than one page
       locale:
         locale: Locale
         locales:

diff --git a/res/views/print.html b/res/views/print.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-Security-Policy" content="default-src 'none'; script-src 'sha256-++gna1tMQ08GGn4M8jnPXPgLA3Il1y2LY+JVA4NpYKk='; style-src 'self'; img-src 'self' data:; form-action 'none'">
+</head>
+<body id="print" tabindex="-1">
+  <main id="main"></main>
+</body>
+</html>
diff --git a/src/actions/item.js b/src/actions/item.js
@@ -167,6 +167,14 @@ module.exports = {
     }
   },
 
+  print(payload, meta) {
+    return {
+      type: ITEM.PRINT,
+      payload,
+      meta: { cmd: 'project', ...meta }
+    }
+  },
+
   bulk: {
     update(payload, meta) {
       return {

diff --git a/src/bootstrap.js b/src/bootstrap.js
@@ -6,17 +6,19 @@ try {
   require('module').globalPaths.push(__dirname)
 
   const opts = require('./args').parse()
-  const { Window } = require('./window')
-  const { ready } = require('./dom')
-  const { ipcRenderer: ipc } = require('electron')
-
-  const win = new Window(opts)
+  const { basename } = require('path')
   const { fatal, info } = require('./common/log')({
     dest: opts.log,
     level: opts.level,
-    name: win.type
+    name: basename(location.pathname, '.html')
   })
 
+  const { ipcRenderer: ipc } = require('electron')
+  const { ready } = require('./dom')
+  const { Window } = require('./window')
+
+  const win = new Window(opts)
+
   info({
     dpx: window.devicePixelRatio,
     opts

diff --git a/src/browser/tropy.js b/src/browser/tropy.js
@@ -13,6 +13,7 @@ const {
 } = require('electron')
 
 const { fatal, info, warn, logger, crashReport } = require('../common/log')
+const { delay, once } = require('../common/util')
 const { existsSync: exists } = require('fs')
 const { into, compose, remove, take } = require('transducers.js')
 
@@ -644,6 +645,10 @@ class Tropy extends EventEmitter {
       this.showOpenDialog(null)
     })
 
+    this.on('app:print', () => {
+      this.dispatch(act.item.print(), this.wm.current())
+    })
+
     this.on('app:zoom-in', () => {
       this.state.zoom = this.wm.zoom(this.state.zoom + 0.25)
     })
@@ -688,6 +693,33 @@ class Tropy extends EventEmitter {
       this.emit(cmd, BrowserWindow.fromWebContents(event.sender), ...args)
     })
 
+    ipc.on('print', async (_, opts) => {
+      try {
+        if (!opts.items.length) return
+
+        var win = await this.wm.open('print', this.hash)
+
+        await Promise.race([
+          once(win, 'react:ready'),
+          delay(2000)
+        ])
+
+        info(`will print ${opts.items.length} item(s)`)
+        win.send('print', opts)
+
+        await Promise.race([
+          once(win, 'print:ready'),
+          delay(60000)
+        ])
+
+        let result = await WindowManager.print(win)
+        info(`printing ${result ? 'confirmed' : 'aborted'}`)
+
+      } finally {
+        if (win != null) win.destroy()
+      }
+    })
+
     ipc.on('error', (event, error) => {
       this.handleUncaughtException(
         error,

diff --git a/src/browser/wm.js b/src/browser/wm.js
@@ -429,6 +429,10 @@ class WindowManager extends EventEmitter {
       minimizable: false,
       resizable: false
     },
+    print: {
+      width: 600,
+      height: 300
+    },
     project: {
       width: 1280,
       height: 720,
@@ -466,6 +470,12 @@ class WindowManager extends EventEmitter {
         .getUserDefault('AppleActionOnDoubleClick', 'string')
         .toLowerCase()
   }
+
+  static print(win, opts = {}) {
+    return new Promise((resolve) => {
+      win.webContents.print(opts, resolve)
+    })
+  }
 }
 
 

diff --git a/src/commands/item.js b/src/commands/item.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const { debug, warn } = require('../common/log')
-const { clipboard } = require('electron')
+const { clipboard, ipcRenderer: ipc } = require('electron')
 const assert = require('assert')
 const { DuplicateError } = require('../common/error')
 const { all, call, put, select, cps } = require('redux-saga/effects')
@@ -23,6 +23,7 @@ const {
   getGroupedItems,
   getItemTemplate,
   getPhotoTemplate,
+  getPrintableItems,
   getTemplateValues
 } = require('../selectors')
 
@@ -470,6 +471,21 @@ class Preview extends Command {
   }
 }
 
+class Print extends Command {
+  static get ACTION() { return ITEM.PRINT }
+
+  *exec() {
+    let [prefs, items] = yield select(state => ([
+      state.settings.print,
+      getPrintableItems(state)
+    ]))
+
+    if (items.length) {
+      ipc.send('print', { ...prefs, items })
+    }
+  }
+}
+
 class AddTag extends Command {
   static get ACTION() { return ITEM.TAG.CREATE }
 
@@ -535,6 +551,7 @@ module.exports = {
   Restore,
   TemplateChange,
   Preview,
+  Print,
   AddTag,
   RemoveTag,
   ToggleTags,

diff --git a/src/common/iiif.js b/src/common/iiif.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const { URL } = require('url')
-const { rotate } = require('./math')
+const { rotate, isHorizontal } = require('./math')
 
 
 class Rotation {
@@ -44,6 +44,10 @@ class Rotation {
     return `${this.mirror ? symbol : ''}${this.angle}`
   }
 
+  get isHorizontal() {
+    return isHorizontal(this.angle)
+  }
+
   get orientation() {
     switch (this.angle) {
       case 0:

diff --git a/src/components/editor/serialize.js b/src/components/editor/serialize.js
@@ -0,0 +1,24 @@
+'use strict'
+
+const { DOMSerializer } = require('prosemirror-model')
+const { schema } = require('./schema')
+const { warn } = require('../../common/log')
+
+const DOM = DOMSerializer.fromSchema(schema)
+
+module.exports = {
+  toHTML(doc) {
+    try {
+      let node = schema.nodeFromJSON(doc)
+      let frag = DOM.serializeFragment(node)
+
+      return Array
+        .from(frag.children, el => el.outerHTML)
+        .join('')
+
+    } catch (e) {
+      warn({ stack: e.stack }, 'failed to convert doc to HTML')
+      return ''
+    }
+  }
+}
diff --git a/src/components/main.js b/src/components/main.js
@@ -21,15 +21,19 @@ const IntlProvider = connect(state => {
 
 // eslint-disable-next-line react/prefer-stateless-function
 class Main extends React.Component {
+  componentDidMount() {
+    this.props.window.send('react:ready')
+  }
+
   render() {
     return (
       <WindowContext.Provider value={this.props.window}>
         <Provider store={this.props.store}>
           <IntlProvider>
-            <div className="main-container">
+            <React.Fragment>
               {this.props.children}
               <Flash/>
-            </div>
+            </React.Fragment>
           </IntlProvider>
         </Provider>
       </WindowContext.Provider>

diff --git a/src/components/photo/info.js b/src/components/photo/info.js
@@ -19,7 +19,9 @@ class PhotoInfo extends PureComponent {
   }
 
   handleFileClick = () => {
-    this.props.onOpenInFolder(this.props.photo.path)
+    if (this.props.onOpenInFolder) {
+      this.props.onOpenInFolder(this.props.photo.path)
+    }
   }
 
   render() {
@@ -45,7 +47,7 @@ class PhotoInfo extends PureComponent {
 
   static propTypes = {
     photo: object.isRequired,
-    onOpenInFolder: func.isRequired
+    onOpenInFolder: func
   }
 }
 

diff --git a/src/components/prefs/app.js b/src/components/prefs/app.js
@@ -66,6 +66,10 @@ class AppPrefs extends React.PureComponent {
     }
   }
 
+  handlePrintSettingsChange = (print) => {
+    this.props.onSettingsUpdate({ print })
+  }
+
   render() {
     return (
       <div className="scroll-container">
@@ -187,6 +191,37 @@ class AppPrefs extends React.PureComponent {
             options={this.props.layouts}
             onChange={this.props.onSettingsUpdate}/>
           <hr/>
+          <FormSelect
+            id="prefs.app.print.mode"
+            name="mode"
+            isDisabled
+            isRequired
+            isSelectionHidden
+            value={this.props.settings.print.mode}
+            options={this.props.printModes}
+            onChange={this.handlePrintSettingsChange}/>
+          <FormElement isCompact>
+            <Toggle
+              id="prefs.app.print.metadata"
+              name="metadata"
+              value={this.props.settings.print.metadata}
+              onChange={this.handlePrintSettingsChange}/>
+            <Toggle
+              id="prefs.app.print.notes"
+              name="notes"
+              value={this.props.settings.print.notes}
+              onChange={this.handlePrintSettingsChange}/>
+            <Toggle
+              id="prefs.app.print.overflow"
+              isDisabled={!(
+                this.props.settings.print.metadata ||
+                this.props.settings.print.notes
+              )}
+              name="overflow"
+              value={this.props.settings.print.overflow}
+              onChange={this.handlePrintSettingsChange}/>
+          </FormElement>
+          <hr/>
           <FormToggle
             id="prefs.app.debug"
             name="debug"
@@ -217,6 +252,7 @@ class AppPrefs extends React.PureComponent {
     themes: arrayOf(string).isRequired,
     dupOptions: arrayOf(string).isRequired,
     zoomModes: arrayOf(string).isRequired,
+    printModes: arrayOf(string).isRequired,
     onSettingsUpdate: func.isRequired
   }
 
@@ -225,7 +261,8 @@ class AppPrefs extends React.PureComponent {
     layouts: [ITEM.LAYOUT.STACKED, ITEM.LAYOUT.SIDE_BY_SIDE],
     locales: ['de', 'en', 'fr', 'ja'],
     dupOptions: ['skip', 'import', 'prompt'],
-    zoomModes: [ESPER.MODE.FIT, ESPER.MODE.FILL]
+    zoomModes: [ESPER.MODE.FIT, ESPER.MODE.FILL],
+    printModes: ['item', 'photo', 'selection']
   }
 }