superbook-pdf 0.1.0

High-quality PDF converter for scanned books with AI enhancement, deskew correction, and Japanese OCR
Documentation
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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
//! Job management for the web server
//!
//! Handles job creation, status tracking, and queue management.

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::path::PathBuf;
use std::sync::{Arc, RwLock};
use uuid::Uuid;

/// Job status enumeration
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum JobStatus {
    /// Waiting in queue
    Queued,
    /// Currently processing
    Processing,
    /// Successfully completed
    Completed,
    /// Failed with error
    Failed,
    /// Cancelled by user
    Cancelled,
}

impl std::fmt::Display for JobStatus {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            JobStatus::Queued => write!(f, "queued"),
            JobStatus::Processing => write!(f, "processing"),
            JobStatus::Completed => write!(f, "completed"),
            JobStatus::Failed => write!(f, "failed"),
            JobStatus::Cancelled => write!(f, "cancelled"),
        }
    }
}

/// Progress information for a processing job
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Progress {
    /// Current step number (1-based)
    pub current_step: u32,
    /// Total number of steps
    pub total_steps: u32,
    /// Human-readable step name
    pub step_name: String,
    /// Percentage complete (0-100)
    pub percent: u8,
}

impl Progress {
    /// Create a new progress instance
    pub fn new(current_step: u32, total_steps: u32, step_name: impl Into<String>) -> Self {
        let percent = if total_steps > 0 {
            ((current_step as f64 / total_steps as f64) * 100.0) as u8
        } else {
            0
        };
        Self {
            current_step,
            total_steps,
            step_name: step_name.into(),
            percent,
        }
    }
}

/// Conversion options from the client
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ConvertOptions {
    /// Output DPI
    #[serde(default = "default_dpi")]
    pub dpi: u32,
    /// Enable deskew correction
    #[serde(default = "default_true")]
    pub deskew: bool,
    /// Enable AI upscaling
    #[serde(default = "default_true")]
    pub upscale: bool,
    /// Enable OCR
    #[serde(default)]
    pub ocr: bool,
    /// Enable all advanced features
    #[serde(default)]
    pub advanced: bool,
}

fn default_dpi() -> u32 {
    300
}

fn default_true() -> bool {
    true
}

impl Default for ConvertOptions {
    fn default() -> Self {
        Self {
            dpi: 300,
            deskew: true,
            upscale: true,
            ocr: false,
            advanced: false,
        }
    }
}

/// A conversion job
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Job {
    /// Unique job identifier
    pub id: Uuid,
    /// Current job status
    pub status: JobStatus,
    /// Conversion options
    pub options: ConvertOptions,
    /// Progress information (when processing)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub progress: Option<Progress>,
    /// Original input filename
    pub input_filename: String,
    /// Path to output file (when completed)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub output_path: Option<PathBuf>,
    /// Job creation timestamp
    pub created_at: DateTime<Utc>,
    /// Processing start timestamp
    #[serde(skip_serializing_if = "Option::is_none")]
    pub started_at: Option<DateTime<Utc>>,
    /// Completion timestamp
    #[serde(skip_serializing_if = "Option::is_none")]
    pub completed_at: Option<DateTime<Utc>>,
    /// Error message (when failed)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
}

impl Job {
    /// Create a new job
    pub fn new(input_filename: impl Into<String>, options: ConvertOptions) -> Self {
        Self {
            id: Uuid::new_v4(),
            status: JobStatus::Queued,
            options,
            progress: None,
            input_filename: input_filename.into(),
            output_path: None,
            created_at: Utc::now(),
            started_at: None,
            completed_at: None,
            error: None,
        }
    }

    /// Mark job as processing
    pub fn start(&mut self) {
        self.status = JobStatus::Processing;
        self.started_at = Some(Utc::now());
    }

    /// Update progress
    pub fn update_progress(&mut self, progress: Progress) {
        self.progress = Some(progress);
    }

    /// Mark job as completed
    pub fn complete(&mut self, output_path: PathBuf) {
        self.status = JobStatus::Completed;
        self.output_path = Some(output_path);
        self.completed_at = Some(Utc::now());
        self.progress = Some(Progress::new(12, 12, "Complete"));
    }

    /// Mark job as failed
    pub fn fail(&mut self, error: impl Into<String>) {
        self.status = JobStatus::Failed;
        self.error = Some(error.into());
        self.completed_at = Some(Utc::now());
    }

    /// Mark job as cancelled
    pub fn cancel(&mut self) {
        self.status = JobStatus::Cancelled;
        self.completed_at = Some(Utc::now());
    }

    /// Check if job is in terminal state
    pub fn is_terminal(&self) -> bool {
        matches!(
            self.status,
            JobStatus::Completed | JobStatus::Failed | JobStatus::Cancelled
        )
    }
}

/// Thread-safe job queue
#[derive(Debug, Clone)]
pub struct JobQueue {
    jobs: Arc<RwLock<HashMap<Uuid, Job>>>,
}

impl Default for JobQueue {
    fn default() -> Self {
        Self::new()
    }
}

impl JobQueue {
    /// Create a new job queue
    pub fn new() -> Self {
        Self {
            jobs: Arc::new(RwLock::new(HashMap::new())),
        }
    }

    /// Submit a new job
    pub fn submit(&self, job: Job) -> Uuid {
        let id = job.id;
        let mut jobs = self.jobs.write().expect("lock poisoned");
        jobs.insert(id, job);
        id
    }

    /// Get a job by ID
    pub fn get(&self, id: Uuid) -> Option<Job> {
        let jobs = self.jobs.read().expect("lock poisoned");
        jobs.get(&id).cloned()
    }

    /// Update a job
    pub fn update<F>(&self, id: Uuid, f: F) -> Option<Job>
    where
        F: FnOnce(&mut Job),
    {
        let mut jobs = self.jobs.write().expect("lock poisoned");
        if let Some(job) = jobs.get_mut(&id) {
            f(job);
            Some(job.clone())
        } else {
            None
        }
    }

    /// Cancel a job
    pub fn cancel(&self, id: Uuid) -> Option<Job> {
        self.update(id, |job| job.cancel())
    }

    /// List all jobs
    pub fn list(&self) -> Vec<Job> {
        let jobs = self.jobs.read().expect("lock poisoned");
        jobs.values().cloned().collect()
    }

    /// Get pending jobs (queued or processing)
    pub fn pending(&self) -> Vec<Job> {
        let jobs = self.jobs.read().expect("lock poisoned");
        jobs.values()
            .filter(|j| matches!(j.status, JobStatus::Queued | JobStatus::Processing))
            .cloned()
            .collect()
    }

    /// Get count of pending jobs (queued or processing)
    pub fn pending_count(&self) -> usize {
        let jobs = self.jobs.read().expect("lock poisoned");
        jobs.values()
            .filter(|j| matches!(j.status, JobStatus::Queued | JobStatus::Processing))
            .count()
    }

    /// Remove completed/failed jobs older than the given duration
    pub fn cleanup(&self, max_age: std::time::Duration) {
        let mut jobs = self.jobs.write().expect("lock poisoned");
        let now = Utc::now();
        jobs.retain(|_, job| {
            if job.is_terminal() {
                if let Some(completed_at) = job.completed_at {
                    let age = now.signed_duration_since(completed_at);
                    return age < chrono::Duration::from_std(max_age).unwrap_or(chrono::TimeDelta::MAX);
                }
            }
            true
        });
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_job_status_display() {
        assert_eq!(format!("{}", JobStatus::Queued), "queued");
        assert_eq!(format!("{}", JobStatus::Processing), "processing");
        assert_eq!(format!("{}", JobStatus::Completed), "completed");
        assert_eq!(format!("{}", JobStatus::Failed), "failed");
        assert_eq!(format!("{}", JobStatus::Cancelled), "cancelled");
    }

    #[test]
    fn test_progress_new() {
        let progress = Progress::new(3, 12, "Deskew");
        assert_eq!(progress.current_step, 3);
        assert_eq!(progress.total_steps, 12);
        assert_eq!(progress.step_name, "Deskew");
        assert_eq!(progress.percent, 25);
    }

    #[test]
    fn test_progress_zero_total() {
        let progress = Progress::new(0, 0, "Empty");
        assert_eq!(progress.percent, 0);
    }

    #[test]
    fn test_convert_options_default() {
        let opts = ConvertOptions::default();
        assert_eq!(opts.dpi, 300);
        assert!(opts.deskew);
        assert!(opts.upscale);
        assert!(!opts.ocr);
        assert!(!opts.advanced);
    }

    #[test]
    fn test_job_new() {
        let job = Job::new("test.pdf", ConvertOptions::default());
        assert_eq!(job.status, JobStatus::Queued);
        assert_eq!(job.input_filename, "test.pdf");
        assert!(job.progress.is_none());
        assert!(job.output_path.is_none());
        assert!(job.started_at.is_none());
        assert!(job.completed_at.is_none());
        assert!(job.error.is_none());
    }

    #[test]
    fn test_job_lifecycle() {
        let mut job = Job::new("test.pdf", ConvertOptions::default());

        // Start
        job.start();
        assert_eq!(job.status, JobStatus::Processing);
        assert!(job.started_at.is_some());

        // Update progress
        job.update_progress(Progress::new(5, 12, "Processing"));
        assert!(job.progress.is_some());
        assert_eq!(job.progress.as_ref().unwrap().current_step, 5);

        // Complete
        job.complete(PathBuf::from("/tmp/output.pdf"));
        assert_eq!(job.status, JobStatus::Completed);
        assert!(job.output_path.is_some());
        assert!(job.completed_at.is_some());
        assert!(job.is_terminal());
    }

    #[test]
    fn test_job_fail() {
        let mut job = Job::new("test.pdf", ConvertOptions::default());
        job.start();
        job.fail("Something went wrong");

        assert_eq!(job.status, JobStatus::Failed);
        assert_eq!(job.error.as_deref(), Some("Something went wrong"));
        assert!(job.is_terminal());
    }

    #[test]
    fn test_job_cancel() {
        let mut job = Job::new("test.pdf", ConvertOptions::default());
        job.cancel();

        assert_eq!(job.status, JobStatus::Cancelled);
        assert!(job.is_terminal());
    }

    #[test]
    fn test_job_queue_submit_and_get() {
        let queue = JobQueue::new();
        let job = Job::new("test.pdf", ConvertOptions::default());
        let id = job.id;

        queue.submit(job);

        let retrieved = queue.get(id);
        assert!(retrieved.is_some());
        assert_eq!(retrieved.unwrap().id, id);
    }

    #[test]
    fn test_job_queue_get_nonexistent() {
        let queue = JobQueue::new();
        let id = Uuid::new_v4();

        assert!(queue.get(id).is_none());
    }

    #[test]
    fn test_job_queue_update() {
        let queue = JobQueue::new();
        let job = Job::new("test.pdf", ConvertOptions::default());
        let id = job.id;

        queue.submit(job);

        let updated = queue.update(id, |j| j.start());
        assert!(updated.is_some());
        assert_eq!(updated.unwrap().status, JobStatus::Processing);
    }

    #[test]
    fn test_job_queue_cancel() {
        let queue = JobQueue::new();
        let job = Job::new("test.pdf", ConvertOptions::default());
        let id = job.id;

        queue.submit(job);

        let cancelled = queue.cancel(id);
        assert!(cancelled.is_some());
        assert_eq!(cancelled.unwrap().status, JobStatus::Cancelled);
    }

    #[test]
    fn test_job_queue_list() {
        let queue = JobQueue::new();

        queue.submit(Job::new("test1.pdf", ConvertOptions::default()));
        queue.submit(Job::new("test2.pdf", ConvertOptions::default()));

        let jobs = queue.list();
        assert_eq!(jobs.len(), 2);
    }

    #[test]
    fn test_job_queue_pending() {
        let queue = JobQueue::new();

        let mut job1 = Job::new("test1.pdf", ConvertOptions::default());
        let job2 = Job::new("test2.pdf", ConvertOptions::default());
        let mut job3 = Job::new("test3.pdf", ConvertOptions::default());

        job1.complete(PathBuf::from("/tmp/out1.pdf"));
        job3.start();

        queue.submit(job1);
        queue.submit(job2);
        queue.submit(job3);

        let pending = queue.pending();
        assert_eq!(pending.len(), 2); // job2 (queued) + job3 (processing)
    }

    #[test]
    fn test_job_queue_pending_count() {
        let queue = JobQueue::new();

        let mut job1 = Job::new("test1.pdf", ConvertOptions::default());
        let job2 = Job::new("test2.pdf", ConvertOptions::default());
        let mut job3 = Job::new("test3.pdf", ConvertOptions::default());

        job1.complete(PathBuf::from("/tmp/out1.pdf"));
        job3.start();

        queue.submit(job1);
        queue.submit(job2);
        queue.submit(job3);

        // pending_count should be 2 (job2 queued + job3 processing)
        assert_eq!(queue.pending_count(), 2);
    }

    #[test]
    fn test_convert_options_serde() {
        let json = r#"{"dpi": 600, "ocr": true}"#;
        let opts: ConvertOptions = serde_json::from_str(json).unwrap();

        assert_eq!(opts.dpi, 600);
        assert!(opts.deskew); // default
        assert!(opts.upscale); // default
        assert!(opts.ocr);
        assert!(!opts.advanced); // default
    }
}