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
//! A crate providing access to the Postgres large object API.
//!
//! # Example
//!
//! ```rust,no_run
//! extern crate postgres;
//! extern crate postgres_large_object;
//!
//! use std::fs::File;
//! use std::io;
//!
//! use postgres::{Connection, TlsMode};
//! use postgres_large_object::{LargeObjectExt, LargeObjectTransactionExt, Mode};
//!
//! fn main() {
//!     let conn = Connection::connect("postgres://postgres@localhost", TlsMode::None).unwrap();
//!
//!     let mut file = File::open("vacation_photos.tar.gz").unwrap();
//!     let trans = conn.transaction().unwrap();
//!     let oid = trans.create_large_object().unwrap();
//!     {
//!         let mut large_object = trans.open_large_object(oid, Mode::Write).unwrap();
//!         io::copy(&mut file, &mut large_object).unwrap();
//!     }
//!     trans.commit().unwrap();
//!
//!     let mut file = File::create("vacation_photos_copy.tar.gz").unwrap();
//!     let trans = conn.transaction().unwrap();
//!     let mut large_object = trans.open_large_object(oid, Mode::Read).unwrap();
//!     io::copy(&mut large_object, &mut file).unwrap();
//! }
//! ```
#![doc(html_root_url = "https://docs.rs/postgres_large_object/0.7")]

extern crate postgres;

use postgres::{GenericConnection, Result};
use postgres::transaction::Transaction;
use postgres::types::Oid;
use std::cmp;
use std::fmt;
use std::i32;
use std::io::{self, Write};

/// An extension trait adding functionality to create and delete large objects.
pub trait LargeObjectExt {
    /// Creates a new large object, returning its `Oid`.
    fn create_large_object(&self) -> Result<Oid>;

    /// Deletes the large object with the specified `Oid`.
    fn delete_large_object(&self, oid: Oid) -> Result<()>;
}

impl<T: GenericConnection> LargeObjectExt for T {
    fn create_large_object(&self) -> Result<Oid> {
        let stmt = self.prepare_cached("SELECT pg_catalog.lo_create(0)")?;
        let r = stmt.query(&[]).map(|r| r.iter().next().unwrap().get(0));
        r
    }

    fn delete_large_object(&self, oid: Oid) -> Result<()> {
        let stmt = self.prepare_cached("SELECT pg_catalog.lo_unlink($1)")?;
        stmt.execute(&[&oid]).map(|_| ())
    }
}

/// Large object access modes.
///
/// Note that Postgres currently does not make any distinction between the
/// `Write` and `ReadWrite` modes.
#[derive(Debug)]
pub enum Mode {
    /// An object opened in this mode may only be read from.
    Read,
    /// An object opened in this mode may be written to.
    Write,
    /// An object opened in this mode may be read from or written to.
    ReadWrite,
}

impl Mode {
    fn to_i32(&self) -> i32 {
        match *self {
            Mode::Read => 0x00040000,
            Mode::Write => 0x00020000,
            Mode::ReadWrite => 0x00040000 | 0x00020000,
        }
    }
}

/// An extension trait adding functionality to open large objects.
pub trait LargeObjectTransactionExt {
    /// Opens the large object with the specified `Oid` in the specified `Mode`.
    fn open_large_object<'a>(&'a self, oid: Oid, mode: Mode) -> Result<LargeObject<'a>>;
}

impl<'conn> LargeObjectTransactionExt for Transaction<'conn> {
    fn open_large_object<'a>(&'a self, oid: Oid, mode: Mode) -> Result<LargeObject<'a>> {
        let version = self.connection().parameter("server_version").unwrap();
        let (major, minor) = parse_version(&version);
        let has_64 = major > 9 || (major == 9 && minor >= 3);

        let stmt = self.prepare_cached("SELECT pg_catalog.lo_open($1, $2)")?;
        let fd = stmt.query(&[&oid, &mode.to_i32()])?
            .iter()
            .next()
            .unwrap()
            .get(0);
        Ok(LargeObject {
            trans: self,
            fd: fd,
            has_64: has_64,
            finished: false,
        })
    }
}

/// Represents an open large object.
pub struct LargeObject<'a> {
    trans: &'a Transaction<'a>,
    fd: i32,
    has_64: bool,
    finished: bool,
}

impl<'a> fmt::Debug for LargeObject<'a> {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        fmt.debug_struct("LargeObject")
            .field("fd", &self.fd)
            .field("transaction", &self.trans)
            .finish()
    }
}

impl<'a> Drop for LargeObject<'a> {
    fn drop(&mut self) {
        let _ = self.finish_inner();
    }
}

impl<'a> LargeObject<'a> {
    /// Returns the file descriptor of the opened object.
    pub fn fd(&self) -> i32 {
        self.fd
    }

    /// Truncates the object to the specified size.
    ///
    /// If `len` is larger than the size of the object, it will be padded with
    /// null bytes to the specified size.
    pub fn truncate(&mut self, len: i64) -> Result<()> {
        if self.has_64 {
            let stmt = self.trans
                .prepare_cached("SELECT pg_catalog.lo_truncate64($1, $2)")?;
            stmt.execute(&[&self.fd, &len]).map(|_| ())
        } else {
            let len = if len <= i32::max_value() as i64 {
                len as i32
            } else {
                return Err(io::Error::new(
                    io::ErrorKind::InvalidInput,
                    "The database does not support objects larger \
                     than 2GB",
                ).into());
            };
            let stmt = self.trans
                .prepare_cached("SELECT pg_catalog.lo_truncate($1, $2)")?;
            stmt.execute(&[&self.fd, &len]).map(|_| ())
        }
    }

    fn finish_inner(&mut self) -> Result<()> {
        if self.finished {
            return Ok(());
        }

        self.finished = true;
        let stmt = self.trans.prepare_cached("SELECT pg_catalog.lo_close($1)")?;
        stmt.execute(&[&self.fd]).map(|_| ())
    }

    /// Consumes the `LargeObject`, cleaning up server side state.
    ///
    /// Functionally identical to the `Drop` implementation on `LargeObject`
    /// except that it returns any errors to the caller.
    pub fn finish(mut self) -> Result<()> {
        self.finish_inner()
    }
}

impl<'a> io::Read for LargeObject<'a> {
    fn read(&mut self, mut buf: &mut [u8]) -> io::Result<usize> {
        let stmt = self.trans
            .prepare_cached("SELECT pg_catalog.loread($1, $2)")?;
        let cap = cmp::min(buf.len(), i32::MAX as usize) as i32;
        let rows = stmt.query(&[&self.fd, &cap])?;
        buf.write(rows.get(0).get_bytes(0).unwrap())
    }
}

impl<'a> io::Write for LargeObject<'a> {
    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
        let stmt = self.trans
            .prepare_cached("SELECT pg_catalog.lowrite($1, $2)")?;
        let cap = cmp::min(buf.len(), i32::MAX as usize);
        stmt.execute(&[&self.fd, &&buf[..cap]])?;
        Ok(cap)
    }

    fn flush(&mut self) -> io::Result<()> {
        Ok(())
    }
}

impl<'a> io::Seek for LargeObject<'a> {
    fn seek(&mut self, pos: io::SeekFrom) -> io::Result<u64> {
        let (kind, pos) = match pos {
            io::SeekFrom::Start(pos) => {
                let pos = if pos <= i64::max_value as u64 {
                    pos as i64
                } else {
                    return Err(io::Error::new(
                        io::ErrorKind::InvalidInput,
                        "cannot seek more than 2^63 bytes",
                    ));
                };
                (0, pos)
            }
            io::SeekFrom::Current(pos) => (1, pos),
            io::SeekFrom::End(pos) => (2, pos),
        };

        if self.has_64 {
            let stmt = self.trans
                .prepare_cached("SELECT pg_catalog.lo_lseek64($1, $2, $3)")?;
            let rows = stmt.query(&[&self.fd, &pos, &kind])?;
            let pos: i64 = rows.iter().next().unwrap().get(0);
            Ok(pos as u64)
        } else {
            let pos = if pos <= i32::max_value() as i64 {
                pos as i32
            } else {
                return Err(io::Error::new(
                    io::ErrorKind::InvalidInput,
                    "cannot seek more than 2^31 bytes",
                ));
            };
            let stmt = self.trans
                .prepare_cached("SELECT pg_catalog.lo_lseek($1, $2, $3)")?;
            let rows = stmt.query(&[&self.fd, &pos, &kind])?;
            let pos: i32 = rows.iter().next().unwrap().get(0);
            Ok(pos as u64)
        }
    }
}

fn parse_version(version: &str) -> (i32, i32) {
    let version = version.split(' ').next().unwrap();
    let mut version = version.split('.');
    let major: i32 = version.next().unwrap().parse().unwrap();
    let minor: i32 = version.next().unwrap().parse().unwrap();
    (major, minor)
}

#[cfg(test)]
mod test {
    use postgres::{Connection, TlsMode};
    use postgres::error::UNDEFINED_OBJECT;

    use {parse_version, LargeObjectExt, LargeObjectTransactionExt, Mode};

    #[test]
    fn test_create_delete() {
        let conn = Connection::connect("postgres://postgres@localhost", TlsMode::None).unwrap();
        let oid = conn.create_large_object().unwrap();
        conn.delete_large_object(oid).unwrap();
    }

    #[test]
    fn test_delete_bogus() {
        let conn = Connection::connect("postgres://postgres@localhost", TlsMode::None).unwrap();
        match conn.delete_large_object(0) {
            Ok(()) => panic!("unexpected success"),
            Err(ref e) if e.code() == Some(&UNDEFINED_OBJECT) => {}
            Err(e) => panic!("unexpected error: {:?}", e),
        }
    }

    #[test]
    fn test_open_bogus() {
        let conn = Connection::connect("postgres://postgres@localhost", TlsMode::None).unwrap();
        let trans = conn.transaction().unwrap();
        match trans.open_large_object(0, Mode::Read) {
            Ok(_) => panic!("unexpected success"),
            Err(ref e) if e.code() == Some(&UNDEFINED_OBJECT) => {}
            Err(e) => panic!("unexpected error: {:?}", e),
        };
    }

    #[test]
    fn test_open_finish() {
        let conn = Connection::connect("postgres://postgres@localhost", TlsMode::None).unwrap();
        let trans = conn.transaction().unwrap();
        let oid = trans.create_large_object().unwrap();
        let lo = trans.open_large_object(oid, Mode::Read).unwrap();
        lo.finish().unwrap();
    }

    #[test]
    fn test_write_read() {
        use std::io::{Read, Write};

        let conn = Connection::connect("postgres://postgres@localhost", TlsMode::None).unwrap();
        let trans = conn.transaction().unwrap();
        let oid = trans.create_large_object().unwrap();
        let mut lo = trans.open_large_object(oid, Mode::Write).unwrap();
        lo.write_all(b"hello world!!!").unwrap();
        let mut lo = trans.open_large_object(oid, Mode::Read).unwrap();
        let mut out = vec![];
        lo.read_to_end(&mut out).unwrap();
        assert_eq!(out, b"hello world!!!");
    }

    #[test]
    fn test_seek_tell() {
        use std::io::{Read, Seek, SeekFrom, Write};

        let conn = Connection::connect("postgres://postgres@localhost", TlsMode::None).unwrap();
        let trans = conn.transaction().unwrap();
        let oid = trans.create_large_object().unwrap();
        let mut lo = trans.open_large_object(oid, Mode::Write).unwrap();
        lo.write_all(b"hello world!!!").unwrap();

        assert_eq!(14, lo.seek(SeekFrom::Current(0)).unwrap());
        assert_eq!(1, lo.seek(SeekFrom::Start(1)).unwrap());
        let mut buf = [0];
        assert_eq!(1, lo.read(&mut buf).unwrap());
        assert_eq!(b'e', buf[0]);
        assert_eq!(2, lo.seek(SeekFrom::Current(0)).unwrap());
        assert_eq!(10, lo.seek(SeekFrom::End(-4)).unwrap());
        assert_eq!(1, lo.read(&mut buf).unwrap());
        assert_eq!(b'd', buf[0]);
        assert_eq!(8, lo.seek(SeekFrom::Current(-3)).unwrap());
        assert_eq!(1, lo.read(&mut buf).unwrap());
        assert_eq!(b'r', buf[0]);
    }

    #[test]
    fn test_write_with_read_fd() {
        use std::io::Write;

        let conn = Connection::connect("postgres://postgres@localhost", TlsMode::None).unwrap();
        let trans = conn.transaction().unwrap();
        let oid = trans.create_large_object().unwrap();
        let mut lo = trans.open_large_object(oid, Mode::Read).unwrap();
        assert!(lo.write_all(b"hello world!!!").is_err());
    }

    #[test]
    fn test_truncate() {
        use std::io::{Read, Seek, SeekFrom, Write};

        let conn = Connection::connect("postgres://postgres@localhost", TlsMode::None).unwrap();
        let trans = conn.transaction().unwrap();
        let oid = trans.create_large_object().unwrap();
        let mut lo = trans.open_large_object(oid, Mode::Write).unwrap();
        lo.write_all(b"hello world!!!").unwrap();

        lo.truncate(5).unwrap();
        lo.seek(SeekFrom::Start(0)).unwrap();
        let mut buf = vec![];
        lo.read_to_end(&mut buf).unwrap();
        assert_eq!(buf, b"hello");
        lo.truncate(10).unwrap();
        lo.seek(SeekFrom::Start(0)).unwrap();
        buf.clear();
        lo.read_to_end(&mut buf).unwrap();
        assert_eq!(buf, b"hello\0\0\0\0\0");
    }

    #[test]
    fn test_parse_version() {
        let version = parse_version("10.3 (Debian 10.3-1.pgdg90+1)");
        assert_eq!(version, (10, 3));

        let version = parse_version("9.5");
        assert_eq!(version, (9, 5));
    }
}