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',
38 my @objects = $self->get_all_objects;
41 for my $obj (@objects) {
42 my $filename = join '.', grep $_, $obj->basename, $obj->extension;
44 my $file = $files_by_name{$filename} ||= SL::Webdav::File->new(filename => $filename, webdav => $self, loaded => 1);
45 $file->add_objects($obj);
48 return values %files_by_name;
54 my $path = $self->webdav_path;
57 my $base_path = $ENV{'SCRIPT_NAME'};
58 $base_path =~ s|[^/]+$||;
59 if (opendir my $dir, $path) {
60 foreach my $file (sort { lc $a cmp lc $b } map { decode("UTF-8", $_) } readdir $dir) {
61 next if (($file eq '.') || ($file eq '..'));
66 push @objects, SL::Webdav::Object->new(filename => $fname, webdav => $self);
78 my @files = $self->get_all_files;
79 map { ($_->versions)[-1] } @files;
82 sub _sanitized_number {
83 my $number = $_[0]->number;
84 $number =~ s|[/\\]|_|g;
91 die "No client set in \$::auth" unless $::auth->client;
92 die "Need number" unless $self->number;
94 my $type = $type_to_path{$self->type};
96 die "Unknown type" unless $type;
98 my $path = File::Spec->catdir("webdav", $::auth->client->{id}, $type, $self->_sanitized_number);
101 Common::mkdir_with_parents($path);
107 sub init_version_scheme {
108 SL::Webdav::VersionScheme::Timestamp->new;
119 SL::Webdav - Webdav manipulation
123 # get list of all documents for this record
126 my $webdav = SL::Webdav->new(
131 # gives you SL::Webdav::File instances
132 my $webdav_files = $webdav->get_all_files;
134 # gives you the objects instead
135 my $webdav_objects = $webdav->get_all_objects;
137 # gives you only the latest objects
138 my $webdav_objects = $webdav->get_all_latest;
140 # physical path to this dir
141 my $path = $webdav->webdav_path;
145 This module is a wrapper around the webdav storage mechanism with some simple
146 document management functionality.
148 This is not a replacement for real document management, mostly because the
149 underlying webdav storage is not fully under our control. It's common practice
150 to allow people direct samba access to the webdav, so all versioning
151 information needs to be encoded into the filename of a file, and nonsensical
152 filenames must not break assumptions.
154 This module is intended to be used if you need to scan the folder for
155 previously saved files and need to build a list in order to display it.
157 If you need to manipulate the versions of a file, see L<SL::Webdav::File>
159 If you need to access a file directly for download or metadata, see L<SL::Webdav::Object>
165 =item C<get_all_objects>
167 Returns all L<SL::Webdav::Objects> found.
169 =item C<get_all_files>
171 Returns all objects sorted into L<SL::Webdav::File>s.
173 =item C<get_all_latest>
175 Returns only the latest object of each L<SL::Webdav::File> found.
179 Returns the physical path to this webdav object.
183 =head1 VERSIONING SCHEME
185 You may register a versioning scheme object to handle versioning. It is
186 expected to implement the following methods:
192 Must return a string that will be used to separate the basename and version part of
193 filenames when generating and parsing.
195 =item C<extract_regexp>
197 Must return a regexp that will match a versioning string at the end of a
198 filename after the extension has been stripped off. It will be surrounded by
203 Must return a comparison function that will be invoked with two
204 L<SL::Webdav::Object> instances.
206 =item C<first_version>
208 Must return a string representing the version of the first of a series of objects.
212 =item C<next_version>
214 Will be called with the latest L<SL::Webdav::Object> and must return a new version string.
216 =item C<keep_last_version>
218 Will be called with the latest L<SL::Webdav::Object>. Truish return value will
219 cause the latest object to be overwritten instead of creating a new version.
223 =head1 BUGS AND CAVEATS
229 File operations are inconsistently L<File::Spec>ed.
235 L<SL::Webdav::File>, L<SL::Webdav::Object>
239 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>