4 use parent qw(Rose::Object);
10 use SL::Webdav::Object;
11 use SL::Webdav::VersionScheme::Serial;
12 use SL::Webdav::VersionScheme::Timestamp;
14 use Rose::Object::MakeMethods::Generic (
15 scalar => [ qw(type number) ],
16 'scalar --get_set_init' => [ qw(version_scheme) ],
20 sales_quotation => 'angebote',
21 sales_order => 'bestellungen',
22 request_quotation => 'anfragen',
23 purchase_order => 'lieferantenbestellungen',
24 sales_delivery_order => 'verkaufslieferscheine',
25 purchase_delivery_order => 'einkaufslieferscheine',
26 credit_note => 'gutschriften',
27 invoice => 'rechnungen',
28 purchase_invoice => 'einkaufsrechnungen',
30 service => 'dienstleistungen',
31 assembly => 'erzeugnisse',
33 general_ledger => 'dialogbuchungen',
39 my @objects = $self->get_all_objects;
42 for my $obj (@objects) {
43 my $filename = join '.', grep $_, $obj->basename, $obj->extension;
45 my $file = $files_by_name{$filename} ||= SL::Webdav::File->new(filename => $filename, webdav => $self, loaded => 1);
46 $file->add_objects($obj);
49 return values %files_by_name;
55 my $path = $self->webdav_path;
58 my $base_path = $ENV{'SCRIPT_NAME'};
59 $base_path =~ s|[^/]+$||;
60 if (opendir my $dir, $path) {
61 foreach my $file (sort { lc $a cmp lc $b } map { decode("UTF-8", $_) } readdir $dir) {
62 next if (($file eq '.') || ($file eq '..'));
67 push @objects, SL::Webdav::Object->new(filename => $fname, webdav => $self);
79 my @files = $self->get_all_files;
80 map { ($_->versions)[-1] } @files;
83 sub _sanitized_number {
84 my $number = $_[0]->number;
85 $number =~ s|[/\\]|_|g;
92 die "No client set in \$::auth" unless $::auth->client;
93 die "Need number" unless $self->number;
95 my $type = $type_to_path{$self->type};
97 die "Unknown type" unless $type;
99 my $path = File::Spec->catdir("webdav", $::auth->client->{id}, $type, $self->_sanitized_number);
102 Common::mkdir_with_parents($path);
108 sub init_version_scheme {
109 SL::Webdav::VersionScheme::Timestamp->new;
120 SL::Webdav - Webdav manipulation
124 # get list of all documents for this record
127 my $webdav = SL::Webdav->new(
132 # gives you SL::Webdav::File instances
133 my $webdav_files = $webdav->get_all_files;
135 # gives you the objects instead
136 my $webdav_objects = $webdav->get_all_objects;
138 # gives you only the latest objects
139 my $webdav_objects = $webdav->get_all_latest;
141 # physical path to this dir
142 my $path = $webdav->webdav_path;
146 This module is a wrapper around the webdav storage mechanism with some simple
147 document management functionality.
149 This is not a replacement for real document management, mostly because the
150 underlying webdav storage is not fully under our control. It's common practice
151 to allow people direct samba access to the webdav, so all versioning
152 information needs to be encoded into the filename of a file, and nonsensical
153 filenames must not break assumptions.
155 This module is intended to be used if you need to scan the folder for
156 previously saved files and need to build a list in order to display it.
158 If you need to manipulate the versions of a file, see L<SL::Webdav::File>
160 If you need to access a file directly for download or metadata, see L<SL::Webdav::Object>
166 =item C<get_all_objects>
168 Returns all L<SL::Webdav::Objects> found.
170 =item C<get_all_files>
172 Returns all objects sorted into L<SL::Webdav::File>s.
174 =item C<get_all_latest>
176 Returns only the latest object of each L<SL::Webdav::File> found.
180 Returns the physical path to this webdav object.
184 =head1 VERSIONING SCHEME
186 You may register a versioning scheme object to handle versioning. It is
187 expected to implement the following methods:
193 Must return a string that will be used to separate the basename and version part of
194 filenames when generating and parsing.
196 =item C<extract_regexp>
198 Must return a regexp that will match a versioning string at the end of a
199 filename after the extension has been stripped off. It will be surrounded by
204 Must return a comparison function that will be invoked with two
205 L<SL::Webdav::Object> instances.
207 =item C<first_version>
209 Must return a string representing the version of the first of a series of objects.
213 =item C<next_version>
215 Will be called with the latest L<SL::Webdav::Object> and must return a new version string.
217 =item C<keep_last_version>
219 Will be called with the latest L<SL::Webdav::Object>. Truish return value will
220 cause the latest object to be overwritten instead of creating a new version.
224 =head1 BUGS AND CAVEATS
230 File operations are inconsistently L<File::Spec>ed.
236 L<SL::Webdav::File>, L<SL::Webdav::Object>
240 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>