summaryrefslogtreecommitdiff
path: root/bookpipeline/main.go
blob: fe9012bdb161a675febcb069a1a5630c9ea33f34 (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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
package main

// TODO: have logs go somewhere useful, like email
// TODO: check if images are prebinarised and if so skip multiple binarisation

import (
	"errors"
	"flag"
	"fmt"
	"log"
	"os"
	"os/exec"
	"path/filepath"
	"strings"
	"time"

	"rescribe.xyz/go.git/preproc"
)

const usage = `Usage: bookpipeline [-v] [-t training]

Watches the preprocess, ocr and analyse queues for book names. When
one is found this general process is followed:

- The book name is hidden from the queue, and a 'heartbeat' is
  started which keeps it hidden (this will time out after 2 minutes
  if the program is terminated)
- The necessary files from bookname/ are downloaded
- The files are processed
- The resulting files are uploaded to bookname/
- The heartbeat is stopped
- The book name is removed from the queue it was taken from, and
  added to the next queue for future processing

`

// null writer to enable non-verbose logging to be discarded
type NullWriter bool

func (w NullWriter) Write(p []byte) (n int, err error) {
	return len(p), nil
}

const PauseBetweenChecks = 3 * time.Minute

type Clouder interface {
	Init() error
	ListObjects(bucket string, prefix string) ([]string, error)
	Download(bucket string, key string, fn string) error
	Upload(bucket string, key string, path string) error
	CheckQueue(url string) (Qmsg, error)
	AddToQueue(url string, msg string) error
	DelFromQueue(url string, handle string) error
	QueueHeartbeat(t *time.Ticker, msgHandle string, qurl string) error
}

type Pipeliner interface {
	Clouder
	ListToPreprocess(bookname string) ([]string, error)
	ListToOCR(bookname string) ([]string, error)
	DownloadFromInProgress(key string, fn string) error
	UploadToInProgress(key string, path string) error
	CheckPreQueue() (Qmsg, error)
	CheckOCRQueue() (Qmsg, error)
	CheckAnalyseQueue() (Qmsg, error)
	AddToOCRQueue(msg string) error
	AddToAnalyseQueue(msg string) error
	DelFromPreQueue(handle string) error
	DelFromOCRQueue(handle string) error
	PreQueueHeartbeat(t *time.Ticker, msgHandle string) error
	OCRQueueHeartbeat(t *time.Ticker, msgHandle string) error
	Logger() *log.Logger
}

type Qmsg struct {
	Handle, Body string
}

func download(dl chan string, process chan string, conn Pipeliner, dir string, errc chan error) {
	for key := range dl {
		fn := filepath.Join(dir, filepath.Base(key))
		err := conn.DownloadFromInProgress(key, fn)
		if err != nil {
			close(process)
			errc <- err
			return
		}
		process <- fn
	}
	close(process)
}

func up(c chan string, done chan bool, conn Pipeliner, bookname string, errc chan error) {
	for path := range c {
		name := filepath.Base(path)
		key := filepath.Join(bookname, name)
		err := conn.UploadToInProgress(key, path)
		if err != nil {
			errc <- err
			return
		}
	}

	done <- true
}

func preprocess(pre chan string, up chan string, logger *log.Logger, errc chan error) {
	for path := range pre {
		logger.Println("Preprocessing", path)
		done, err := preproc.PreProcMulti(path, []float64{0.1, 0.2, 0.4, 0.5}, "binary", 0, true, 5, 30)
		if err != nil {
			close(up)
			errc <- err
			return
		}
		for _, p := range done {
			up <- p
		}
	}
	close(up)
}

// TODO: use Tesseract API rather than calling the executable
func ocr(toocr chan string, up chan string, logger *log.Logger, training string, errc chan error) {
	for path := range toocr {
		logger.Println("OCRing", path)
		name := strings.Replace(path, ".png", "", 1) // TODO: handle any file extension
		cmd := exec.Command("tesseract", "-l", training, path, name, "hocr")
		err := cmd.Run()
		if err != nil {
			close(up)
			errc <- errors.New(fmt.Sprintf("Error ocring %s: %s", path, err))
			return
		}
		up <- name + ".hocr"
	}
	close(up)
}

func preprocBook(msg Qmsg, conn Pipeliner) error {
	bookname := msg.Body

	t := time.NewTicker(HeartbeatTime * time.Second)
	go conn.PreQueueHeartbeat(t, msg.Handle)

	d := filepath.Join(os.TempDir(), bookname)
	err := os.MkdirAll(d, 0755)
	if err != nil {
		t.Stop()
		return errors.New(fmt.Sprintf("Failed to create directory %s: %s", d, err))
	}

	dl := make(chan string)
	pre := make(chan string)
	upc := make(chan string)
	done := make(chan bool)
	errc := make(chan error)

	// these functions will do their jobs when their channels have data
	go download(dl, pre, conn, d, errc)
	go preprocess(pre, upc, conn.Logger(), errc)
	go up(upc, done, conn, bookname, errc)

	conn.Logger().Println("Getting list of objects to download")
	todl, err := conn.ListToPreprocess(bookname)
	if err != nil {
		t.Stop()
		_ = os.RemoveAll(d)
		return errors.New(fmt.Sprintf("Failed to get list of files for book %s: %s", bookname, err))
	}
	for _, d := range todl {
		dl <- d
	}
	close(dl)

	// wait for either the done or errc channel to be sent to
	select {
	case err = <-errc:
		t.Stop()
		_ = os.RemoveAll(d)
		return err
	case <-done:
	}

	conn.Logger().Println("Sending", bookname, "to OCR queue")
	err = conn.AddToOCRQueue(bookname)
	if err != nil {
		t.Stop()
		_ = os.RemoveAll(d)
		return errors.New(fmt.Sprintf("Error adding to ocr queue %s: %s", bookname, err))
	}

	t.Stop()

	conn.Logger().Println("Deleting original message from preprocessing queue")
	err = conn.DelFromPreQueue(msg.Handle)
	if err != nil {
		_ = os.RemoveAll(d)
		return errors.New(fmt.Sprintf("Error deleting message from preprocessing queue: %s", err))
	}

	err = os.RemoveAll(d)
	if err != nil {
		return errors.New(fmt.Sprintf("Failed to remove directory %s: %s", d, err))
	}

	return nil
}

// TODO: this is very similar to preprocBook; try to at least mostly merge them
func ocrBook(msg Qmsg, conn Pipeliner, training string) error {
	bookname := msg.Body

	t := time.NewTicker(HeartbeatTime * time.Second)
	go conn.OCRQueueHeartbeat(t, msg.Handle)

	d := filepath.Join(os.TempDir(), bookname)
	err := os.MkdirAll(d, 0755)
	if err != nil {
		t.Stop()
		return errors.New(fmt.Sprintf("Failed to create directory %s: %s", d, err))
	}

	dl := make(chan string)
	ocrc := make(chan string)
	upc := make(chan string)
	done := make(chan bool)
	errc := make(chan error)

	// these functions will do their jobs when their channels have data
	go download(dl, ocrc, conn, d, errc)
	go ocr(ocrc, upc, conn.Logger(), training, errc)
	go up(upc, done, conn, bookname, errc)

	conn.Logger().Println("Getting list of objects to download")
	todl, err := conn.ListToOCR(bookname)
	if err != nil {
		t.Stop()
		_ = os.RemoveAll(d)
		return errors.New(fmt.Sprintf("Failed to get list of files for book %s: %s", bookname, err))
	}
	for _, a := range todl {
		dl <- a
	}
	close(dl)

	// wait for either the done or errc channel to be sent to
	select {
	case err = <-errc:
		t.Stop()
		_ = os.RemoveAll(d)
		return err
	case <-done:
	}

	conn.Logger().Println("Sending", bookname, "to analyse queue")
	err = conn.AddToAnalyseQueue(bookname)
	if err != nil {
		t.Stop()
		_ = os.RemoveAll(d)
		return errors.New(fmt.Sprintf("Error adding to analyse queue %s: %s", bookname, err))
	}

	t.Stop()

	conn.Logger().Println("Deleting original message from OCR queue")
	err = conn.DelFromOCRQueue(msg.Handle)
	if err != nil {
		_ = os.RemoveAll(d)
		return errors.New(fmt.Sprintf("Error deleting message from OCR queue: %s", err))
	}

	err = os.RemoveAll(d)
	if err != nil {
		return errors.New(fmt.Sprintf("Failed to remove directory %s: %s", d, err))
	}

	return nil
}

func main() {
	verbose := flag.Bool("v", false, "verbose")
	training := flag.String("t", "rescribealphav5", "tesseract training file to use")
	flag.Usage = func() {
		fmt.Fprintf(flag.CommandLine.Output(), usage)
		flag.PrintDefaults()
	}
	flag.Parse()

	var verboselog *log.Logger
	if *verbose {
		verboselog = log.New(os.Stdout, "", log.LstdFlags)
	} else {
		var n NullWriter
		verboselog = log.New(n, "", log.LstdFlags)
	}

	var conn Pipeliner
	conn = &awsConn{region: "eu-west-2", logger: verboselog}

	verboselog.Println("Setting up AWS session")
	err := conn.Init()
	if err != nil {
		log.Fatalln("Error setting up cloud connection:", err)
	}
	verboselog.Println("Finished setting up AWS session")

	var checkPreQueue <-chan time.Time
	var checkOCRQueue <-chan time.Time
	checkPreQueue = time.After(0)
	checkOCRQueue = time.After(0)

	for {
		select {
		case <-checkPreQueue:
			msg, err := conn.CheckPreQueue()
			checkPreQueue = time.After(PauseBetweenChecks)
			if err != nil {
				log.Println("Error checking preprocess queue", err)
				continue
			}
			if msg.Handle == "" {
				verboselog.Println("No message received on preprocess queue, sleeping")
				continue
			}
			err = preprocBook(msg, conn)
			if err != nil {
				log.Println("Error during preprocess", err)
			}
		case <-checkOCRQueue:
			msg, err := conn.CheckOCRQueue()
			checkOCRQueue = time.After(PauseBetweenChecks)
			if err != nil {
				log.Println("Error checking OCR queue", err)
				continue
			}
			if msg.Handle == "" {
				verboselog.Println("No message received on OCR queue, sleeping")
				continue
			}
			err = ocrBook(msg, conn, *training)
			if err != nil {
				log.Println("Error during OCR process", err)
			}
		}
	}
}