.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Padre::Autosave 3pm"
.TH Padre::Autosave 3pm "2012-06-27" "perl v5.14.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Padre::Autosave \- auto\-save and recovery mechanism for Padre
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  my $autosave = Padre:Autosave\->new( db => \*(Aqpath/to/database\*(Aq );
\&  $autosave\->save_file( $path, $type, $data, $timestamp ) = @_;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SH "The longer auto-save plan"
.IX Header "The longer auto-save plan"
The following is just a plan that is currently shelved as some people
on the Padre development list think this is not necessary and one
should use a real version control for this anyway.
.PP
So I leave it here for now, for future exploration.
.PP
I'd like to provide auto-save with some history and recovery service.
.PP
While I am writing this for Padre I'll make the code separate
so others can use it.
.PP
An SQLite database will be used for this but theoretically
any database could be used. Event plain file system.
.PP
Basically this will provide a versioned file system with
metadata and automatic cleanup.
.PP
Besides the content of the file we need to save some meta data:
.IP "path to the file will be the unique identifier" 4
.IX Item "path to the file will be the unique identifier"
.PD 0
.IP "timestamp" 4
.IX Item "timestamp"
.IP "type of save (initial, auto-save, user initiated save, external)" 4
.IX Item "type of save (initial, auto-save, user initiated save, external)"
.PD
.PP
When opening a file for the first time it is saved in the database.(initial)
.PP
Every N seconds files that are not currently in \*(L"saved\*(R" situation
are auto-saved in the database making sure that they are only saved
if they differ from the previous state. (auto-save)
.PP
Evey time a file is saved it is also saved to the database. (user initiated save)
Before reloading a file we auto-save it. (auto-save)
.PP
Every time we notice that a file was changed on the disk if the user decides
to overwrite it we also save the (external) changed file.
.PP
Before auto-saving a file we make sure it has not changed since the
last auto-save.
.PP
In order to make sure the database does not get too big we setup
a cleaning mechanism that is executed once in a while.
There might be several options but for now:
1) Every entry older than N days will be deleted.
.PP
Based on the database we'll be able to provide the user recovery in
case of crash or accidental overwrite.
.PP
When opening padre we should check if there are files in the database
that the last save was \fBnot\fR a user initiated save and offer recovery.
.PP
When opening a file we should also check how is it related
to the last save in the database.
.PP
For buffers that were never saved and so have no file names
we should have some internal identifier in Padre and use that
for the auto-save till the first user initiated save.
.PP
The same mechanism will be really useful when we start
providing remote editing. Then a file is identified by
its \s-1URI\s0 ( ftp://machine/path/to/file or scp://machine/path/to/file )
.PP
.Vb 1
\&  my @types = qw(initial, autosave, usersave, external);
\&
\&  sub save_data {
\&      my ($path, $timestamp, $type, $data) = @_;
\&  }
.Ve