From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

MMCLERIC / Ubic-1.47 / lib / Ubic / AtomicFile.pm 

            

              
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

              
package Ubic::AtomicFile;
{
  $Ubic::AtomicFile::VERSION = '1.47';
}
use strict;
use warnings;
# ABSTRACT: atomic file operations
use IO::Handle;
use Params::Validate qw(:all);
sub store($$;$) {
    my ($data, $file, @options) = @_;
    my $options = validate(@options, {
        sync => { default => 1 },
    });
    my $new_file = "$file.new";
    open my $fh, '>', $new_file or die "Can't open '$new_file' for writing: $!";
    print {$fh} $data or die "Can't print to '$new_file': $!";
    $fh->flush or die "Can't flush '$new_file': $!";
    if ($options->{sync}) {
        # Here is a link which says why we should do sync too if we don't want to lose data:
        # https://bugs.launchpad.net/ubuntu/+source/linux/+bug/317781/comments/54
        #
        # For some types of atomic files this is important, for others (pidfiles, temp files) it can be too big performance hit.
        # Every part of ubic code decides for itself.
        $fh->sync or die "Can't sync '$new_file': $!";
    }
    close $fh or die "Can't close '$new_file': $!";
    rename $new_file => $file or die "Can't rename '$new_file' to '$file': $!";
}
1;
__END__
=pod
=head1 NAME
Ubic::AtomicFile - atomic file operations
=head1 VERSION
version 1.47
=head1 SYNOPSIS
    use Ubic::AtomicFile;
    Ubic::AtomicFile::store("blah\n" => "/var/lib/blah");
    # store but don't sync content to disk
    Ubic::AtomicFile::store("blah\n" => "/var/lib/blah", { sync => 0 });
=head1 FUNCTIONS
=over
=item B<store($data, $file)>
=item B<store($data, $file, $options)>
Store C<$data> into C<$file> atomically. Temporary C<$file.new> will be created and then renamed to C<$file>.
If I<sync> flag is set and false in C<$options> hash then data will not be synced on disk before file is renamed (should be faster, but you can lose your data - see comments in code).
=back
=head1 AUTHOR
Vyacheslav Matyukhin <mmcleric@yandex-team.ru>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2012 by Yandex LLC.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut