diff options
Diffstat (limited to 'perl5/File/XDG.pm')
| -rw-r--r-- | perl5/File/XDG.pm | 237 |
1 files changed, 0 insertions, 237 deletions
diff --git a/perl5/File/XDG.pm b/perl5/File/XDG.pm deleted file mode 100644 index 30dc672e..00000000 --- a/perl5/File/XDG.pm +++ /dev/null @@ -1,237 +0,0 @@ -package File::XDG; - -use strict; -use warnings; -use feature qw(:5.10); - -our $VERSION = 0.04; - -use Carp qw(croak); - -use Path::Class qw(dir file); -use File::HomeDir; - -=head1 NAME - -C<File::XDG> - Basic implementation of the XDG base directory specification - -=head1 SYNOPSIS - - use File::XDG; - - my $xdg = File::XDG->new(name => 'foo'); - - # user config - $xdg->config_home - - # user data - $xdg->data_home - - # user cache - $xdg->cache_home - - # system config - $xdg->config_dirs - - # system data - $xdg->data_dirs - -=head1 DESCRIPTION - -This module provides a basic implementation of the XDG base directory -specification as exists by the Free Desktop Organization (FDO). It supports -all XDG directories except for the runtime directories, which require session -management support in order to function. - -=cut - -=head1 CONSTRUCTOR - -=cut - -=head2 $xdg = File::XDG->new( %args ) - -Returns a new instance of a C<File::XDG> object. This must be called with an -application name as the C<name> argument. - -Takes the following named arguments: - -=over 8 - -=item name => STRING - -Name of the application for which File::XDG is being used. - -=back - -=cut - -sub new { - my $class = shift; - my %args = (@_); - - my $self = { - name => delete $args{name} // croak('application name required'), - }; - - return bless $self, $class || ref $class; -} - -sub _win { - my ($type) = @_; - - return File::HomeDir->my_data; -} - -sub _home { - my ($type) = @_; - my $home = $ENV{HOME}; - - return _win($type) if ($^O eq 'MSWin32'); - - given ($type) { - when ('data') { - return ($ENV{XDG_DATA_HOME} || "$home/.local/share/") - } when ('config') { - return ($ENV{XDG_CONFIG_HOME} || "$home/.config/") - } when ('cache') { - return ($ENV{XDG_CACHE_HOME} || "$home/.cache/") - } default { - croak 'invalid _home requested' - } - } -} - -sub _dirs { - my $type = shift; - - given ($type) { - when ('data') { - return ($ENV{XDG_DATA_DIRS} || '/usr/local/share:/usr/share') - } when ('config') { - return ($ENV{XDG_CONFIG_DIRS} || '/etc/xdg') - } default { - croak 'invalid _dirs requested' - } - } -} - -sub _lookup_file { - my ($self, $type, @subpath) = @_; - - unless (@subpath) { - croak 'subpath not specified'; - } - - my @dirs = (_home($type), split(':', _dirs($type))); - my @paths = map { file($_, @subpath) } @dirs; - my ($match) = grep { -f $_ } @paths; - - return $match; -} - -=head1 METHODS - -=cut - -=head2 $xdg->data_home() - -Returns the user-specific data directory for the application as a C<Path::Class> object. - -=cut - -sub data_home { - my $self = shift; - my $xdg = _home('data'); - return dir($xdg, $self->{name}); -} - -=head2 $xdg->config_home() - -Returns the user-specific configuration directory for the application as a C<Path::Class> object. - -=cut - -sub config_home { - my $self = shift; - my $xdg = _home('config'); - return dir($xdg, $self->{name}); -} - -=head2 $xdg->cache_home() - -Returns the user-specific cache directory for the application as a C<Path::Class> object. - -=cut - -sub cache_home { - my $self = shift; - my $xdg = _home('cache'); - return dir($xdg, $self->{name}); -} - -=head2 $xdg->data_dirs() - -Returns the system data directories, not modified for the application. Per the -specification, the returned string is :-delimited. - -=cut - -sub data_dirs { - return _dirs('data'); -} - -=head2 $xdg->config_dirs() - -Returns the system config directories, not modified for the application. Per -the specification, the returned string is :-delimited. - -=cut - -sub config_dirs { - return _dirs('config'); -} - -=head2 $xdg->lookup_data_file('subdir', 'filename'); - -Looks up the data file by searching for ./subdir/filename relative to all base -directories indicated by $XDG_DATA_HOME and $XDG_DATA_DIRS. If an environment -variable is either not set or empty, its default value as defined by the -specification is used instead. Returns a C<Path::Class> object. - -=cut - -sub lookup_data_file { - my ($self, @subpath) = @_; - return $self->_lookup_file('data', @subpath); -} - -=head2 $xdg->lookup_config_file('subdir', 'filename'); - -Looks up the configuration file by searching for ./subdir/filename relative to -all base directories indicated by $XDG_CONFIG_HOME and $XDG_CONFIG_DIRS. If an -environment variable is either not set or empty, its default value as defined -by the specification is used instead. Returns a C<Path::Class> object. - -=cut - -sub lookup_config_file { - my ($self, @subpath) = @_; - return $self->_lookup_file('config', @subpath); -} - -=head1 SEE ALSO - -L<XDG Base Directory specification, version 0.7|http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html> - -=head1 ACKNOWLEDGEMENTS - -This module's Windows support is made possible by C<File::HomeDir>. I would also like to thank C<Path::Class> and C<File::Spec>. - -=head1 AUTHOR - -Kiyoshi Aman <kiyoshi.aman@gmail.com> - -=cut - -1; |