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
|
package Demeter::Project;
=for Copyright
.
Copyright (c) 2006-2019 Bruce Ravel (http://bruceravel.github.io/home).
All rights reserved.
.
This file is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See The Perl
Artistic License.
.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
=cut
use autodie qw(open close);
use Moose::Role;
use Archive::Zip qw( :ERROR_CODES :CONSTANTS );;
local $Archive::Zip::UNICODE = 1;
use Carp;
use File::Path;
use File::Spec;
sub identify_self {
#my ($class);
my @caller = caller;
use File::Basename qw(dirname);
return dirname($caller[1]);
};
requires 'is_windows';
sub dot_folder {
my ($self) = @_;
return q{} if (defined($ENV{DEMETER_MODE}) and ($ENV{DEMETER_MODE} eq 'web'));
my $folder = ($self->is_windows)
? File::Spec->catfile($ENV{APPDATA}, "demeter")
: File::Spec->catfile($ENV{HOME}, ".horae");
my $err = [];
mkpath($folder, {error => \$err}) if (not -d $folder);
return $folder if (@$err);
my $mrufile = File::Spec->catfile($folder, "demeter.mru");
if (not -e $mrufile) {
open(my $MRU, ">".$mrufile);
print $MRU "## Recently used files: " . $self->identify . $/ x 3;
print $MRU "[__dummy__]\n";
print $MRU "x=y\n";
close $MRU;
};
return $folder;
};
sub stash_folder {
my ($self) = @_;
my $err = [];
my $folder = ($self->is_windows)
? File::Spec->catfile($ENV{APPDATA}, "demeter", "stash")
: File::Spec->catfile($ENV{HOME}, ".horae", "stash");
mkpath($folder, {error => \$err}) if (not -d $folder);
return $folder;
};
sub project_folder {
my ($self, $proj) = @_;
return -1 if (not $proj);
my $err = [];
my $folder = ($self->is_windows)
? File::Spec->catfile($ENV{APPDATA}, "demeter", "stash", $proj)
: File::Spec->catfile($ENV{HOME}, ".horae", "stash", $proj);
mkpath($folder, {error => \$err}) if (not -d $folder);
return $folder;
};
sub zip_project {
my ($self, $folder, $fname) = @_;
my $zip = Archive::Zip->new();
my $dir_member = $zip->addTree( $folder );
unless ( $zip->writeToFileNamed($fname) == AZ_OK ) {
die "error writing zip file $fname";
};
};
sub share_folder {
my ($self) = @_;
my $folder = File::Spec->catfile(identify_self(), "share");
return $folder;
};
1;
=head1 NAME
Demeter::Project - Project file management
=head1 VERSION
This documentation refers to Demeter version 0.9.26.
=head1 DESCRIPTION
This module contains various utilities involved in project file
management for the demeter system. It provides tools for finding and
making the various temporary directories Demeter uses as workspace and
a method for packaging a workspace up into a zip file.
=head1 METHODS
There are no user methods. This module contains tools used by other
modules.
=head1 DIAGNOSTICS
None.
=head1 CONFIGURATION AND ENVIRONMENT
See L<Demeter::Config> for a description of the configuration system.
=head1 DEPENDENCIES
Demeter's dependencies are in the F<Build.PL> file.
=head1 BUGS AND LIMITATIONS
Please report problems to the Ifeffit Mailing List
(L<http://cars9.uchicago.edu/mailman/listinfo/ifeffit/>)
Patches are welcome.
=head1 AUTHOR
Bruce Ravel, L<http://bruceravel.github.io/home>
L<http://bruceravel.github.io/demeter/>
=head1 LICENCE AND COPYRIGHT
Copyright (c) 2006-2019 Bruce Ravel (L<http://bruceravel.github.io/home>). All rights reserved.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlgpl>.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
=cut
|